Package gda.device.zebra

Class ZebraMonitorController

java.lang.Object

gda.factory.ConfigurableBase

gda.factory.FindableConfigurableBase

gda.device.DeviceBase

gda.device.scannable.ScannableBase

gda.device.zebra.ZebraMonitorController

All Implemented Interfaces:

ContinuousMoveController, HardwareTriggerProvider, Device, Scannable, ContinuouslyScannableViaController, PositionCallableProvider<Double>, PositionStreamIndexerProvider<Double>, Configurable, Findable, gda.observable.IObservable, org.springframework.beans.factory.InitializingBean

public class ZebraMonitorController
extends ScannableBase
implements ContinuousMoveController, PositionCallableProvider<Double>, PositionStreamIndexerProvider<Double>, ContinuouslyScannableViaController, org.springframework.beans.factory.InitializingBean

The ZebraMonitorController is intended to be used to monitor a Zebra which is not being used to control a move.

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

Method Summary

Modifier and Type	Method	Description
void	afterPropertiesSet()
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	atScanLineEnd()	Called for every Scannable at the end of every scan
void	atScanLineStart()	Called for every Scannable at the start of every scan
void	atScanStart()	Called for every Scannable at the start of a group of nested scans (or a single scan if that is the case)
ContinuousMoveController	getContinuousMoveController()
int	getNumberTriggers()
Callable<Double>	getPositionCallable()
PositionStreamIndexer<Double>	getPositionSteamIndexer(int index)	Get a PositionStreamIndexer for a Zebra position capture stream.
double	getTotalTime()
Zebra	getZebra()
ZebraConstantVelocityMoveController	getZebraCVMoveController()
boolean	isBusy()	Check if the Scannable is moving/operating.
boolean	isMoving()	Check if the controller is moving axes.
boolean	isOperatingContinously()	Indicates whether the Scannable has deferred control to the he configured ContinuousMoveController
void	prepareForMove()	Prepare the already configured controller to move, waiting until ready.
void	setContinuousMoveController(ContinuousMoveController controller)
void	setOperatingContinuously(boolean b)	Enable or disable control through the configured ContinuousMoveController
void	setTriggerPeriod(double seconds)
void	setZebra(Zebra zebraToMonitor)
void	setZebraCVMoveController(ZebraConstantVelocityMoveController zebraCVMoveController)
void	startMove()	Start the prepared move and return immediately.
void	stop()	Stop the current move/operation.
void	stopAndReset()	Stop a move if one is in progress and then reset the controller.
void	waitWhileMoving()	Wait until the controller has completed moving axes

Methods inherited from class gda.device.scannable.ScannableBase

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

Methods inherited from interface gda.device.Scannable

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

Constructor Details

ZebraMonitorController

public ZebraMonitorController()

Method Details

prepareForMove

public void prepareForMove()
                    throws DeviceException,
InterruptedException

Description copied from interface: ContinuousMoveController

Prepare the already configured controller to move, waiting until ready. Normally this should move motors to the start position.

Specified by:

prepareForMove in interface ContinuousMoveController

Throws:

InterruptedException

DeviceException

startMove

public void startMove()
               throws DeviceException

Description copied from interface: ContinuousMoveController

Start the prepared move and return immediately.

Specified by:

startMove in interface ContinuousMoveController

Throws:

DeviceException

isMoving

public boolean isMoving()
                 throws DeviceException

Description copied from interface: ContinuousMoveController

Check if the controller is moving axes.

Specified by:

isMoving in interface ContinuousMoveController

Returns:

true if moving.

Throws:

DeviceException

waitWhileMoving

public void waitWhileMoving()
                     throws DeviceException,
InterruptedException

Description copied from interface: ContinuousMoveController

Wait until the controller has completed moving axes

Specified by:

waitWhileMoving in interface ContinuousMoveController

Throws:

InterruptedException

DeviceException

