Package gda.device.detector

Class DetectorMonitorDataProvider

java.lang.Object

gda.factory.ConfigurableBase

gda.factory.FindableConfigurableBase

gda.device.DeviceBase

gda.device.scannable.ScannableBase

gda.device.detector.DetectorMonitorDataProvider

All Implemented Interfaces:

DetectorMonitorDataProviderInterface, Device, Scannable, Configurable, Findable, gda.observable.IObservable

@ServiceInterface(DetectorMonitorDataProviderInterface.class)
public class DetectorMonitorDataProvider
extends ScannableBase
implements DetectorMonitorDataProviderInterface

Class to to provide data used for a detector rate view.

An instance of this class runs on the server; calls are made to collectData(List), passing in a list of scannables. This returns a list of positions for each of the scannables and detectors by performing the same sequence of calls to atScanStart, prepareForCollection, etc. as would normally be done during a step scan.

Any Xspress detector passed to collectData will be set to return only the FF value and has file writing switched off; Any Tfg scaler scannables do not correct for dark current, and will not show time frame length. These settings are restored at end of collectData.

Set setCollectionAllowed(boolean) to False to prevent collection of data. This can be used to be sure that no data is being collected by the detector rate view whilst a scan is running.

This class can also be used in a scan to stop detector rate collection : the atScanStart() sets the collection flag allowed flag to false, and blocks until the current collection has finished.

Field Summary

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.Scannable

ATTR_NEXUS_CATEGORY, ATTR_NX_CLASS, DEFAULT_INPUT_NAME, VALUE_UNAVAILABLE

Constructor Summary

Constructors

Constructor	Description
DetectorMonitorDataProvider()

Method Summary

Modifier and Type	Method	Description
void	addIObserver(gda.observable.IObserver observer)
void	asynchronousMoveTo(Object position)	Trigger a move/operation and return immediately.
void	atCommandFailure()	Hook to be used by Scan and pos commands to inform the Scannable that an exception, such as a DeviceExcpetion, has occurred.
void	atScanEnd()	Reset collectionAllowed flag
void	atScanStart()	Set collectionAllowed flag to false and block until current collection has finished.
List<String>	collectData(List<String> allScannableNames)
void	deleteIObserver(gda.observable.IObserver observer)
void	deleteIObservers()
boolean	getCollectionAllowed()
boolean	getCollectionIsRunning()
double	getCollectionTime()
List<String>	getOutputFields(List<String> scannableNames)
boolean	isBusy()	Check if the Scannable is moving/operating.
boolean	isScriptOrScanIsRunning()
Object	rawGetPosition()	[Consider abstract] Read the position in its internal (user) representation.
void	setCollectionAllowed(boolean collectionAllowed)
void	setCollectionTime(double collectionTime)
void	setNumberFormat(Map<String,String> numberFormat)	Set a map containing the output format to be used when displaying quanties in the GUI.
void	stop()	Stop the current move/operation.
void	waitWhileBusy()	Wait for current collection to finish.

Methods inherited from class gda.device.scannable.ScannableBase

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

Methods inherited from class gda.device.DeviceBase

close, 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.Device

close, getAttribute, getProtectionLevel, setAttribute, setProtectionLevel

Methods inherited from interface gda.factory.Findable

getName, setName

Methods inherited from interface gda.device.Scannable

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

Constructor Details

DetectorMonitorDataProvider

public DetectorMonitorDataProvider()

Method Details

getCollectionTime

public double getCollectionTime()

Specified by:

getCollectionTime in interface DetectorMonitorDataProviderInterface

setCollectionTime

public void setCollectionTime(double collectionTime)

Specified by:

setCollectionTime in interface DetectorMonitorDataProviderInterface

isScriptOrScanIsRunning

public boolean isScriptOrScanIsRunning()

Specified by:

isScriptOrScanIsRunning in interface DetectorMonitorDataProviderInterface

collectData

public List<String> collectData(List<String> allScannableNames)
                         throws DeviceException,
InterruptedException

Specified by:

collectData in interface DetectorMonitorDataProviderInterface

Throws:

DeviceException

InterruptedException

getOutputFields

public List<String> getOutputFields(List<String> scannableNames)

Specified by:

getOutputFields in interface DetectorMonitorDataProviderInterface

addIObserver

