Package gda.device.detector.hardwaretriggerable

Class DummyHardwareTriggerableSimpleDetector

java.lang.Object

gda.factory.ConfigurableBase

gda.factory.FindableConfigurableBase

gda.device.DeviceBase

gda.device.scannable.ScannableBase

gda.device.detector.DetectorBase

gda.device.detector.hardwaretriggerable.HardwareTriggerableDetectorBase

gda.device.detector.hardwaretriggerable.DummyHardwareTriggerableDetectorBase

gda.device.detector.hardwaretriggerable.DummyHardwareTriggerableSimpleDetector

All Implemented Interfaces:

SimulatedTriggerObserver, Detector, HardwareTriggerableDetector, HardwareTriggeredDetector, Device, Scannable, PositionCallableProvider<Double>, PositionInputStream<Double>, Configurable, Findable, gda.observable.IObservable, gda.observable.IObserver, Serializable

public class DummyHardwareTriggerableSimpleDetector
extends DummyHardwareTriggerableDetectorBase
implements PositionCallableProvider<Double>, PositionInputStream<Double>

See Also:

• Serialized Form

Field Summary

Fields inherited from class gda.device.detector.hardwaretriggerable.DummyHardwareTriggerableDetectorBase

simulate, simulatedCollectionComplete

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
DummyHardwareTriggerableSimpleDetector(String name)

Method Summary

Modifier and Type	Method	Description
void	atScanLineStart()	Called for every Scannable at the start of every scan
void	collectData()	Tells the detector to begin to collect a set of data, then returns immediately.
boolean	createsOwnFiles()	Returns a value which indicates whether the detector creates its own files.
int[]	getDataDimensions()	Default which should be overridden by subclasses.
String	getDescription()
String	getDetectorID()
String	getDetectorType()
Callable<Double>	getPositionCallable()
List<Double>	read(int maxToRead)	Return at least one element, but no more than maxToRead, waiting until able to do so.
Object	readout()	Returns the latest data collected.
void	waitWhileBusy()	Returns when operation carried out by moveTo has completed

Methods inherited from class gda.device.detector.hardwaretriggerable.DummyHardwareTriggerableDetectorBase

getStatus, getTerminal, integratesBetweenPoints, setIntegrating, update

Methods inherited from class gda.device.detector.hardwaretriggerable.HardwareTriggerableDetectorBase

getHardwareTriggerProvider, getNumberImagesToCollect, isHardwareTriggering, setHardwareTriggering, setHardwareTriggerProvider, setNumberImagesToCollect

Methods inherited from class gda.device.detector.DetectorBase

asynchronousMoveTo, checkPositionValid, endCollection, getCollectionTime, getPosition, isBusy, 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, 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

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, getFileStructure, prepareForCollection, setCollectionTime

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, atScanStart, checkPositionValid, getExtraNames, getInputNames, getLevel, getOutputFormat, getPosition, getScanMetadataAttribute, getScanMetadataAttributeNames, getScanMetadataAttributes, isAt, isBusy, moveTo, setExtraNames, setInputNames, setLevel, setOutputFormat, setScanMetadataAttribute, setScanMetadataAttributes, stop, toFormattedString

Constructor Details

DummyHardwareTriggerableSimpleDetector

public DummyHardwareTriggerableSimpleDetector(String name)

Method Details

getDataDimensions

public int[] getDataDimensions()
                        throws DeviceException

Description copied from class: DetectorBase

Default which should be overridden by subclasses.

Specified by:

getDataDimensions in interface Detector

Overrides:

getDataDimensions in class DetectorBase

Returns:

the dimensions of the data object returned by the Detector.readout() method

Throws:

DeviceException

See Also:

• Detector.getDataDimensions()

collectData

public void collectData()
                 throws DeviceException

Description copied from interface: Detector

Tells the detector to begin to collect a set of data, then returns immediately. Should cause the hardware to start collecting immediately: if there is any delay then detectors used in the same scan would collect over different times when beam conditions may differ.

Specified by:

collectData in interface Detector

Overrides:

collectData in class DummyHardwareTriggerableDetectorBase

Throws:

DeviceException

readout

public Object readout()
               throws DeviceException

Description copied from interface: Detector

Returns the latest data collected. The size of the Object returned must be consistent with the values returned by getDataDimensions and getExtraNames.

If LocalProperties.GDA_SCAN_CONCURRENTSCAN_READOUT_CONCURRENTLY is true then motors may be moved while the detector readouts. The value returned must not be effected by any concurrent motor or shutter movements. See Detector.waitWhileBusy() and ConcurrentScan. Readout must block until the detector is ready to respond quickly to Detector.collectData() again.

Specified by:

readout in interface Detector

Returns:

the data collected

Throws:

DeviceException

getPositionCallable

public Callable<Double> getPositionCallable()
                                     throws DeviceException

Specified by:

getPositionCallable in interface PositionCallableProvider<Double>

Throws:

DeviceException

atScanLineStart

public void atScanLineStart()
                     throws DeviceException

Description copied from class: ScannableBase

Called for every Scannable at the start of every scan Default behaviour is to do nothing. Inheriting classes have the option to implement this if their specific behaviour requires it.

Specified by:

atScanLineStart in interface Scannable

Overrides:

atScanLineStart in class ScannableBase

Throws:

DeviceException

See Also:

• Scannable.atScanLineStart()

createsOwnFiles

public boolean createsOwnFiles()
                        throws DeviceException

Description copied from interface: Detector

Returns a value which indicates whether the detector creates its own files. If it does (return true) the readout() method returns the name of the latest file created as a string. If it does not (return false) the readout() method will return the data directly.

Specified by:

createsOwnFiles in interface Detector

Returns:

true if readout() returns filenames

Throws:

DeviceException

getDescription

public String getDescription()
                      throws DeviceException

Specified by:

getDescription in interface Detector

Overrides:

getDescription in class DetectorBase

Returns:

A description of the detector.

Throws:

DeviceException

getDetectorID

public String getDetectorID()
                     throws DeviceException

Specified by:

getDetectorID in interface Detector

Overrides:

getDetectorID in class DetectorBase

Returns:

A identifier for this detector.

Throws:

DeviceException

getDetectorType

public String getDetectorType()
                       throws DeviceException

Specified by:

getDetectorType in interface Detector

Overrides:

getDetectorType in class DetectorBase

Returns:

The type of detector.

Throws:

DeviceException

waitWhileBusy

public void waitWhileBusy()
                   throws DeviceException,
InterruptedException

Description copied from class: ScannableBase

Returns when operation carried out by moveTo has completed If this is to be overriden, isBusy must also be valid. Although the pos and scan command currently use this method to determine if the Scannable is busy, this must not be relied upon.

Specified by:

waitWhileBusy in interface Detector

Specified by:

waitWhileBusy in interface Scannable

Overrides:

waitWhileBusy in class ScannableBase

Throws:

DeviceException

InterruptedException

read

public List<Double> read(int maxToRead)
                  throws NoSuchElementException,
InterruptedException

Description copied from interface: PositionInputStream

Return at least one element, but no more than maxToRead, waiting until able to do so. The parameter maxToRead is there to protect the caller from potentially receiving too much data in call, not to meet the needs of the detector.

Specified by:

read in interface PositionInputStream<Double>

Parameters:

maxToRead - the maximum number of elements to read. Must be one or more.

Returns:

at least one element from the head of the stream, oldest on the left

Throws:

NoSuchElementException - if the stream will have nothing to return

InterruptedException