Package gda.device.continuouscontroller

Class XpsConstantVelocityMoveController

java.lang.Object

gda.factory.ConfigurableBase

gda.factory.FindableConfigurableBase

gda.device.DeviceBase

gda.device.scannable.ScannableBase

gda.device.continuouscontroller.XpsConstantVelocityMoveController

All Implemented Interfaces:

ConstantVelocityMoveController, ContinuousMoveController, HardwareTriggerProvider, Device, Scannable, ContinuouslyScannableViaController, Configurable, Findable, gda.observable.IObservable

public class XpsConstantVelocityMoveController
extends ScannableBase
implements ConstantVelocityMoveController, ContinuouslyScannableViaController

Field Summary

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

Method Summary

Modifier and Type	Method	Description
void	asynchronousMoveTo(Object position)	Trigger a move/operation and return immediately.
void	atScanEnd()	Called for every Scannable at the end of a group of nested scans (or a single scan if that is the case).
ContinuousMoveController	getContinuousMoveController()
EpicsXpsConstantVelocityContoller	getController()
double	getEnd()
ShutteredScannableMotor	getMotor()
int	getNumberTriggers()
Object	getPosition()	Returns the current position of the Scannable.
Scannable	getScannable()
double	getStart()
double	getStep()
double	getTotalTime()
boolean	isBusy()	Check if the Scannable is moving/operating.
boolean	isMoving()	Check if the controller is moving axes.
boolean	isOperatingContinously()	Indicates whether the Scannable has deferred control to the he configured ContinuousMoveController
void	prepareForMove()	Prepare the already configured controller to move, waiting until ready.
void	setContinuousMoveController(ContinuousMoveController controller)
void	setController(EpicsXpsConstantVelocityContoller controller)
void	setEnd(double end)	Set the end location for the move in hardware units/offset/scale.
void	setMotor(ShutteredScannableMotor motor)
void	setOperatingContinuously(boolean b)	Enable or disable control through the configured ContinuousMoveController
void	setScannable(Scannable scannable)
void	setStart(double start)	Set the start location for the move in hardware units/offset/scale.
void	setStep(double step)	Set the step size for the move in hardware units/scale.
void	setTriggerPeriod(double seconds)
void	startMove()	Start the prepared move and return immediately.
void	stopAndReset()	Stop a move if one is in progress and then reset the controller.
void	waitWhileMoving()	Wait until the controller has completed moving axes

Methods inherited from class gda.device.scannable.ScannableBase

__call__, __call__, __doc__, __getitem__, __len__, __repr__, __str__, atCommandFailure, atLevelEnd, atLevelMoveStart, atLevelStart, atPointEnd, atPointStart, atScanLineEnd, atScanLineStart, atScanStart, checkPositionValid, externalToInternal, getExtraNames, getInputNames, getLevel, getOutputFormat, getScanMetadataAttribute, getScanMetadataAttributeNames, getScanMetadataAttributes, internalToExternal, isAt, moveTo, rawAsynchronousMoveTo, rawGetPosition, setExtraNames, setInputNames, setLevel, setOutputFormat, setScanMetadataAttribute, setScanMetadataAttributes, stop, throwExceptionIfInvalidTarget, toFormattedString, toString, validateScannable, valueUnavailableString, waitWhileBusy, 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

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

atCommandFailure, atLevelEnd, atLevelMoveStart, atLevelStart, atPointEnd, atPointStart, atScanLineEnd, atScanLineStart, atScanStart, checkPositionValid, getExtraNames, getInputNames, getLevel, getOutputFormat, getScanMetadataAttribute, getScanMetadataAttributeNames, getScanMetadataAttributes, isAt, moveTo, setExtraNames, setInputNames, setLevel, setOutputFormat, setScanMetadataAttribute, setScanMetadataAttributes, stop, toFormattedString, waitWhileBusy

Constructor Details

XpsConstantVelocityMoveController

public XpsConstantVelocityMoveController()

Method Details

getMotor

public ShutteredScannableMotor getMotor()

setMotor

public void setMotor(ShutteredScannableMotor motor)

getController

public EpicsXpsConstantVelocityContoller getController()

setController

public void setController(EpicsXpsConstantVelocityContoller controller)

prepareForMove

public void prepareForMove()
                    throws DeviceException,
InterruptedException

Description copied from interface: ContinuousMoveController

Prepare the already configured controller to move, waiting until ready. Normally this should move motors to the start position.

Specified by:

