Package gda.px.smargon

Class SmarGonXyzScannableGroup

java.lang.Object

gda.factory.ConfigurableBase

gda.factory.FindableConfigurableBase

gda.device.DeviceBase

gda.device.scannable.ScannableBase

gda.device.scannable.scannablegroup.ScannableGroup

gda.px.smargon.SmarGonXyzScannableGroup

All Implemented Interfaces:

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

@ServiceInterface(IScannableGroup.class)
public class SmarGonXyzScannableGroup
extends ScannableGroup

Field Summary

Fields

Modifier and Type	Field	Description
final int	moveTimeout

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

Method Summary

Modifier and Type	Method	Description
void	asynchronousMoveTo(Object internalPosition)	Trigger a move/operation and return immediately.
boolean	isBusy()	Check if the Scannable is moving/operating.
void	moveTo(Object position)	Trigger a move/operation and block until completion.
void	setDeferredMoves(DeferredMoves deferredMoves)
void	setSmarGonController(SmarGonController smarGonController)
void	waitWhileBusy()	Returns when operation carried out by moveTo has completed
void	waitWhileBusyWithTimeout(int timeoutSeconds)

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

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

Methods inherited from class gda.device.scannable.ScannableBase

__call__, __call__, __doc__, __getitem__, __len__, __repr__, __str__, externalToInternal, getLevel, getScanMetadataAttribute, getScanMetadataAttributeNames, getScanMetadataAttributes, internalToExternal, isAt, 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

getLevel, getScanMetadataAttribute, getScanMetadataAttributeNames, getScanMetadataAttributes, isAt, setLevel, setOutputFormat, setScanMetadataAttribute, setScanMetadataAttributes

Field Details

moveTimeout

public final int moveTimeout

Constructor Details

SmarGonXyzScannableGroup

public SmarGonXyzScannableGroup()

Method Details

setSmarGonController

public void setSmarGonController(SmarGonController smarGonController)

setDeferredMoves

public void setDeferredMoves(DeferredMoves deferredMoves)

asynchronousMoveTo

public void asynchronousMoveTo(Object internalPosition)
                        throws DeviceException

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 ScannableGroup

Parameters:

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

Throws:

DeviceException

moveTo

public void moveTo(Object position)
            throws DeviceException

Description copied from class: ScannableBase

Trigger a move/operation and block until completion. If this is overridden, asynchronousMoveTo must also be valid, and the externalToInternal conversion must be applied.

Specified by:

moveTo in interface Scannable

Overrides:

moveTo in class ScannableBase

Parameters:

position -

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 ScannableGroup

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

waitWhileBusyWithTimeout

public void waitWhileBusyWithTimeout(int timeoutSeconds)
                              throws DeviceException,
InterruptedException,
TimeoutException

Throws:

DeviceException

InterruptedException

TimeoutException