Package gda.px.smargon

Class SmarGonScannableMotor

java.lang.Object

gda.factory.ConfigurableBase

gda.factory.FindableConfigurableBase

gda.device.DeviceBase

gda.device.scannable.ScannableBase

gda.device.scannable.ScannableMotionBase

gda.device.scannable.ScannableMotionUnitsBase

gda.device.scannable.ScannableMotor

gda.px.smargon.SmarGonScannableMotor

All Implemented Interfaces:

INeXusInfoWriteable, ControllerRecord, Device, IScannableMotor, Scannable, ScannableMotion, ScannableMotionUnits, Configurable, Findable, gda.observable.IObservable

@ServiceInterface(ScannableMotionUnits.class)
public class SmarGonScannableMotor
extends ScannableMotor

Field Summary

Fields

Modifier and Type	Field	Description
final int	moveTimeout

Fields inherited from class gda.device.scannable.ScannableMotor

COPY_MOTOR_LIMITS_INTO_SCANNABLE_LIMITS

Fields inherited from class gda.device.scannable.ScannableMotionUnitsBase

unitsComponent

Fields inherited from class gda.device.scannable.ScannableMotionBase

numberTries, tolerance

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.IScannableMotor

WAS_ALREADY_BUSY_SO_COULD_NOT_BE_MOVED

Fields inherited from interface gda.device.Scannable

ATTR_NEXUS_CATEGORY, ATTR_NX_CLASS, DEFAULT_INPUT_NAME, VALUE_UNAVAILABLE

Fields inherited from interface gda.device.ScannableMotion

FIRSTINPUTLIMITS

Fields inherited from interface gda.device.ScannableMotionUnits

HARDWAREUNITS, USERUNITS

Constructor Summary

Constructors

Constructor	Description
SmarGonScannableMotor()

Method Summary

Modifier and Type	Method	Description
boolean	isBusy()	Return true if motor is busy.
void	moveTo(Object position)	If the numberTries and tolerance attributes have been set then repeatedly tries to move this Scannable until the position is within the tolerance range.
void	rawAsynchronousMoveTo(Object internalPosition)	[Consider abstract] Trigger a move/operation to an internal/hardware position and return immediately.
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.ScannableMotor

attachMotorObserver, configure, getActualPosition, getAttribute, getControllerRecordName, getDemandPosition, getDemandPositionTolerance, getFirstInputLimits, getLowerInnerLimit, getLowerMotorLimit, getMotor, getMotorLimitsComponent, getMotorName, getMotorResolution, getPosition, getSpeed, getTimeToVelocity, getUpperInnerLimit, getUpperMotorLimit, getUserOffset, isReturningDemandPosition, rawGetDemandPosition, rawGetPosition, setDemandPositionTolerance, setLogMoveRequestsWithInfo, setMotor, setMotorLimitsComponent, setMotorName, setNotifyObserverPositionChangeEvents, setPosition, setReturnDemandPosition, setSpeed, setTimeToVelocity, stop, toFormattedString

Methods inherited from class gda.device.scannable.ScannableMotionUnitsBase

addAcceptableUnit, externalToInternal, getAcceptableUnits, getHardwareUnitString, getInitialUserUnits, getOffset, getUserUnits, internalToExternal, isAt, setHardwareUnitString, setInitialUserUnits, setOffset, setOffset, setUserUnits

Methods inherited from class gda.device.scannable.ScannableMotionBase

a, addPositionValidator, ar, asynchronousMoveTo, checkPositionValid, checkPositionWithinGdaLimits, checkPositionWithinGdaLimits, completeInstantiation, generateScannableLimitsReport, getAdditionalPositionValidators, getInputLimits, getInputLimits, getLimitsComponent, getLowerGdaLimits, getNumberTries, getScalingFactor, getTolerances, getUpperGdaLimits, r, rawIsBusy, removePositionValidator, setAdditionalPositionValidators, setLimitsComponent, setLowerGdaLimits, setLowerGdaLimits, setNumberTries, setOffsetAndScalingComponent, setScalingFactor, setTolerance, setTolerances, setUpperGdaLimits, setUpperGdaLimits, writeNeXusInformation, writeNeXusInformationLimits