public void addIObserver(gda.observable.IObserver observer)

Specified by:

addIObserver in interface gda.observable.IObservable

Overrides:

addIObserver in class DeviceBase

deleteIObserver

public void deleteIObserver(gda.observable.IObserver observer)

Specified by:

deleteIObserver in interface gda.observable.IObservable

Overrides:

deleteIObserver in class DeviceBase

deleteIObservers

public void deleteIObservers()

Specified by:

deleteIObservers in interface gda.observable.IObservable

Overrides:

deleteIObservers in class DeviceBase

getCollectionAllowed

public boolean getCollectionAllowed()

Specified by:

getCollectionAllowed in interface DetectorMonitorDataProviderInterface

setCollectionAllowed

public void setCollectionAllowed(boolean collectionAllowed)

Specified by:

setCollectionAllowed in interface DetectorMonitorDataProviderInterface

setNumberFormat

public void setNumberFormat(Map<String,String> numberFormat)

Description copied from interface: DetectorMonitorDataProviderInterface

Set a map containing the output format to be used when displaying quanties in the GUI. (i.e. key=field name in the 'extra name' of a scannable, value=output format to use)

Specified by:

setNumberFormat in interface DetectorMonitorDataProviderInterface

Parameters:

numberFormat -

asynchronousMoveTo

public void asynchronousMoveTo(Object position)

Description copied from class: ScannableBase

Trigger a move/operation and return immediately. Implementations of this method should be non-blocking to allow concurrent motion; the isBusy method will be used to determine when the move has completed. Converts the external (user) position to an internal position and passes this to rawAsynchronousMoveTo.

Specified by:

asynchronousMoveTo in interface Scannable

Overrides:

asynchronousMoveTo in class ScannableBase

Parameters:

position - Position to move to should have an element for each input field.

rawGetPosition

public Object rawGetPosition()
                      throws DeviceException

Description copied from class: ScannableBase

[Consider abstract] Read the position in its internal (user) representation.

Overrides:

rawGetPosition in class ScannableBase

Returns:

the value represented by this Scannable

Throws:

DeviceException

See Also:

• Scannable.getPosition()

atScanStart

public void atScanStart()

Set collectionAllowed flag to false and block until current collection has finished.

Specified by:

atScanStart in interface Scannable

Overrides:

atScanStart in class ScannableBase

See Also:

• Scannable.atScanStart()

atScanEnd

public void atScanEnd()

Reset collectionAllowed flag

Specified by:

atScanEnd in interface Scannable

Overrides:

atScanEnd in class ScannableBase

See Also:

• Scannable.atScanEnd()

atCommandFailure

public void atCommandFailure()
                      throws DeviceException

Description copied from class: ScannableBase

Hook to be used by Scan and pos commands to inform the Scannable that an exception, such as a DeviceExcpetion, has occurred. However not called when the command is aborted using an InterruptionException. If a Scan is aborted then only Scannable.stop() will be called by the Scan or pos command.

Useful for telling Scannables which hold state during a scan for example, to reset themselves. Used for example by CoordinatedMotionScannables. This hook should be used not in the same way as the stop hook. Default behaviour is to do nothing. Inheriting classes have the option to implement this if their specific behaviour requires it.

Specified by:

atCommandFailure in interface Scannable

Overrides:

atCommandFailure in class ScannableBase

Throws:

DeviceException

See Also:

• Scannable.atCommandFailure()

isBusy

public boolean isBusy()

Description copied from interface: Scannable

Check if the Scannable is moving/operating.

Specified by:

isBusy in interface Scannable

Returns:

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

stop

public void stop()

Description copied from class: ScannableBase

Stop the current move/operation. Default behaviour is to do nothing. Inheriting classes have the option to implement this if their specific behaviour requires it.

Specified by:

stop in interface Scannable

Overrides:

stop in class ScannableBase

See Also:

• Scannable.stop()

waitWhileBusy

public void waitWhileBusy()

Wait for current collection to finish.

Specified by:

waitWhileBusy in interface Scannable

Overrides:

waitWhileBusy in class ScannableBase

getCollectionIsRunning

public boolean getCollectionIsRunning()

Specified by:

getCollectionIsRunning in interface DetectorMonitorDataProviderInterface

Returns:

true if collection of detector values is currently taking place. i.e. collectData(List) is currently in progress.