Package gda.device.scannable

Class DummyScannableMotor

java.lang.Object

gda.factory.ConfigurableBase

gda.factory.FindableConfigurableBase

gda.device.DeviceBase

gda.device.scannable.ScannableBase

gda.device.scannable.ScannableMotionBase

gda.device.scannable.DummyScannable

gda.device.scannable.DummyScannableMotor

All Implemented Interfaces:

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

public class DummyScannableMotor
extends DummyScannable
implements IScannableMotor

Field Summary

Fields inherited from class gda.device.scannable.DummyScannable

currentPosition, increment

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

Method Summary

Modifier and Type	Method	Description
void	addAcceptableUnit(String newUnit)	Adds a new unit to the list of acceptable units based on the supllied string
String[]	getAcceptableUnits()
String	getControllerRecordName()	Gets the name of the controller record, e.g.
double	getDemandPositionTolerance()
String	getHardwareUnitString()
Double	getLowerInnerLimit()	Returns the innermost (i.e.
Double	getLowerMotorLimit()	Returns the lower motor limit in its external representation.
Motor	getMotor()	Method required by scripts which need to access the real motor at times. Before the script could get the motor name but now that the motor may be set by spring, scripts cannot get the underlying motor.
String	getMotorName()
double	getMotorResolution()
double	getSpeed()
double	getTimeToVelocity()	Returns this motor's time to velocity.
Double	getUpperInnerLimit()	Returns the innermost (i.e.
Double	getUpperMotorLimit()	Returns the upper motor limit in its external representation.
double	getUserOffset()
String	getUserUnits()	Returns a string representation of the current reporting units
void	setHardwareUnitString(String hardwareUnitString)	Sets the hardware unit to hardwareUnitString.
void	setLowerMotorLimit(double lowerMotorLimit)
void	setMotor(Motor motor)	Sets the motor used by this scannable motor.
void	setMotorName(String motorName)
void	setOffset(Object offsetPositionInExternalUnits)	Set offset(s) in amounts of external quantities as ScannableMotion.setOffset(Double...), but allows any position container containing objects that may be quantities.
void	setPosition(Object position)	Set the position
void	setSpeed(double requiredSpeed)	Set the speed of the underlying motor
void	setTimeToVelocity(double timeToVelocity)	Sets this motor's time to velocity.
void	setUpperMotorLimit(double upperMotorLimit)
void	setUserUnits(String userUnitsString)	Sets the user unit to userUnitString.

Methods inherited from class gda.device.scannable.DummyScannable

getPosition, isBusy, rawAsynchronousMoveTo, rawGetPosition, setControllerRecordName, setIncrement, setName

Methods inherited from class gda.device.scannable.ScannableMotionBase

a, addPositionValidator, ar, asynchronousMoveTo, checkPositionValid, checkPositionWithinGdaLimits, checkPositionWithinGdaLimits, completeInstantiation, externalToInternal, generateScannableLimitsReport, getAdditionalPositionValidators, getAttribute, getFirstInputLimits, getInputLimits, getInputLimits, getLimitsComponent, getLowerGdaLimits, getNumberTries, getOffset, getScalingFactor, getTolerances, getUpperGdaLimits, internalToExternal, isAt, moveTo, r, rawIsBusy, removePositionValidator, setAdditionalPositionValidators, setLimitsComponent, setLowerGdaLimits, setLowerGdaLimits, setNumberTries, setOffset, setOffsetAndScalingComponent, setScalingFactor, setTolerance, setTolerances, setUpperGdaLimits, setUpperGdaLimits, toFormattedString, 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, stop, throwExceptionIfInvalidTarget, toString, validateScannable, valueUnavailableString, waitWhileBusy, waitWhileBusy

Methods inherited from class gda.device.DeviceBase

addIObserver, close, deleteIObserver, deleteIObservers, getName, getProtectionLevel, isBeingObserved, isConfigureAtStartup, notifyIObservers, setAttribute, setConfigureAtStartup, setProtectionLevel

Methods inherited from class gda.factory.ConfigurableBase

configure, 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, atScanEnd, atScanLineEnd, atScanLineStart, atScanStart, checkPositionValid, getExtraNames, getInputNames, getLevel, getOutputFormat, getPosition, getScanMetadataAttribute, getScanMetadataAttributeNames, getScanMetadataAttributes, isAt, isBusy, moveTo, 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

Constructor Details

DummyScannableMotor

public DummyScannableMotor()

Method Details

getSpeed

public double getSpeed()
                throws DeviceException

Specified by:

getSpeed in interface IScannableMotor

Returns:

speed of the motor

Throws:

DeviceException

getMotorResolution

public double getMotorResolution()
                          throws DeviceException

Specified by:

getMotorResolution in interface IScannableMotor

Returns:

the resolution of the motor

Throws:

DeviceException

getDemandPositionTolerance

public double getDemandPositionTolerance()

Specified by:

getDemandPositionTolerance in interface IScannableMotor

Returns:

the deadband retry of an EPICS motor for eg.

getUserOffset

public double getUserOffset()
                     throws DeviceException

Specified by:

getUserOffset in interface IScannableMotor

Returns:

the user offset on the motor

Throws:

DeviceException

getTimeToVelocity

public double getTimeToVelocity()
                         throws DeviceException

Description copied from interface: IScannableMotor

Returns this motor's time to velocity.

Specified by:

getTimeToVelocity in interface IScannableMotor

Throws:

DeviceException

setSpeed

public void setSpeed(double requiredSpeed)
              throws DeviceException

Description copied from interface: IScannableMotor

Set the speed of the underlying motor

Specified by:

setSpeed in interface IScannableMotor

Parameters:

requiredSpeed - in the motor's units

Throws:

DeviceException

setMotor

public void setMotor(Motor motor)

Description copied from interface: IScannableMotor

Sets the motor used by this scannable motor.

Specified by:

setMotor in interface IScannableMotor

Parameters:

motor - the motor

getMotor

public Motor getMotor()

Description copied from interface: IScannableMotor

Method required by scripts which need to access the real motor at times.
Before the script could get the motor name but now that the motor may be set by spring, scripts cannot get the underlying motor.

Specified by:

getMotor in interface IScannableMotor

Returns:

Motor

setMotorName

public void setMotorName(String motorName)

Specified by:

setMotorName in interface IScannableMotor

Parameters:

motorName - The motorName to set.

getMotorName

public String getMotorName()

Specified by:

getMotorName in interface IScannableMotor

Returns:

Returns the motorName.

setTimeToVelocity

public void setTimeToVelocity(double timeToVelocity)
                       throws DeviceException

Description copied from interface: IScannableMotor

Sets this motor's time to velocity.

Specified by:

setTimeToVelocity in interface IScannableMotor

Throws:

DeviceException

setPosition

public void setPosition(Object position)
                 throws DeviceException

Description copied from interface: IScannableMotor

Set the position

Specified by:

setPosition in interface IScannableMotor

Throws:

DeviceException

getLowerMotorLimit

public Double getLowerMotorLimit()
                          throws DeviceException

Description copied from interface: IScannableMotor

Returns the lower motor limit in its external representation. Null if there is no lower Motor limit.

Specified by:

getLowerMotorLimit in interface IScannableMotor

Returns:

limit in external representation

Throws:

DeviceException

getUpperMotorLimit

public Double getUpperMotorLimit()
                          throws DeviceException

Description copied from interface: IScannableMotor

Returns the upper motor limit in its external representation. Null if there is no upper Motor limit.

Specified by:

getUpperMotorLimit in interface IScannableMotor

Returns:

limit in external representation

Throws:

DeviceException

getLowerInnerLimit

public Double getLowerInnerLimit()
                          throws DeviceException

Description copied from interface: IScannableMotor

Returns the innermost (i.e. the most limiting) of the lower Scannable and Motor limits.

Specified by:

getLowerInnerLimit in interface IScannableMotor

Returns:

the highest minimum limit, or null if neither are set.

Throws:

DeviceException

getUpperInnerLimit

public Double getUpperInnerLimit()
                          throws DeviceException

Description copied from interface: IScannableMotor

Returns the innermost (i.e. the most limiting) of the upper Scannable and Motor limits.

Specified by:

getUpperInnerLimit in interface IScannableMotor

Returns:

the lowest maximum limit, or null if neither are set.

Throws:

DeviceException

setUpperMotorLimit

public void setUpperMotorLimit(double upperMotorLimit)

setLowerMotorLimit

public void setLowerMotorLimit(double lowerMotorLimit)

getUserUnits

public String getUserUnits()

Description copied from interface: ScannableMotionUnits

Returns a string representation of the current reporting units

Specified by:

getUserUnits in interface ScannableMotionUnits

Returns:

Returns the reportingUnitsString.

setUserUnits

public void setUserUnits(String userUnitsString)
                  throws DeviceException

Description copied from interface: ScannableMotionUnits

Sets the user unit to userUnitString. If a hardware unit has not been explicitly set, then the hardware unit is also set to userUnitString. If a hardware unit has been set, and the userUnit is not compatible with this, then a DeviceException is thrown.

Specified by:

setUserUnits in interface ScannableMotionUnits

Parameters:

userUnitsString - The reportingUnitsString to set.

Throws:

DeviceException - if string not found in list of acceptable units

getHardwareUnitString

public String getHardwareUnitString()

Specified by:

getHardwareUnitString in interface ScannableMotionUnits

Returns:

Returns the motorUnitString.

setHardwareUnitString

public void setHardwareUnitString(String hardwareUnitString)
                           throws DeviceException

Description copied from interface: ScannableMotionUnits

Sets the hardware unit to hardwareUnitString. If a user unit has not been explicitly set then the user unit is also set to hardwareUnitString. If the user unit has been explicitly set and the new hardware unit would invalidate this then a DeviceException is thrown.

Based on this string, this method will build a list of acceptable user-units. Afterwards, the acceptable units list can be added to via the addAcceptableUnits method if the defaults do not cover enough.

Specified by:

setHardwareUnitString in interface ScannableMotionUnits

Parameters:

hardwareUnitString - The motorUnitString to set.

Throws:

DeviceException

getAcceptableUnits

public String[] getAcceptableUnits()

Specified by:

getAcceptableUnits in interface ScannableMotionUnits

Returns:

Returns the acceptableUnitStrings.

addAcceptableUnit

public void addAcceptableUnit(String newUnit)
                       throws DeviceException

Description copied from interface: ScannableMotionUnits

Adds a new unit to the list of acceptable units based on the supllied string

Specified by:

addAcceptableUnit in interface ScannableMotionUnits

Parameters:

newUnit - - string representation of the new acceptable unit

Throws:

DeviceException

setOffset

public void setOffset(Object offsetPositionInExternalUnits)

Description copied from interface: ScannableMotionUnits

Set offset(s) in amounts of external quantities as ScannableMotion.setOffset(Double...), but allows any position container containing objects that may be quantities. ScannableMotion.setOffset(Double...)

Specified by:

setOffset in interface ScannableMotionUnits

Parameters:

offsetPositionInExternalUnits -

getControllerRecordName

public String getControllerRecordName()

Description copied from interface: ControllerRecord

Gets the name of the controller record, e.g. EPICS process variable name. For example, in NeXus this value can be written as the value of the controller_record field for the NXpositioner for the scannable.

Specified by:

getControllerRecordName in interface ControllerRecord

Overrides:

getControllerRecordName in class DummyScannable

Returns:

controller record name

See Also:

• Nexus documentation for NXpositioner