Package uk.ac.gda.component.beamline.common

Interface IScannableMotorObservable

All Superinterfaces:

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

public interface IScannableMotorObservable
extends ScannableMotionUnits, IScannableMotor

Field Summary

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

Method Summary

Modifier and Type	Method	Description
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	getTimeToVelocity()	Returns this motor's time to velocity.
void	setSpeed(double theSpeed)	Set the speed of the underlying motor
void	setTimeToVelocity(double timeToVelocity)	Sets this motor's time to velocity.

Methods inherited from interface gda.factory.Configurable

configure, isConfigureAtStartup, isConfigured, reconfigure

Methods inherited from interface gda.device.ControllerRecord

getControllerRecordName

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

getDemandPositionTolerance, getLowerInnerLimit, getLowerMotorLimit, getMotorResolution, getSpeed, getUpperInnerLimit, getUpperMotorLimit, getUserOffset, setMotor, setMotorName, setPosition

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

Methods inherited from interface gda.device.ScannableMotionUnits

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

Method Details

getMotor

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

getMotorName

String getMotorName()

Specified by:

getMotorName in interface IScannableMotor

Returns:

Returns the motorName.

getTimeToVelocity

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

void setSpeed(double theSpeed)
       throws DeviceException

Description copied from interface: IScannableMotor

Set the speed of the underlying motor

Specified by:

setSpeed in interface IScannableMotor

Parameters:

theSpeed - in the motor's units

Throws:

DeviceException

setTimeToVelocity

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