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

Class ScannableMotionUnitsObservableWrapper

java.lang.Object

gda.factory.ConfigurableBase

gda.factory.FindableConfigurableBase

gda.device.DeviceBase

gda.device.scannable.ScannableBase

gda.device.scannable.ScannableMotionBase

gda.device.scannable.ScannableMotionUnitsBase

uk.ac.gda.component.beamline.common.ScannableMotionUnitsObservableWrapper

All Implemented Interfaces:

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

@ServiceInterface(ScannableMotionUnits.class)
public final class ScannableMotionUnitsObservableWrapper
extends ScannableMotionUnitsBase
implements gda.observable.IObserver

Wraps and then delegates many method calls to a ScannableMotionUnits instance. The name, observable, inputNames or extraNames fields are set in the wrapper, and will not be delegated. This class is useful for presenting a user or client with a Scannable that may be switched between more than one underlying Scannable.

Field Summary

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

Method Summary

Modifier and Type	Method	Description
void	a(Object position)	Quick-to-type version of asynchronousMoveTo for use in Jython environment
void	addAcceptableUnit(String newUnit)	Adds a new unit to the list of acceptable units based on the supllied string
void	ar(Object position)	Quick-to-type version of an asynchronous relative move for use in Jython environment
void	asynchronousMoveTo(Object position)	Trigger a move/operation and return immediately.
void	atCommandFailure()	Hook to be used by Scan and pos commands to inform the Scannable that an exception, such as a DeviceExcpetion, has occurred.
void	atLevelMoveStart()	Called by both the pos and scan commands at the start of each subsequent level move only on Scannables that will be moved as part that level's movement.
void	atPointEnd()	Called on every Scannable at the end of every data point, for scans which are broken down into individual points (i.e.
void	atPointStart()	Called on every Scannable at every data point, for scans which are broken down into individual points (i.e.
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	atScanLineEnd()	Called for every Scannable at the end of every scan
void	atScanLineStart()	Called for every Scannable at the start of every scan
void	atScanStart()	Called for every Scannable at the start of a group of nested scans (or a single scan if that is the case)
String	checkPositionValid(Object position)	Checks the position against the Scannable's limits and against any additional position validators added with additionalPositionValidators().
String	checkPositionWithinGdaLimits(Double[] externalPosition)	Returns null if okay, or a descriptive error if not.
String	checkPositionWithinGdaLimits(Object externalPosition)	Returns null if okay, or a descriptive error if not.
void	close()	Close and unconfigure the device.
void	configure()	Default implementation for classes that do not have to do any specific configuration. Classes that do their own configuration should *not* call this superclass function, as it may cause the object to appear configured before it really is.
protected void	configuredStop(ScannableMotionUnits scannable)
protected void	dispose()
String[]	getAcceptableUnits()
Object	getAttribute(String attributeName)	Get the value of the specified attribute
ScannableMotionUnits	getDelegate()
String[]	getExtraNames()	Additional names for extra values that returned by getPosition().
String	getHardwareUnitString()
String[]	getInputNames()	gets a array of InputNames used by moveTo of this scannable.
int	getLevel()	get the operation level of this scannable.
Double[]	getLowerGdaLimits()	Get lower Scannable limits in external representation.
int	getNumberTries()	This is the number of times the Scannable should attempt to move to the target position.
Double[]	getOffset()	Returns offset(s) in amounts of external quantities.
String[]	getOutputFormat()	Returns an array of strings which are the format strings to use when pretty printing parts of the output
Object	getPosition()	Returns the current position of the Scannable.
int	getProtectionLevel()
Double[]	getScalingFactor()	Returns scaling factor(s) as Doubles.
Double[]	getTolerances()	WARNING: This method will not work with units.
Double[]	getUpperGdaLimits()	Get upper Scannable limits in external representation
String	getUserUnits()	Returns a string representation of the current reporting units
boolean	isAt(Object positionToTest)	Tests if the scannable is at (or if appropriate, close to) the value positionToTest.
boolean	isBusy()	Check if the Scannable is moving/operating.
boolean	isConfigureAtStartup()	Indicates whether this object should be configured at startup.
boolean	isConfigured()	Checks to see if the object is already configured.
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	r(Object position)	Quick-to-type version of a relative move for use in Jython environment
void	reconfigure()	Re-initialisation of values and states.
void	setAttribute(String attributeName, Object value)	Set any attribute the implementing classes may provide
void	setDelegate(ScannableMotionUnits delegate)
void	setDelegate(ScannableMotionUnits delegate, boolean doMove)
protected void	setDelegateUpdate()
void	setExtraNames(String[] names)	Sets the array of names returned by getExtraNames of this scannable.
void	setHardwareUnitString(String hardwareUnitString)	Sets the hardware unit to hardwareUnitString.
void	setInputNames(String[] names)	sets the array of names returned by getInputNames method of this scannable.
void	setLevel(int level)	Used for ordering the operations of Scannables during scans
void	setLowerGdaLimits(Double externalLowerLim)	Set lower Scannable limit in external representation.
void	setLowerGdaLimits(Double[] externalLowerLim)	Set lower Scannable limits in external representation.
void	setNumberTries(int numberTries)
void	setOffset(Double... offsetArray)	Set offset(s) in amounts of external quantities.
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	setOutputFormat(String[] names)	Sets the array of strings describing how best to format the positions from this scannable
void	setProtectionLevel(int newLevel)	Sets the permission level for this object.
void	setScalingFactor(Double... scaleArray)	Set scaling factor(s) as Doubles.
void	setTolerance(Double tolerence)
void	setTolerances(Double[] tolerence)	WARNING: This method will not work with units.
void	setUpperGdaLimits(Double externalUpperLim)	Set upper Scannable limit in external representation.
void	setUpperGdaLimits(Double[] externalUpperLim)	Set upper Scannable limits in external representation.
void	setUserUnits(String userUnitsString)	Sets the user unit to userUnitString.
void	stop()	Stop the current move/operation.
String	toFormattedString()	Returns a string representation of the Scannable and its current position/value/status
String	toString()
void	update(Object source, Object arg)
void	waitWhileBusy()	Returns when operation carried out by moveTo has completed
void	waitWhileBusyWithTimeout(int timeoutSeconds)

Methods inherited from class gda.device.scannable.ScannableMotionUnitsBase

externalToInternal, getInitialUserUnits, internalToExternal, setInitialUserUnits

Methods inherited from class gda.device.scannable.ScannableMotionBase

addPositionValidator, completeInstantiation, generateScannableLimitsReport, getAdditionalPositionValidators, getFirstInputLimits, getInputLimits, getInputLimits, getLimitsComponent, rawIsBusy, removePositionValidator, setAdditionalPositionValidators, setLimitsComponent, setOffsetAndScalingComponent, writeNeXusInformation, writeNeXusInformationLimits

Methods inherited from class gda.device.scannable.ScannableBase

__call__, __call__, __doc__, __getitem__, __len__, __repr__, __str__, atLevelEnd, atLevelStart, getScanMetadataAttribute, getScanMetadataAttributeNames, getScanMetadataAttributes, rawAsynchronousMoveTo, rawGetPosition, setScanMetadataAttribute, setScanMetadataAttributes, throwExceptionIfInvalidTarget, validateScannable, valueUnavailableString, waitWhileBusy

Methods inherited from class gda.device.DeviceBase

addIObserver, deleteIObserver, deleteIObservers, getName, isBeingObserved, notifyIObservers, setConfigureAtStartup, setName

Methods inherited from class gda.factory.ConfigurableBase

setConfigured

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

atLevelEnd, atLevelStart, getScanMetadataAttribute, getScanMetadataAttributeNames, getScanMetadataAttributes, setScanMetadataAttribute, setScanMetadataAttributes

Constructor Details

ScannableMotionUnitsObservableWrapper

public ScannableMotionUnitsObservableWrapper()

Method Details

configure

public void configure()
               throws FactoryException

Description copied from class: ConfigurableBase

Default implementation for classes that do not have to do any specific configuration.
Classes that do their own configuration should *not* call this superclass function, as it may cause the object to appear configured before it really is.

Specified by:

configure in interface Configurable

Overrides:

configure in class ConfigurableBase

Throws:

FactoryException - if there is an error in configuration e.g. required variable not set or cannot connect to device

a

public void a(Object position)
       throws DeviceException

Description copied from class: ScannableMotionBase

Quick-to-type version of asynchronousMoveTo for use in Jython environment

Specified by:

a in interface ScannableMotion

Overrides:

a in class ScannableMotionBase

Parameters:

position -

Throws:

DeviceException

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

Overrides:

addAcceptableUnit in class ScannableMotionUnitsBase

Parameters:

newUnit - - string representation of the new acceptable unit

Throws:

DeviceException

ar

public void ar(Object position)
        throws DeviceException

Description copied from class: ScannableMotionBase

Quick-to-type version of an asynchronous relative move for use in Jython environment

Specified by:

ar in interface ScannableMotion

Overrides:

ar in class ScannableMotionBase

Parameters:

position -

Throws:

DeviceException

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 ScannableMotionBase

Parameters:

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

Throws:

DeviceException

atCommandFailure

public void atCommandFailure()
                      throws DeviceException

Description copied from class: ScannableBase

Hook to be used by Scan and pos commands to inform the Scannable that an exception, such as a DeviceExcpetion, has occurred. However not called when the command is aborted using an InterruptionException. If a Scan is aborted then only Scannable.stop() will be called by the Scan or pos command.

Useful for telling Scannables which hold state during a scan for example, to reset themselves. Used for example by CoordinatedMotionScannables. This hook should be used not in the same way as the stop hook. Default behaviour is to do nothing. Inheriting classes have the option to implement this if their specific behaviour requires it.

Specified by:

atCommandFailure in interface Scannable

Overrides:

atCommandFailure in class ScannableBase

Throws:

DeviceException

See Also:

• Scannable.atCommandFailure()

atLevelMoveStart

public void atLevelMoveStart()
                      throws DeviceException

Description copied from class: ScannableBase

Called by both the pos and scan commands at the start of each subsequent level move only on Scannables that will be moved as part that level's movement.

For example "pos a 1 b 2 c 3", will, if a and b have the same level and c a higher level will result in:

 a.atLevelMoveStart()   invalid input: '<'----
 b.atLevelMoveStart()   invalid input: '<'----
 a.asynchronousMoveTo()
 b.asynchronousMoveTo()
 a.waitWhileBusy()
 b.waitWhileBusy()
 c.atLevelMoveStart()   invalid input: '<'----
 c.asynchronousMoveTo()
 c.waitWhileBusy()
 

This hook is used by CoordinatedMotionScannables. Default behaviour is to do nothing. Inheriting classes have the option to implement this if their specific behaviour requires it.

Specified by:

atLevelMoveStart in interface Scannable

Overrides:

atLevelMoveStart in class ScannableBase

Throws:

DeviceException

See Also:

• Scannable.atLevelMoveStart()

atPointEnd

public void atPointEnd()
                throws DeviceException

Description copied from class: ScannableBase

Called on every Scannable at the end of every data point, for scans which are broken down into individual points (i.e. non-continous scans) Default behaviour is to do nothing. Inheriting classes have the option to implement this if their specific behaviour requires it.

Specified by:

atPointEnd in interface Scannable

Overrides:

atPointEnd in class ScannableBase

Throws:

DeviceException

See Also:

• Scannable.atPointEnd()

atPointStart

public void atPointStart()
                  throws DeviceException

Description copied from class: ScannableBase

Called on every Scannable at every data point, for scans which are broken down into individual points (i.e. non-continuous scans) Default behaviour is to do nothing. Inheriting classes have the option to implement this if their specific behaviour requires it.

Specified by:

atPointStart in interface Scannable

Overrides:

atPointStart in class ScannableBase

Throws:

DeviceException

See Also:

• Scannable.atPointStart()

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

atScanLineEnd

public void atScanLineEnd()
                   throws DeviceException

Description copied from class: ScannableBase

Called for every Scannable at the end of every scan Default behaviour is to do nothing. Inheriting classes have the option to implement this if their specific behaviour requires it.

Specified by:

atScanLineEnd in interface Scannable

Overrides:

atScanLineEnd in class ScannableBase

Throws:

DeviceException

See Also:

• Scannable.atScanLineEnd()

atScanLineStart

public void atScanLineStart()
                     throws DeviceException

Description copied from class: ScannableBase

Called for every Scannable at the start of every scan Default behaviour is to do nothing. Inheriting classes have the option to implement this if their specific behaviour requires it.

Specified by:

atScanLineStart in interface Scannable

Overrides:

atScanLineStart in class ScannableBase

Throws:

DeviceException

See Also:

• Scannable.atScanLineStart()

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

checkPositionValid

public String checkPositionValid(Object position)
                          throws DeviceException

Description copied from class: ScannableMotionBase

Checks the position against the Scannable's limits and against any additional position validators added with additionalPositionValidators().

Specified by:

checkPositionValid in interface Scannable

Overrides:

checkPositionValid in class ScannableMotionBase

Parameters:

position -

Returns:

null if position is valid, or returns a description if not.

Throws:

DeviceException

See Also:

• Scannable.checkPositionValid(java.lang.Object)

checkPositionWithinGdaLimits

public String checkPositionWithinGdaLimits(Double[] externalPosition)

Description copied from interface: ScannableMotion

Returns null if okay, or a descriptive error if not. Code only called if limits are set.

Specified by:

checkPositionWithinGdaLimits in interface ScannableMotion

Overrides:

checkPositionWithinGdaLimits in class ScannableMotionBase

Parameters:

externalPosition - position in external representation

Returns:

null if okay, or a descriptive error if not

checkPositionWithinGdaLimits

public String checkPositionWithinGdaLimits(Object externalPosition)

Description copied from interface: ScannableMotion

Returns null if okay, or a descriptive error if not. Code only called if limits are set.

Specified by:

checkPositionWithinGdaLimits in interface ScannableMotion

Overrides:

checkPositionWithinGdaLimits in class ScannableMotionBase

Parameters:

externalPosition - position in external representation

Returns:

null or description of any error

close

public void close()
           throws DeviceException

Description copied from interface: Device

Close and unconfigure the device.

Specified by:

close in interface Device

Overrides:

close in class DeviceBase

Throws:

DeviceException

dispose

protected void dispose()

getAcceptableUnits

public String[] getAcceptableUnits()

Specified by:

getAcceptableUnits in interface ScannableMotionUnits

Overrides:

getAcceptableUnits in class ScannableMotionUnitsBase

Returns:

Returns the acceptableUnitStrings.

getAttribute

public Object getAttribute(String attributeName)
                    throws DeviceException

Description copied from class: ScannableMotionBase

Get the value of the specified attribute To distributed some of the extra methods in the ScannableMotion interface

Specified by:

getAttribute in interface Device

Overrides:

getAttribute in class ScannableMotionUnitsBase

Parameters:

attributeName - is the name of the attribute

Returns:

the value of the attribute as an Object type

Throws:

DeviceException

See Also:

• DeviceBase.getAttribute(java.lang.String)

getDelegate

public ScannableMotionUnits getDelegate()

getExtraNames

public String[] getExtraNames()

Description copied from interface: Scannable

Additional names for extra values that returned by getPosition().

Specified by:

getExtraNames in interface Scannable

Overrides:

getExtraNames in class ScannableBase

Returns:

array of names of the extra elements if the array returned by getPosition is larger than the array required by moveTo

getHardwareUnitString

public String getHardwareUnitString()

Specified by:

getHardwareUnitString in interface ScannableMotionUnits

Overrides:

getHardwareUnitString in class ScannableMotionUnitsBase

Returns:

Returns the motorUnitString.

getInputNames

public String[] getInputNames()

Description copied from interface: Scannable

gets a array of InputNames used by moveTo of this scannable.

Specified by:

getInputNames in interface Scannable

Overrides:

getInputNames in class ScannableBase

Returns:

array of the names of the elements of the object returned by getPosition

getLevel

public int getLevel()

Description copied from interface: Scannable

get the operation level of this scannable.

Specified by:

getLevel in interface Scannable

Overrides:

getLevel in class ScannableBase

Returns:

int - the level

getLowerGdaLimits

public Double[] getLowerGdaLimits()

Description copied from interface: ScannableMotion

Get lower Scannable limits in external representation. Will be null if no lower limits are set. Otherwise, any element can be null indicating that the corresponding field has no limit.

Specified by:

getLowerGdaLimits in interface ScannableMotion

Overrides:

getLowerGdaLimits in class ScannableMotionBase

Returns:

Double[] limit in external representation

getNumberTries

public int getNumberTries()

Description copied from interface: ScannableMotion

This is the number of times the Scannable should attempt to move to the target position. Useful when the underlying hardware is problematic and often fails or ignores calls without throwing an exception. This should be used in conjunction with setting the tolerance attribute.

Specified by:

getNumberTries in interface ScannableMotion

Overrides:

getNumberTries in class ScannableMotionBase

Returns:

the numberTries

See Also:

• ScannableMotion.getNumberTries()

getOffset

public Double[] getOffset()

Description copied from interface: ScannableMotion

Returns offset(s) in amounts of external quantities. May be null, or any element may be null, indicating no offset is to be applied/removed.

Specified by:

getOffset in interface ScannableMotion

Overrides:

getOffset in class ScannableMotionUnitsBase

getOutputFormat

public String[] getOutputFormat()

Description copied from interface: Scannable

Returns an array of strings which are the format strings to use when pretty printing parts of the output

Specified by:

getOutputFormat in interface Scannable

Overrides:

getOutputFormat in class ScannableBase

Returns:

string array

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

getProtectionLevel

public int getProtectionLevel()

Specified by:

getProtectionLevel in interface Device

Overrides:

getProtectionLevel in class DeviceBase

Returns:

int - the permission level for this object.

getScalingFactor

public Double[] getScalingFactor()

Description copied from interface: ScannableMotion

Returns scaling factor(s) as Doubles. May be null, or any element may be null, indicating no scale is to be applied/removed.

Specified by:

getScalingFactor in interface ScannableMotion

Overrides:

getScalingFactor in class ScannableMotionBase

getTolerances

public Double[] getTolerances()
                       throws DeviceException

Description copied from class: ScannableMotionBase

WARNING: This method will not work with units.

Specified by:

getTolerances in interface ScannableMotion

Overrides:

getTolerances in class ScannableMotionBase

Returns:

double[]

Throws:

DeviceException

See Also:

• ScannableMotion.getTolerances()

getUpperGdaLimits

public Double[] getUpperGdaLimits()

Description copied from interface: ScannableMotion

Get upper Scannable limits in external representation

Specified by:

getUpperGdaLimits in interface ScannableMotion

Overrides:

getUpperGdaLimits in class ScannableMotionBase

Returns:

Double[] limit in external representation

getUserUnits

public String getUserUnits()

Description copied from interface: ScannableMotionUnits

Returns a string representation of the current reporting units

Specified by:

getUserUnits in interface ScannableMotionUnits

Overrides:

getUserUnits in class ScannableMotionUnitsBase

Returns:

Returns the reportingUnitsString.

isAt

public boolean isAt(Object positionToTest)
             throws DeviceException

Description copied from class: ScannableMotionBase

Tests if the scannable is at (or if appropriate, close to) the value positionToTest. If positionToTest is a string (as will be the case for valves or pneumatics for example), this is compared to the value obtained from getPosition(). An exception is thrown if this is not also a string.

Otherwise if positionToTest is not a string the object is compared to the value from getPosition(), after having first pushed both values through objectToArray() from ScannableUtils.

This behaviour should be extended where possible, and has been in ScannableMotionBase If positionToTest is a string (as will be the case for valves or pneumatics for example), this is compared to the value obtained from getPosition(). An exception is thrown if this is not also a string.

Otherwise if positionToTest is not a string the object is compared to the value from getPosition() to see if they are within the tolerance specified in the scannable's tolerance array. Both values are first converted to arrays using objectToArray() from ScannableUtils.

Specified by:

isAt in interface Scannable

Overrides:

isAt in class ScannableMotionUnitsBase

Parameters:

positionToTest - The position to compare the scannable's position to.

Returns:

true if scannable is at positionToTest

Throws:

DeviceException

See Also:

• Scannable.isAt(java.lang.Object)

isBusy

public boolean isBusy()
               throws DeviceException

Description copied from class: ScannableMotionBase

Check if the Scannable is moving/operating.. Calls onto rawIsBusy for historical reasons, although there is currently no need for this.

Specified by:

isBusy in interface Scannable

Overrides:

isBusy in class ScannableMotionBase

Returns:

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

Throws:

DeviceException

See Also:

• Scannable.isBusy()

isConfigureAtStartup

public boolean isConfigureAtStartup()

Description copied from interface: Configurable

Indicates whether this object should be configured at startup.

Moved from ConditionallyConfigurable which has been deleted

Specified by:

isConfigureAtStartup in interface Configurable

Overrides:

isConfigureAtStartup in class DeviceBase

isConfigured

public boolean isConfigured()

Description copied from interface: Configurable

Checks to see if the object is already configured.

Specified by:

isConfigured in interface Configurable

Overrides:

isConfigured in class ConfigurableBase

Returns:

return true if configured false otherwise

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)

r

public void r(Object position)
       throws DeviceException

Description copied from class: ScannableMotionBase

Quick-to-type version of a relative move for use in Jython environment

Specified by:

r in interface ScannableMotion

Overrides:

r in class ScannableMotionBase

Parameters:

position -

Throws:

DeviceException

reconfigure

public void reconfigure()
                 throws FactoryException

Description copied from interface: Configurable

Re-initialisation of values and states.

Moved from Reconfigurable which has been deleted

Specified by:

reconfigure in interface Configurable

Overrides:

reconfigure in class ConfigurableBase

Throws:

FactoryException

setAttribute

public void setAttribute(String attributeName,
 Object value)
                  throws DeviceException

Description copied from interface: Device

Set any attribute the implementing classes may provide

Specified by:

setAttribute in interface Device

Overrides:

setAttribute in class DeviceBase

Parameters:

attributeName - is the name of the attribute

value - is the value of the attribute

Throws:

DeviceException - if an attribute cannot be set

configuredStop

protected void configuredStop(ScannableMotionUnits scannable)
                       throws DeviceException

Throws:

DeviceException

setDelegate

public void setDelegate(ScannableMotionUnits delegate)
                 throws DeviceException

Throws:

DeviceException

setDelegate

public void setDelegate(ScannableMotionUnits delegate,
 boolean doMove)
                 throws DeviceException

Throws:

DeviceException

setDelegateUpdate

protected void setDelegateUpdate()
                          throws DeviceException

Throws:

DeviceException

waitWhileBusyWithTimeout

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

Throws:

DeviceException

InterruptedException

TimeoutException

setExtraNames

public void setExtraNames(String[] names)

Description copied from interface: Scannable

Sets the array of names returned by getExtraNames of this scannable.

Specified by:

setExtraNames in interface Scannable

Overrides:

setExtraNames in class ScannableBase

Parameters:

names -

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

Overrides:

setHardwareUnitString in class ScannableMotionUnitsBase

Parameters:

hardwareUnitString - The motorUnitString to set.

Throws:

DeviceException

setInputNames

public void setInputNames(String[] names)

Description copied from interface: Scannable

sets the array of names returned by getInputNames method of this scannable.

Specified by:

setInputNames in interface Scannable

Overrides:

setInputNames in class ScannableBase

Parameters:

names -

setLevel

public void setLevel(int level)

Description copied from interface: Scannable

Used for ordering the operations of Scannables during scans

Specified by:

setLevel in interface Scannable

Overrides:

setLevel in class ScannableBase

Parameters:

level -

setLowerGdaLimits

public void setLowerGdaLimits(Double externalLowerLim)
                       throws Exception

Description copied from interface: ScannableMotion

Set lower Scannable limit in external representation. Setting the input null will remove the lower limit from the Scannable.

Specified by:

setLowerGdaLimits in interface ScannableMotion

Overrides:

setLowerGdaLimits in class ScannableMotionBase

Parameters:

externalLowerLim - limit in external representation

Throws:

Exception

setLowerGdaLimits

public void setLowerGdaLimits(Double[] externalLowerLim)
                       throws Exception

Description copied from interface: ScannableMotion

Set lower Scannable limits in external representation. Setting the input null will remove lower limits from the Scannable. Otherwise, any element can be null indicating that the corresponding field has no limit.

Specified by:

setLowerGdaLimits in interface ScannableMotion

Overrides:

setLowerGdaLimits in class ScannableMotionBase

Parameters:

externalLowerLim - limit in external representation

Throws:

Exception

setNumberTries

public void setNumberTries(int numberTries)

Specified by:

setNumberTries in interface ScannableMotion

Overrides:

setNumberTries in class ScannableMotionBase

Parameters:

numberTries - the numberTries to set

See Also:

• ScannableMotion.setNumberTries(int)

setOffset

public void setOffset(Double... offsetArray)

Description copied from interface: ScannableMotion

Set offset(s) in amounts of external quantities. May be null, or any element may be null, indicating no offset is to be applied/removed.

Specified by:

setOffset in interface ScannableMotion

Overrides:

setOffset in class ScannableMotionUnitsBase

Parameters:

offsetArray - must match number of input fields.

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

Overrides:

setOffset in class ScannableMotionUnitsBase

Parameters:

offsetPositionInExternalUnits -

setOutputFormat

public void setOutputFormat(String[] names)

Description copied from interface: Scannable

Sets the array of strings describing how best to format the positions from this scannable

Specified by:

setOutputFormat in interface Scannable

Overrides:

setOutputFormat in class ScannableBase

Parameters:

names -

setProtectionLevel

public void setProtectionLevel(int newLevel)

Description copied from interface: Device

Sets the permission level for this object. If this is not set then a default value will be applied.

Specified by:

setProtectionLevel in interface Device

Overrides:

setProtectionLevel in class DeviceBase

Parameters:

newLevel -

setScalingFactor

public void setScalingFactor(Double... scaleArray)

Description copied from interface: ScannableMotion

Set scaling factor(s) as Doubles. May be null, or any element may be null, indicating no scale is to be applied/removed.

Specified by:

setScalingFactor in interface ScannableMotion

Overrides:

setScalingFactor in class ScannableMotionBase

Parameters:

scaleArray - must match number of input fields.

setTolerance

public void setTolerance(Double tolerence)
                  throws DeviceException

Specified by:

setTolerance in interface ScannableMotion

Overrides:

setTolerance in class ScannableMotionBase

Parameters:

tolerence -

Throws:

DeviceException

See Also:

• ScannableMotion.setTolerance(Double)

setTolerances

public void setTolerances(Double[] tolerence)
                   throws DeviceException

Description copied from class: ScannableMotionBase

WARNING: This method will not work with units.

Specified by:

setTolerances in interface ScannableMotion

Overrides:

setTolerances in class ScannableMotionBase

Parameters:

tolerence -

Throws:

DeviceException

setUpperGdaLimits

public void setUpperGdaLimits(Double externalUpperLim)
                       throws Exception

Description copied from interface: ScannableMotion

Set upper Scannable limit in external representation. Setting the input null will remove the upper limit from the Scannable.

Specified by:

setUpperGdaLimits in interface ScannableMotion

Overrides:

setUpperGdaLimits in class ScannableMotionBase

Parameters:

externalUpperLim - limit in external representation

Throws:

Exception

setUpperGdaLimits

public void setUpperGdaLimits(Double[] externalUpperLim)
                       throws Exception

Description copied from interface: ScannableMotion

Set upper Scannable limits in external representation. Setting the input null will remove upper limits from the Scannable. Otherwise, any element can be null indicating that the corresponding field has no limit.

Specified by:

setUpperGdaLimits in interface ScannableMotion

Overrides:

setUpperGdaLimits in class ScannableMotionBase

Parameters:

externalUpperLim - limit in external representation

Throws:

Exception

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

Overrides:

setUserUnits in class ScannableMotionUnitsBase

Parameters:

userUnitsString - The reportingUnitsString to set.

Throws:

DeviceException - if string not found in list of acceptable units

stop

public void stop()
          throws DeviceException

Description copied from class: ScannableBase

Stop the current move/operation. Default behaviour is to do nothing. Inheriting classes have the option to implement this if their specific behaviour requires it.

Specified by:

stop in interface Scannable

Overrides:

stop in class ScannableBase

Throws:

DeviceException

See Also:

• Scannable.stop()

toFormattedString

public String toFormattedString()

Description copied from interface: Scannable

Returns a string representation of the Scannable and its current position/value/status

Typically should return:

name : position

or for detectors, name : status

If the position/status cannot be determined, the function should return Scannable.VALUE_UNAVAILABLE in its place.

Specified by:

toFormattedString in interface Scannable

Overrides:

toFormattedString in class ScannableMotionUnitsBase

Returns:

string as defined above

toString

public String toString()

Overrides:

toString in class ScannableBase

update

public void update(Object source,
 Object arg)

Specified by:

update in interface gda.observable.IObserver

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 ScannableBase

Throws:

DeviceException

InterruptedException