Methods inherited from class gda.device.scannable.ScannableBase

__call__, __call__, __doc__, __getitem__, __len__, __repr__, __str__, atCommandFailure, atLevelEnd, atLevelMoveStart, atLevelStart, atPointEnd, atPointStart, atScanEnd, atScanLineEnd, atScanLineStart, atScanStart, getExtraNames, getInputNames, getLevel, getOutputFormat, getScanMetadataAttribute, getScanMetadataAttributeNames, getScanMetadataAttributes, setExtraNames, setInputNames, setLevel, setOutputFormat, setScanMetadataAttribute, setScanMetadataAttributes, throwExceptionIfInvalidTarget, toString, validateScannable, valueUnavailableString, waitWhileBusy

Methods inherited from class gda.device.DeviceBase

addIObserver, close, deleteIObserver, deleteIObservers, 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, 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, atCommandFailure, atLevelEnd, atLevelMoveStart, atLevelStart, atPointEnd, atPointStart, atScanEnd, atScanLineEnd, atScanLineStart, atScanStart, checkPositionValid, getExtraNames, getInputNames, getLevel, getOutputFormat, getScanMetadataAttribute, getScanMetadataAttributeNames, getScanMetadataAttributes, isAt, setExtraNames, setInputNames, setLevel, setOutputFormat, setScanMetadataAttribute, setScanMetadataAttributes

Methods inherited from interface gda.device.ScannableMotion

a, ar, checkPositionWithinGdaLimits, checkPositionWithinGdaLimits, getLowerGdaLimits, getNumberTries, getOffset, getScalingFactor, getTolerances, getUpperGdaLimits, r, setLowerGdaLimits, setLowerGdaLimits, setNumberTries, setOffset, setScalingFactor, setTolerance, setTolerances, setUpperGdaLimits, setUpperGdaLimits

Methods inherited from interface gda.device.ScannableMotionUnits

addAcceptableUnit, getAcceptableUnits, getHardwareUnitString, getUserUnits, setHardwareUnitString, setOffset, setUserUnits

Field Details

moveTimeout

public final int moveTimeout

Constructor Details

SmarGonScannableMotor

public SmarGonScannableMotor()

Method Details

setSmarGonController

public void setSmarGonController(SmarGonController smarGonController)

rawAsynchronousMoveTo

public void rawAsynchronousMoveTo(Object internalPosition)
                           throws DeviceException

Description copied from class: ScannableMotor

[Consider abstract] Trigger a move/operation to an internal/hardware position and return immediately.. Triggers a motor to move. Throws a DeviceException if the motor is already busy. This method's guts are synchronised so that another thread can't enter it before the first thread has completed the motor's (asynchronous) moveTo call. For the DeviceException to be thrown properly when a move request is made of a moving motor, the motor's getStatus() method must *immediately* report BUSY after it's moveTo call has completed.

Overrides:

rawAsynchronousMoveTo in class ScannableMotor

Parameters:

internalPosition - Position in its internal/hardware representation. e.g. with units and offsets removed

Throws:

DeviceException

See Also:

• asynchronousMoveTo

moveTo

public void moveTo(Object position)
            throws DeviceException

Description copied from class: ScannableMotionBase

If the numberTries and tolerance attributes have been set then repeatedly tries to move this Scannable until the position is within the tolerance range.

Specified by:

moveTo in interface Scannable

Overrides:

moveTo in class ScannableMotionBase

Parameters:

position -

Throws:

DeviceException

See Also:

• ScannableBase.moveTo(java.lang.Object)

isBusy

public boolean isBusy()
               throws DeviceException

Description copied from class: ScannableMotor

Return true if motor is busy.

Specified by:

isBusy in interface Scannable

Overrides:

isBusy in class ScannableMotor

Returns:

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

Throws:

DeviceException

See Also:

• Scannable.isBusy()

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 ScannableMotor

Throws:

DeviceException

InterruptedException

waitWhileBusyWithTimeout

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

Throws:

DeviceException

InterruptedException

TimeoutException