Package gda.device.scannable

Class MonitorZebraAndMoveScannable

java.lang.Object

gda.factory.ConfigurableBase

gda.factory.FindableConfigurableBase

gda.device.DeviceBase

gda.device.scannable.ScannableBase

gda.device.scannable.MonitorZebraAndMoveScannable

All Implemented Interfaces:

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

public class MonitorZebraAndMoveScannable
extends ScannableBase

Class that monitors the number of captured pulses on Zebra and moves a scannable to positions after certain numbers of spectra have been captured.

Set the scannable to be moved using setScannableToMove(Scannable).

Add position to move scannable to at end of a spectrum using addPositionForSpectrum(Integer, Object).

The spectrum number - position Map is maintained in order of ascending spectrum number and has one position per spectrum. (i.e. adding a new position with same spectrum number as already in the map will overwrite it).

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, VALUE_UNAVAILABLE

Constructor Summary

Constructors

Constructor	Description
MonitorZebraAndMoveScannable()

Method Summary

Modifier and Type	Method	Description
void	addPositionForSpectrum(Integer spectrum, Object position)	Add a position to be moved to at end of a spectrum.
void	atScanLineStart()	Called for every Scannable at the start of every scan
SortedMap<Integer,Object>	getPositionForSpectrumMap()
Scannable	getScannableToMove()
int	getTimeOutSeconds()
Zebra	getZebra()
boolean	isBusy()	Check if the Scannable is moving/operating.
void	setNumReadoutsPerSpectrum(int numReadoutsPerSpectrum)
void	setPositionForSpectrumMap(SortedMap<Integer,Object> positionForSpectrumMap)
void	setScannableToMove(Scannable scannableToMove)
void	setTimeOutSeconds(int timeOutSeconds)
void	setZebra(Zebra zebra)
void	startRunning()	Loop over positionForSpectrumMap and for each entry wait for required number of spectra (pulses) to be captured on Zebra, then move the scannable to the requested position.

Methods inherited from class gda.device.scannable.ScannableBase

__call__, __call__, __doc__, __getitem__, __len__, __repr__, __str__, asynchronousMoveTo, atCommandFailure, atLevelEnd, atLevelMoveStart, atLevelStart, atPointEnd, atPointStart, atScanEnd, atScanLineEnd, atScanStart, checkPositionValid, externalToInternal, getExtraNames, getInputNames, getLevel, getOutputFormat, getPosition, getScanMetadataAttribute, getScanMetadataAttributeNames, getScanMetadataAttributes, internalToExternal, isAt, moveTo, rawAsynchronousMoveTo, rawGetPosition, setExtraNames, setInputNames, setLevel, setOutputFormat, setScanMetadataAttribute, setScanMetadataAttributes, stop, throwExceptionIfInvalidTarget, toFormattedString, 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.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

Constructor Details

MonitorZebraAndMoveScannable

public MonitorZebraAndMoveScannable()

Method Details

atScanLineStart

public void atScanLineStart()

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

See Also:

• Scannable.atScanLineStart()

setNumReadoutsPerSpectrum

public void setNumReadoutsPerSpectrum(int numReadoutsPerSpectrum)

startRunning

public void startRunning()

Loop over positionForSpectrumMap and for each entry wait for required number of spectra (pulses) to be captured on Zebra, then move the scannable to the requested position.

isBusy

public boolean isBusy()
               throws DeviceException

Description copied from interface: Scannable

Check if the Scannable is moving/operating.

Returns:

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

Throws:

DeviceException

getScannableToMove

public Scannable getScannableToMove()

setScannableToMove

public void setScannableToMove(Scannable scannableToMove)

getPositionForSpectrumMap

public SortedMap<Integer,Object> getPositionForSpectrumMap()

setPositionForSpectrumMap

public void setPositionForSpectrumMap(SortedMap<Integer,Object> positionForSpectrumMap)

addPositionForSpectrum

public void addPositionForSpectrum(Integer spectrum,
 Object position)

Add a position to be moved to at end of a spectrum.

Parameters:

spectrum -

position -

getZebra

public Zebra getZebra()

setZebra

public void setZebra(Zebra zebra)

getTimeOutSeconds

public int getTimeOutSeconds()

setTimeOutSeconds

public void setTimeOutSeconds(int timeOutSeconds)