Package gda.device.scannable.scannablegroup

Class DeferredAndTrajectoryScannableGroup

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

gda.device.scannable.scannablegroup.DeferredAndTrajectoryScannableGroup

All Implemented Interfaces:

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

public class DeferredAndTrajectoryScannableGroup
extends DeferredScannableGroup

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

Method Summary

Modifier and Type	Method	Description
void	addChildToMove(gda.device.scannable.scannablegroup.ICoordinatedChildScannable childScannable)	Puts the group into targeting mode if it is not already, and tells the group to await for a setElementTarget() call from that element before triggering the coordinated move.
void	asynchronousMoveTo(Object position)	asynchronousMoveTo implemented following recommendations to check whether all moves have called back.
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.
ContinuousMoveController	getContinuousMoveController()
Object	getPosition()	Returns the current position of the Scannable.
Object	getPositionWhileMovingContinuousely(gda.device.scannable.scannablegroup.ICoordinatedScannableGroupChildScannable childScannable)
List<ScannableMotor>	getScannableMotors()
boolean	isBusy()	Check if the Scannable is moving/operating.
boolean	isOperatingContinously()	Indicates whether the Scannable has deferred control to the he configured ContinuousMoveController
boolean	isTargeting()
Double[]	positionForUnderlyingMotorsToScannable(Double[] posForUnderlyingMotors)
void	setChildTarget(gda.device.scannable.scannablegroup.ICoordinatedChildScannable childScannable, Object position)	Set the target for a given element.
void	setContinuousMoveController(ContinuousMoveController controller)
void	setGroupMembers(List<Scannable> groupMembers)	Sets the group members that make up this scannable group.
void	setOperatingContinuously(boolean b)	Enable or disable control through the configured ContinuousMoveController
void	stop()	stop all axes and turn off defer flag, and stopAndReset controller if moving continuously
void	waitWhileBusy()	Returns when operation carried out by moveTo has completed
protected gda.device.scannable.scannablegroup.ICoordinatedChildScannable	wrapScannable(Scannable delegate)	Wraps a scannable with an ICoordinatedScannableElement to mediates access to the 'real' delegate scannable.

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

atCommandFailure, getDeferredControlPoint, getDeferredControlPointName, setDefer, setDeferredControlPoint, setDeferredControlPointName

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

__repr__, __str__, addChildToMove, addGroupMember, addPositionValidator, atLevelMoveStart, checkAdditionalPositionValidators, checkPositionValid, getAdditionalPositionValidators, isTargeting, setAdditionalPositionValidators, setChildTarget

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, getUnits, isDemandAllScannablePositions, removeGroupMemberByIndex, removeGroupMemberByScannable, setDemandAllScannablePositions, setExtraNames, setGroupMembersWithArray, setGroupMembersWithList, setInputNames, toFormattedString, toString, update

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

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

Constructor Details

DeferredAndTrajectoryScannableGroup

public DeferredAndTrajectoryScannableGroup()

Method Details

setGroupMembers

public void setGroupMembers(List<Scannable> groupMembers)
                     throws FactoryException

Description copied from class: ScannableGroup

Sets the group members that make up this scannable group. If this ScannableGroup is configured, sets it to unconfigured, to allow all the scannables to be configured by call this.configure()

Specified by:

setGroupMembers in interface IScannableGroup

Overrides:

setGroupMembers in class CoordinatedScannableGroup

Parameters:

groupMembers - the group members

Throws:

FactoryException

getScannableMotors

public List<ScannableMotor> getScannableMotors()

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 DeferredScannableGroup

Throws:

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

wrapScannable

protected gda.device.scannable.scannablegroup.ICoordinatedChildScannable wrapScannable(Scannable delegate)

Description copied from class: CoordinatedScannableGroup

Wraps a scannable with an ICoordinatedScannableElement to mediates access to the 'real' delegate scannable. coordinated moves. Note that only methods on ScannableMotionUnits, ScannableMotion or Scannable will be brought out.

Overrides:

wrapScannable in class CoordinatedScannableGroup

Parameters:

delegate -

Returns:

the wrapped scannable

setOperatingContinuously

public void setOperatingContinuously(boolean b)

Description copied from interface: ContinuouslyScannableViaController

Enable or disable control through the configured ContinuousMoveController

Specified by:

setOperatingContinuously in interface ContinuouslyScannableViaController

Parameters:

b -

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

asynchronousMoveTo

public void asynchronousMoveTo(Object position)
                        throws DeviceException

Description copied from class: DeferredScannableGroup

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

Specified by:

asynchronousMoveTo in interface Scannable

Overrides:

asynchronousMoveTo in class DeferredScannableGroup

Parameters:

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

Throws:

DeviceException

positionForUnderlyingMotorsToScannable

public Double[] positionForUnderlyingMotorsToScannable(Double[] posForUnderlyingMotors)

getPosition

public Object getPosition()
                   throws DeviceException

Description copied from class: ScannableBase

Returns the current position of the Scannable. Called by ConcurentScan at the end of the point. Reads an internal (hardware) position from rawGetPosition, converts this to an external (user) position and returns it.

Specified by:

getPosition in interface Scannable

Overrides:

getPosition in class ScannableGroup

Returns:

Current position with an element for each input and extra field. null if their are no fields.

Throws:

DeviceException

getPositionWhileMovingContinuousely

public Object getPositionWhileMovingContinuousely(gda.device.scannable.scannablegroup.ICoordinatedScannableGroupChildScannable childScannable)
                                           throws DeviceException

Overrides:

getPositionWhileMovingContinuousely in class CoordinatedScannableGroup

Throws:

DeviceException

isBusy

public boolean isBusy()
               throws DeviceException

Description copied from interface: Scannable

Check if the Scannable is moving/operating.

Specified by:

isBusy in interface Scannable

Overrides:

isBusy in class CoordinatedScannableGroup

Returns:

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

Throws:

DeviceException

waitWhileBusy

public void waitWhileBusy()
                   throws DeviceException,
InterruptedException

Description copied from class: ScannableBase

Returns when operation carried out by moveTo has completed If this is to be overriden, isBusy must also be valid. Although the pos and scan command currently use this method to determine if the Scannable is busy, this must not be relied upon.

Specified by:

waitWhileBusy in interface Scannable

Overrides:

waitWhileBusy in class ScannableGroup

Throws:

DeviceException

InterruptedException

stop

public void stop()
          throws DeviceException

stop all axes and turn off defer flag, and stopAndReset controller if moving continuously

Specified by:

stop in interface Scannable

Overrides:

stop in class DeferredScannableGroup

Throws:

DeviceException

See Also:

• Scannable.stop()

isTargeting

boolean isTargeting()

Returns:

True if the group is in targeting mode. (Elements to move have been added, but not all targets have been set, therefore the move has not yet been triggered.)

addChildToMove

void addChildToMove(gda.device.scannable.scannablegroup.ICoordinatedChildScannable childScannable)

Puts the group into targeting mode if it is not already, and tells the group to await for a setElementTarget() call from that element before triggering the coordinated move.

Parameters:

childScannable -

setChildTarget

void setChildTarget(gda.device.scannable.scannablegroup.ICoordinatedChildScannable childScannable,
 Object position)
             throws DeviceException

Set the target for a given element. addElementToMove() must first have been called.

Parameters:

childScannable -

position -

Throws:

DeviceException