prepareForMove in interface ContinuousMoveController

Throws:

InterruptedException

DeviceException

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

startMove

public void startMove()
               throws DeviceException

Description copied from interface: ContinuousMoveController

Start the prepared move and return immediately.

Specified by:

startMove in interface ContinuousMoveController

Throws:

DeviceException

isMoving

public boolean isMoving()
                 throws DeviceException

Description copied from interface: ContinuousMoveController

Check if the controller is moving axes.

Specified by:

isMoving in interface ContinuousMoveController

Returns:

true if moving.

Throws:

DeviceException

waitWhileMoving

public void waitWhileMoving()
                     throws DeviceException,
InterruptedException

Description copied from interface: ContinuousMoveController

Wait until the controller has completed moving axes

Specified by:

waitWhileMoving in interface ContinuousMoveController

Throws:

InterruptedException

DeviceException

stopAndReset

public void stopAndReset()
                  throws DeviceException,
InterruptedException

Description copied from interface: ContinuousMoveController

Stop a move if one is in progress and then reset the controller.

Specified by:

stopAndReset in interface ContinuousMoveController

Throws:

DeviceException

InterruptedException

setTriggerPeriod

public void setTriggerPeriod(double seconds)
                      throws DeviceException

Specified by:

setTriggerPeriod in interface HardwareTriggerProvider

Throws:

DeviceException

getNumberTriggers

public int getNumberTriggers()

Specified by:

getNumberTriggers in interface HardwareTriggerProvider

getTotalTime

public double getTotalTime()
                    throws DeviceException

Specified by:

getTotalTime in interface HardwareTriggerProvider

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

Returns:

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

Throws:

DeviceException

setStart

public void setStart(double start)
              throws DeviceException

Description copied from interface: ConstantVelocityMoveController

Set the start location for the move in hardware units/offset/scale.

Specified by:

setStart in interface ConstantVelocityMoveController

Parameters:

start -

Throws:

DeviceException

getStart

public double getStart()

Specified by:

getStart in interface ConstantVelocityMoveController

setEnd

public void setEnd(double end)
            throws DeviceException

Description copied from interface: ConstantVelocityMoveController

Set the end location for the move in hardware units/offset/scale.

Specified by:

setEnd in interface ConstantVelocityMoveController

Parameters:

end -

Throws:

DeviceException

getEnd

public double getEnd()

Specified by:

getEnd in interface ConstantVelocityMoveController

setStep

public void setStep(double step)
             throws DeviceException

Description copied from interface: ConstantVelocityMoveController

Set the step size for the move in hardware units/scale.

Specified by:

setStep in interface ConstantVelocityMoveController

Parameters:

step -

Throws:

DeviceException

getStep

public double getStep()

Specified by:

getStep in interface ConstantVelocityMoveController

getScannable

public Scannable getScannable()

setScannable

public void setScannable(Scannable scannable)

setOperatingContinuously

public void setOperatingContinuously(boolean b)
                              throws DeviceException

Description copied from interface: ContinuouslyScannableViaController

Enable or disable control through the configured ContinuousMoveController

Specified by:

setOperatingContinuously in interface ContinuouslyScannableViaController

Parameters:

b -

Throws:

DeviceException

isOperatingContinously

public boolean isOperatingContinously()

Description copied from interface: ContinuouslyScannableViaController

Indicates whether the Scannable has deferred control to the he configured ContinuousMoveController

Specified by:

isOperatingContinously in interface ContinuouslyScannableViaController

Returns:

true if control is defered

getContinuousMoveController

public ContinuousMoveController getContinuousMoveController()

Specified by:

getContinuousMoveController in interface ContinuouslyScannableViaController

setContinuousMoveController

public void setContinuousMoveController(ContinuousMoveController controller)

Specified by:

setContinuousMoveController in interface ContinuouslyScannableViaController

asynchronousMoveTo

public void asynchronousMoveTo(Object position)
                        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 ScannableBase

Parameters:

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

Throws:

DeviceException

getPosition

public Object getPosition()
                   throws DeviceException

Description copied from class: ScannableBase

Returns the current position of the Scannable. Called by ConcurentScan at the end of the point. Reads an internal (hardware) position from rawGetPosition, converts this to an external (user) position and returns it.

Specified by:

getPosition in interface Scannable

Overrides:

getPosition in class ScannableBase

Returns:

Current position with an element for each input and extra field. null if their are no fields.

Throws:

DeviceException