Package gda.device.etl

Class DummyEtlDetector

java.lang.Object

gda.factory.ConfigurableBase

gda.factory.FindableConfigurableBase

gda.device.DeviceBase

gda.device.scannable.ScannableBase

gda.device.detector.DetectorBase

gda.device.etl.DummyEtlDetector

All Implemented Interfaces:

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

public class DummyEtlDetector
extends DetectorBase
implements EtlDetector

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
DummyEtlDetector()

Method Summary

Modifier and Type	Method	Description
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	getActualHV()	Gets the actual output high voltage at the detector.
int	getHV()	Gets the requested High Voltage from the detector register.
int	getLowerThreshold()	Gets window's lower threshold from the detector.
int	getStatus()	Returns the current collecting state of the device.
int	getUpperThreshold()	Gets the window's upper threshold from the detector.
Object	readout()	Returns the latest data collected.
void	setHV(int mv)	Sets the high voltage input in milli-volt for the detector.
void	setLowerThreshold(int llim)	Sets the window's lower threshold of the detector.
void	setUpperThreshold(int ulim)	Sets the window's upper threshold for the detector.

Methods inherited from class gda.device.detector.DetectorBase

asynchronousMoveTo, checkPositionValid, endCollection, getCollectionTime, getDataDimensions, getDescription, getDetectorID, getDetectorType, 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, 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, getPosition, getScanMetadataAttribute, getScanMetadataAttributeNames, getScanMetadataAttributes, isAt, isBusy, moveTo, setExtraNames, setInputNames, setLevel, setOutputFormat, setScanMetadataAttribute, setScanMetadataAttributes, stop, toFormattedString

Constructor Details

DummyEtlDetector

public DummyEtlDetector()

Method Details

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

Throws:

DeviceException

getStatus

public int getStatus()
              throws DeviceException

Description copied from interface: Detector

Returns the current collecting state of the device.

Specified by:

getStatus in interface Detector

Returns:

BUSY if the detector has not finished the requested operation(s), IDLE if in an completely idle state and STANDBY if temporarily suspended.

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

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

setHV

public void setHV(int mv)
           throws DeviceException

Description copied from interface: EtlDetector

Sets the high voltage input in milli-volt for the detector.

Specified by:

setHV in interface EtlDetector

Parameters:

mv -

Throws:

DeviceException

getActualHV

public int getActualHV()
                throws DeviceException

Description copied from interface: EtlDetector

Gets the actual output high voltage at the detector.

Specified by:

getActualHV in interface EtlDetector

Returns:

actual HV

Throws:

DeviceException

getHV

public int getHV()
          throws DeviceException

Description copied from interface: EtlDetector

Gets the requested High Voltage from the detector register.

Specified by:

getHV in interface EtlDetector

Returns:

HV

Throws:

DeviceException

setUpperThreshold

public void setUpperThreshold(int ulim)
                       throws DeviceException

Description copied from interface: EtlDetector

Sets the window's upper threshold for the detector.

Specified by:

setUpperThreshold in interface EtlDetector

Parameters:

ulim -

Throws:

DeviceException

getUpperThreshold

public int getUpperThreshold()
                      throws DeviceException

Description copied from interface: EtlDetector

Gets the window's upper threshold from the detector.

Specified by:

getUpperThreshold in interface EtlDetector

Returns:

Upper Threshold

Throws:

DeviceException

setLowerThreshold

public void setLowerThreshold(int llim)
                       throws DeviceException

Description copied from interface: EtlDetector

Sets the window's lower threshold of the detector.

Specified by:

setLowerThreshold in interface EtlDetector

Parameters:

llim -

Throws:

DeviceException

getLowerThreshold

public int getLowerThreshold()
                      throws DeviceException

Description copied from interface: EtlDetector

Gets window's lower threshold from the detector.

Specified by:

getLowerThreshold in interface EtlDetector

Returns:

Lower Threshold

Throws:

DeviceException