Package gda.device.scannable

Class AirBearingScannableMotor

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.device.scannable.AirBearingScannableMotor

All Implemented Interfaces:

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

@ServiceInterface(IAirBearingScannableMotor.class)
public class AirBearingScannableMotor
extends ScannableMotor
implements IAirBearingScannableMotor

An extended ScannableMotor implementation that provides control to switch on/off air supply to the motor's air bearing mechanism automatically when motion is requested.

Field Summary

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

Method Summary

Modifier and Type	Method	Description
void	atScanEnd()	Called for every Scannable at the end of a group of nested scans (or a single scan if that is the case).
void	atScanStart()	Called for every Scannable at the start of a group of nested scans (or a single scan if that is the case)
Scannable	getAirBearingScannable()
String	getOffPositionValue()
String	getOnPositionValue()
boolean	isOn()	check if the air supply to the motor is on or not.
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	off()	switch off the air supply
void	on()	switch on the air supply
void	rawAsynchronousMoveTo(Object internalPosition)	[Consider abstract] Trigger a move/operation to an internal/hardware position and return immediately.
void	setAirBearingScannable(Scannable airBearingScannable)
void	setOffPositionValue(String offPositionValue)
void	setOnPositionValue(String onPositionValue)

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, isBusy, isReturningDemandPosition, rawGetDemandPosition, rawGetPosition, setDemandPositionTolerance, setLogMoveRequestsWithInfo, setMotor, setMotorLimitsComponent, setMotorName, setNotifyObserverPositionChangeEvents, setPosition, setReturnDemandPosition, setSpeed, setTimeToVelocity, stop, toFormattedString, waitWhileBusy

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, atScanLineEnd, atScanLineStart, 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

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, atCommandFailure, atLevelEnd, atLevelMoveStart, atLevelStart, atPointEnd, atPointStart, atScanLineEnd, atScanLineStart, checkPositionValid, getExtraNames, getInputNames, getLevel, getOutputFormat, getPosition, getScanMetadataAttribute, getScanMetadataAttributeNames, getScanMetadataAttributes, isAt, isBusy, setExtraNames, setInputNames, setLevel, setOutputFormat, setScanMetadataAttribute, setScanMetadataAttributes, stop, toFormattedString, waitWhileBusy

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

Constructor Details

AirBearingScannableMotor

public AirBearingScannableMotor()

Method Details

on

public void on()
        throws DeviceException

Description copied from interface: IAirBearingScannableMotor

switch on the air supply

Specified by:

on in interface IAirBearingScannableMotor

Throws:

DeviceException

off

public void off()
         throws DeviceException

Description copied from interface: IAirBearingScannableMotor

switch off the air supply

Specified by:

off in interface IAirBearingScannableMotor

Throws:

DeviceException

isOn

public boolean isOn()
             throws DeviceException

Description copied from interface: IAirBearingScannableMotor

check if the air supply to the motor is on or not.

Specified by:

isOn in interface IAirBearingScannableMotor

Returns:

on - true, off -false

Throws:

DeviceException

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

atScanEnd

public void atScanEnd()
               throws DeviceException

Description copied from class: ScannableBase

Called for every Scannable at the end of a group of nested scans (or a single scan if that is the case).

Note that this is only called if the Scan finishes normally, or has been requested to finish early. This will not be called if the scan finishes due to an exception of any kind. See Scannable.atCommandFailure() Default behaviour is to do nothing. Inheriting classes have the option to implement this if their specific behaviour requires it.

Specified by:

atScanEnd in interface Scannable

Overrides:

atScanEnd in class ScannableBase

Throws:

DeviceException

See Also:

• Scannable.atScanEnd()

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)

getAirBearingScannable

public Scannable getAirBearingScannable()

setAirBearingScannable

public void setAirBearingScannable(Scannable airBearingScannable)

getOnPositionValue

public String getOnPositionValue()

setOnPositionValue

public void setOnPositionValue(String onPositionValue)

getOffPositionValue

public String getOffPositionValue()

setOffPositionValue

public void setOffPositionValue(String offPositionValue)