Package gda.device.detector

Class ReadbackDemandDifference

java.lang.Object

gda.factory.ConfigurableBase

gda.factory.FindableConfigurableBase

gda.device.DeviceBase

gda.device.scannable.ScannableBase

gda.device.detector.DetectorBase

gda.device.detector.DatasetNexusDetector

gda.device.detector.ReadbackDemandDifference

All Implemented Interfaces:

Detector, NexusDetector, Device, Scannable, Configurable, Findable, gda.observable.IObservable, Serializable

public class ReadbackDemandDifference
extends DatasetNexusDetector

NexusDetector that records the demand, readback and demand-readback values for a single scannable/group of scannables. This works for ScannableMotor objects that use EpicsMotor as the underlying motor object. All other scannables will record only current readback position (using Scannable.getPosition()).

See Also:

• Serialized Form

Field Summary

Fields inherited from class gda.device.detector.DetectorBase

collectionTime

Fields inherited from class gda.device.scannable.ScannableBase

__doc__, DEFAULT_INPUT_NAME, DEFAULT_OUTPUT_FORMAT, extraNames, inputNames, level, outputFormat

Fields inherited from class gda.device.DeviceBase

DEFAULT_PROTECTION_LEVEL_PROPERTY

Fields inherited from interface gda.device.Detector

BUSY, FAULT, IDLE, MONITORING, PAUSED, STANDBY

Fields inherited from interface gda.device.Scannable

ATTR_NEXUS_CATEGORY, ATTR_NX_CLASS, DEFAULT_INPUT_NAME, VALUE_UNAVAILABLE

Constructor Summary

Constructors

Constructor	Description
ReadbackDemandDifference()

Method Summary

Modifier and Type	Method	Description
protected NXDetectorData	createNexusData(org.eclipse.january.dataset.IDataset dataset)	Create a Nexus tree containing a dataset
org.eclipse.january.dataset.IDataset	getDataset()	The DatasetNexusDetector.readout() function calls this method
Scannable	getScannable()
boolean	isBusy()	Check if the Scannable is moving/operating.
void	setScannable(Scannable scannable)

Methods inherited from class gda.device.detector.DatasetNexusDetector

collectData, createsOwnFiles, getDataGroupName, getPosition, getStatus, readout, setDataGroupName

Methods inherited from class gda.device.detector.DetectorBase

asynchronousMoveTo, checkPositionValid, endCollection, getCollectionTime, getDataDimensions, getDescription, getDetectorID, getDetectorType, prepareForCollection, setCollectionTime, toFormattedString

Methods inherited from class gda.device.scannable.ScannableBase

__call__, __call__, __doc__, __getitem__, __len__, __repr__, __str__, atCommandFailure, atLevelEnd, atLevelMoveStart, atLevelStart, atPointEnd, atPointStart, atScanEnd, atScanLineEnd, atScanLineStart, atScanStart, externalToInternal, getExtraNames, getInputNames, getLevel, getOutputFormat, getScanMetadataAttribute, getScanMetadataAttributeNames, getScanMetadataAttributes, internalToExternal, isAt, moveTo, rawAsynchronousMoveTo, rawGetPosition, setExtraNames, setInputNames, setLevel, setOutputFormat, setScanMetadataAttribute, setScanMetadataAttributes, stop, throwExceptionIfInvalidTarget, toString, validateScannable, valueUnavailableString, waitWhileBusy, waitWhileBusy

Methods inherited from class gda.device.DeviceBase

addIObserver, close, deleteIObserver, deleteIObservers, getAttribute, getName, getProtectionLevel, isBeingObserved, isConfigureAtStartup, notifyIObservers, setAttribute, setConfigureAtStartup, setName, setProtectionLevel

Methods inherited from class gda.factory.ConfigurableBase

configure, isConfigured, reconfigure, setConfigured

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface gda.factory.Configurable

configure, isConfigureAtStartup, isConfigured, reconfigure

Methods inherited from interface gda.device.Detector

endCollection, getCollectionTime, getDataDimensions, getDescription, getDetectorID, getDetectorType, getFileStructure, prepareForCollection, setCollectionTime, waitWhileBusy

Methods inherited from interface gda.device.Device

close, getAttribute, getProtectionLevel, setAttribute, setProtectionLevel

Methods inherited from interface gda.factory.Findable

getName, setName

Methods inherited from interface gda.observable.IObservable

addIObserver, deleteIObserver, deleteIObservers

Methods inherited from interface gda.device.Scannable

asynchronousMoveTo, atCommandFailure, atLevelEnd, atLevelMoveStart, atLevelStart, atPointEnd, atPointStart, atScanEnd, atScanLineEnd, atScanLineStart, atScanStart, checkPositionValid, getExtraNames, getInputNames, getLevel, getOutputFormat, getScanMetadataAttribute, getScanMetadataAttributeNames, getScanMetadataAttributes, isAt, moveTo, setExtraNames, setInputNames, setLevel, setOutputFormat, setScanMetadataAttribute, setScanMetadataAttributes, stop, toFormattedString

Constructor Details

ReadbackDemandDifference

public ReadbackDemandDifference()

Method Details

getScannable

public Scannable getScannable()

setScannable

public void setScannable(Scannable scannable)

isBusy

public boolean isBusy()
               throws DeviceException

Description copied from class: DetectorBase

Check if the Scannable is moving/operating. default implementation is to call the getStatus method

Specified by:

isBusy in interface Scannable

Overrides:

isBusy in class DetectorBase

Returns:

true - if operation carried out by moveTo has not completed yet

Throws:

DeviceException

See Also:

• Scannable.isBusy()

getDataset

public org.eclipse.january.dataset.IDataset getDataset()
                                                throws DeviceException

Description copied from class: DatasetNexusDetector

The DatasetNexusDetector.readout() function calls this method

Specified by:

getDataset in class DatasetNexusDetector

Returns:

A dataset object. .

Throws:

DeviceException

createNexusData

protected NXDetectorData createNexusData(org.eclipse.january.dataset.IDataset dataset)

Description copied from class: DatasetNexusDetector

Create a Nexus tree containing a dataset

Overrides:

createNexusData in class DatasetNexusDetector

Parameters:

dataset -

Returns:

NexusTreeProvider object