Package gda.device.scannable.scannablegroup

Class DeferredScannableGroup

java.lang.Object

gda.factory.ConfigurableBase

gda.factory.FindableConfigurableBase

gda.device.DeviceBase

gda.device.scannable.ScannableBase

gda.device.scannable.scannablegroup.ScannableGroup

gda.device.scannable.scannablegroup.CoordinatedScannableGroup

gda.device.scannable.scannablegroup.DeferredScannableGroup

All Implemented Interfaces:

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

Direct Known Subclasses:

DeferredAndTrajectoryScannableGroup

public class DeferredScannableGroup
extends CoordinatedScannableGroup

Controls a collection of Motors so that they moved via the Epics deferred move mechanism.

WARNING: Extending CoordinatedScannableGroup, the individual axes will be wrapped in ICoordinatedElementScannables which will hide any methods which are not in the Scannable, ScannableMotion or ScannableMotionUnits interface.

Field Summary

Fields inherited from class gda.device.scannable.scannablegroup.CoordinatedScannableGroup

coordinatedScannableComponent

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

Method Summary

Modifier and Type	Method	Description
void	asynchronousMoveTo(Object position)	asynchronousMoveTo implemented following recommendations to check whether all moves have called back.
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	configure()	Default implementation for classes that do not have to do any specific configuration. Classes that do their own configuration should *not* call this superclass function, as it may cause the object to appear configured before it really is.
ControlPoint	getDeferredControlPoint()
String	getDeferredControlPointName()
void	setDefer(boolean deferFlag)
void	setDeferredControlPoint(ControlPoint deferredControlPoint)
void	setDeferredControlPointName(String deferredControlPointName)
void	stop()	stop all axes and turn off defer flag

Methods inherited from class gda.device.scannable.scannablegroup.CoordinatedScannableGroup

__repr__, __str__, addChildToMove, addGroupMember, addPositionValidator, atLevelMoveStart, checkAdditionalPositionValidators, checkPositionValid, getAdditionalPositionValidators, getPositionWhileMovingContinuousely, isBusy, isTargeting, setAdditionalPositionValidators, setChildTarget, setGroupMembers, wrapScannable

Methods inherited from class gda.device.scannable.scannablegroup.ScannableGroup

__getattr__, addGroupMember, atLevelEnd, atLevelStart, atPointEnd, atPointStart, atScanEnd, atScanLineEnd, atScanLineStart, atScanStart, extractPositionsFromObject, getExtraNames, getGroupMember, getGroupMemberNames, getGroupMembers, getGroupMembersAsArray, getInputNames, getOutputFormat, getPosition, getUnits, isDemandAllScannablePositions, removeGroupMemberByIndex, removeGroupMemberByScannable, setDemandAllScannablePositions, setExtraNames, setGroupMembersWithArray, setGroupMembersWithList, setInputNames, toFormattedString, toString, update, waitWhileBusy

Methods inherited from class gda.device.scannable.ScannableBase

__call__, __call__, __doc__, __getitem__, __len__, externalToInternal, getLevel, getScanMetadataAttribute, getScanMetadataAttributeNames, getScanMetadataAttributes, internalToExternal, isAt, moveTo, rawAsynchronousMoveTo, rawGetPosition, setLevel, setOutputFormat, setScanMetadataAttribute, setScanMetadataAttributes, throwExceptionIfInvalidTarget, 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

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

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

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

Constructor Details

DeferredScannableGroup

public DeferredScannableGroup()

Method Details

configure

public void configure()
               throws FactoryException

Description copied from class: ConfigurableBase

Default implementation for classes that do not have to do any specific configuration.
Classes that do their own configuration should *not* call this superclass function, as it may cause the object to appear configured before it really is.

Specified by:

configure in interface Configurable

Overrides:

configure in class ScannableGroup

Throws:

FactoryException - if there is an error in configuration e.g. required variable not set or cannot connect to device

asynchronousMoveTo

public void asynchronousMoveTo(Object position)
                        throws DeviceException

asynchronousMoveTo implemented following recommendations to check whether all moves have called back.

Specified by:

asynchronousMoveTo in interface Scannable

Overrides:

asynchronousMoveTo in class CoordinatedScannableGroup

Parameters:

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

Throws:

DeviceException

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 CoordinatedScannableGroup

Throws:

DeviceException

See Also:

• Scannable.atCommandFailure()

setDefer

public void setDefer(boolean deferFlag)
              throws DeviceException

Parameters:

deferFlag -

Throws:

DeviceException

stop

public void stop()
          throws DeviceException

stop all axes and turn off defer flag

Specified by:

stop in interface Scannable

Overrides:

stop in class ScannableGroup

Throws:

DeviceException

See Also:

• Scannable.stop()

getDeferredControlPoint

public ControlPoint getDeferredControlPoint()

Returns:

control point

setDeferredControlPoint

public void setDeferredControlPoint(ControlPoint deferredControlPoint)

Parameters:

deferredControlPoint -

getDeferredControlPointName

public String getDeferredControlPointName()

Returns:

control point name

setDeferredControlPointName

public void setDeferredControlPointName(String deferredControlPointName)

Parameters:

deferredControlPointName -