stopAndReset

public void stopAndReset()
                  throws DeviceException,
InterruptedException

Description copied from interface: ContinuousMoveController

Stop a move if one is in progress and then reset the controller.

Specified by:

stopAndReset in interface ContinuousMoveController

Throws:

DeviceException

InterruptedException

setTriggerPeriod

public void setTriggerPeriod(double seconds)
                      throws DeviceException

Specified by:

setTriggerPeriod in interface HardwareTriggerProvider

Throws:

DeviceException

getNumberTriggers

public int getNumberTriggers()

Specified by:

getNumberTriggers in interface HardwareTriggerProvider

getTotalTime

public double getTotalTime()
                    throws DeviceException

Specified by:

getTotalTime in interface HardwareTriggerProvider

Throws:

DeviceException

getPositionCallable

public Callable<Double> getPositionCallable()
                                     throws DeviceException

Specified by:

getPositionCallable in interface PositionCallableProvider<Double>

Throws:

DeviceException

getPositionSteamIndexer

public PositionStreamIndexer<Double> getPositionSteamIndexer(int index)

Get a PositionStreamIndexer for a Zebra position capture stream. Since each stream can only be used once, allow secondary clients to access copies of position streams by using an offset on the index. Indices 0 to 4 are ENC1-4, 6 to 9 are DIV1-4 and 10 is Capture time. Primary indices 0 to 10 are mapped onto secondary indices 11 to 21.

Specified by:

getPositionSteamIndexer in interface PositionStreamIndexerProvider<Double>

setOperatingContinuously

public void setOperatingContinuously(boolean b)
                              throws DeviceException

Description copied from interface: ContinuouslyScannableViaController

Enable or disable control through the configured ContinuousMoveController

Specified by:

setOperatingContinuously in interface ContinuouslyScannableViaController

Parameters:

b -

Throws:

DeviceException

isOperatingContinously

public boolean isOperatingContinously()

Description copied from interface: ContinuouslyScannableViaController

Indicates whether the Scannable has deferred control to the he configured ContinuousMoveController

Specified by:

isOperatingContinously in interface ContinuouslyScannableViaController

Returns:

true if control is defered

getContinuousMoveController

public ContinuousMoveController getContinuousMoveController()

Specified by:

getContinuousMoveController in interface ContinuouslyScannableViaController

setContinuousMoveController

public void setContinuousMoveController(ContinuousMoveController controller)

Specified by:

setContinuousMoveController in interface ContinuouslyScannableViaController

atScanStart

public void atScanStart()
                 throws DeviceException

Description copied from class: ScannableBase

Called for every Scannable at the start of a group of nested scans (or a single scan if that is the case) Default behaviour is to do nothing. Inheriting classes have the option to implement this if their specific behaviour requires it.

Specified by:

atScanStart in interface Scannable

Overrides:

atScanStart in class ScannableBase

Throws:

DeviceException

See Also:

• Scannable.atScanStart()

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

atScanLineEnd

public void atScanLineEnd()
                   throws DeviceException

Description copied from class: ScannableBase

Called for every Scannable at the end 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:

atScanLineEnd in interface Scannable

Overrides:

atScanLineEnd in class ScannableBase

Throws:

DeviceException

See Also:

• Scannable.atScanLineEnd()

stop

public void stop()
          throws DeviceException

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

Throws:

DeviceException

See Also:

• Scannable.stop()

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()
               throws DeviceException

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

Throws:

DeviceException

afterPropertiesSet

public void afterPropertiesSet()
                        throws Exception

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

Throws:

Exception

getZebraCVMoveController

public ZebraConstantVelocityMoveController getZebraCVMoveController()

setZebraCVMoveController

public void setZebraCVMoveController(ZebraConstantVelocityMoveController zebraCVMoveController)

getZebra

public Zebra getZebra()

setZebra

public void setZebra(Zebra zebraToMonitor)