Package gda.device.scannable.scannablegroup

Class ScannableMotionWithScannableFieldsBase.ScannableField

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.scannablegroup.ScannableMotionWithScannableFieldsBase.ScannableField

All Implemented Interfaces:

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

Enclosing class:

ScannableMotionWithScannableFieldsBase

public class ScannableMotionWithScannableFieldsBase.ScannableField
extends ScannableMotionUnitsBase
implements ContinuouslyScannableViaController

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
ScannableField(String fieldName, ScannableMotionWithScannableFieldsBase parent, boolean isInputField, int index)

Method Summary

Modifier and Type	Method	Description
void	asynchronousMoveTo(Object position)	If the parent is targeting calls parent.setElementTarget(), otherwise triggers the move.
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)
void	close()	Close and unconfigure the device.
ContinuousMoveController	getContinuousMoveController()
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
gda.device.scannable.scannablegroup.ICoordinatedParent	getParent()
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
boolean	isBusy()	Check if the Scannable is moving/operating.
boolean	isInputField()
boolean	isOperatingContinously()	Indicates whether the Scannable has deferred control to the he configured ContinuousMoveController
void	rawAsynchronousMoveTo(Object internalPosition)	[Consider abstract] Trigger a move/operation to an internal/hardware position and return immediately.
Object	rawGetPosition()	[Consider abstract] Read the position in its internal (user) representation.
void	setContinuousMoveController(ContinuousMoveController controller)
void	setLevel(int level)	Used for ordering the operations of Scannables during scans
void	setLowerGdaLimits(Double lowerLim)	Set lower Scannable limit in external representation.
void	setLowerGdaLimits(Double[] lowerLim)	Set lower Scannable limits in external representation.
void	setNumberTries(int numberTries)
void	setOffset(Double... offsetArray)	Set offset(s) in amounts of external quantities.
void	setOperatingContinuously(boolean b)	Enable or disable control through the configured ContinuousMoveController
void	setOutputFormat(String[] formats)	Sets the array of strings describing how best to format the positions from this scannable
void	setParent(gda.device.scannable.scannablegroup.ICoordinatedParent parent)
void	setProtectionLevel(int permissionLevel)	Sets the permission level for this object.
void	setScalingFactor(Double... scaleArray)	Set scaling factor(s) as Doubles.
void	setTolerance(Double tolerance)
void	setTolerances(Double[] tolerance)	WARNING: This method will not work with units.
void	setUpperGdaLimits(Double upperLim)	Set upper Scannable limit in external representation.
void	setUpperGdaLimits(Double[] upperLim)	Set upper Scannable limits in external representation.
void	stop()	Stop the current move/operation.
void	waitWhileBusy()	Returns when operation carried out by moveTo has completed

Methods inherited from class gda.device.scannable.ScannableMotionUnitsBase

addAcceptableUnit, externalToInternal, getAcceptableUnits, getAttribute, getHardwareUnitString, getInitialUserUnits, getUserUnits, internalToExternal, isAt, setHardwareUnitString, setInitialUserUnits, setOffset, setUserUnits, toFormattedString

Methods inherited from class gda.device.scannable.ScannableMotionBase

a, addPositionValidator, ar, asynchronousMoveTo, checkPositionValid, checkPositionWithinGdaLimits, checkPositionWithinGdaLimits, completeInstantiation, generateScannableLimitsReport, getAdditionalPositionValidators, getFirstInputLimits, getInputLimits, getInputLimits, getLimitsComponent, moveTo, r, rawIsBusy, removePositionValidator, setAdditionalPositionValidators, setLimitsComponent, setOffsetAndScalingComponent, writeNeXusInformation, writeNeXusInformationLimits

Methods inherited from class gda.device.scannable.ScannableBase

__call__, __call__, __doc__, __getitem__, __len__, __repr__, __str__, atLevelEnd, atLevelStart, getExtraNames, getInputNames, getPosition, getScanMetadataAttribute, getScanMetadataAttributeNames, getScanMetadataAttributes, setExtraNames, setInputNames, setScanMetadataAttribute, setScanMetadataAttributes, throwExceptionIfInvalidTarget, toString, validateScannable, valueUnavailableString, waitWhileBusy

Methods inherited from class gda.device.DeviceBase

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

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

getAttribute, setAttribute

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, checkPositionValid, getExtraNames, getInputNames, getPosition, getScanMetadataAttribute, getScanMetadataAttributeNames, getScanMetadataAttributes, isAt, moveTo, setExtraNames, setInputNames, setScanMetadataAttribute, setScanMetadataAttributes, toFormattedString

Methods inherited from interface gda.device.ScannableMotion

a, ar, checkPositionWithinGdaLimits, checkPositionWithinGdaLimits, r

Constructor Details

ScannableField

public ScannableField(String fieldName,
 ScannableMotionWithScannableFieldsBase parent,
 boolean isInputField,
 int index)

Parameters:

fieldName -

parent -

isInputField -

index -

Method Details

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

rawAsynchronousMoveTo

public void rawAsynchronousMoveTo(Object internalPosition)
                           throws DeviceException

Description copied from class: ScannableBase

[Consider abstract] Trigger a move/operation to an internal/hardware position and return immediately.

Overrides:

rawAsynchronousMoveTo in class ScannableBase

Parameters:

internalPosition - Position in its internal/hardware representation. e.g. with units and offsets removed

Throws:

DeviceException

See Also:

• asynchronousMoveTo

rawGetPosition

public Object rawGetPosition()
                      throws DeviceException

Description copied from class: ScannableBase

[Consider abstract] Read the position in its internal (user) representation.

Overrides:

rawGetPosition in class ScannableBase

Returns:

the value represented by this Scannable

Throws:

DeviceException

See Also:

• Scannable.getPosition()

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

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

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

getParent

public gda.device.scannable.scannablegroup.ICoordinatedParent getParent()

isInputField

public boolean isInputField()

setParent

public void setParent(gda.device.scannable.scannablegroup.ICoordinatedParent parent)

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

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

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

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

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

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

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

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

getProtectionLevel

public int getProtectionLevel()

Specified by:

getProtectionLevel in interface Device

Overrides:

getProtectionLevel in class DeviceBase

Returns:

int - the permission level for this object.

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

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

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

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 -

setTolerance

public void setTolerance(Double tolerance)
                  throws DeviceException

Specified by:

setTolerance in interface ScannableMotion

Overrides:

setTolerance in class ScannableMotionBase

Parameters:

tolerance -

Throws:

DeviceException

See Also:

• ScannableMotion.setTolerance(Double)

setTolerances

public void setTolerances(Double[] tolerance)
                   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:

tolerance -

Throws:

DeviceException

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.

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.

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

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

setLowerGdaLimits

public void setLowerGdaLimits(Double lowerLim)
                       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:

lowerLim - limit in external representation

Throws:

Exception

setUpperGdaLimits

public void setUpperGdaLimits(Double upperLim)
                       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:

upperLim - limit in external representation

Throws:

Exception

setLowerGdaLimits

public void setLowerGdaLimits(Double[] lowerLim)
                       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:

lowerLim - limit in external representation

Throws:

Exception

setUpperGdaLimits

public void setUpperGdaLimits(Double[] upperLim)
                       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:

upperLim - limit in external representation

Throws:

Exception

setOutputFormat

public void setOutputFormat(String[] formats)

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:

formats -

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)

setProtectionLevel

public void setProtectionLevel(int permissionLevel)

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:

permissionLevel -

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

getContinuousMoveController

public ContinuousMoveController getContinuousMoveController()

Specified by:

getContinuousMoveController in interface ContinuouslyScannableViaController

setContinuousMoveController

public void setContinuousMoveController(ContinuousMoveController controller)

Specified by:

setContinuousMoveController in interface ContinuouslyScannableViaController

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

setOperatingContinuously

public void setOperatingContinuously(boolean b)

Description copied from interface: ContinuouslyScannableViaController

Enable or disable control through the configured ContinuousMoveController

Specified by:

setOperatingContinuously in interface ContinuouslyScannableViaController

Parameters:

b -

asynchronousMoveTo

void asynchronousMoveTo(Object position)
                 throws DeviceException

If the parent is targeting calls parent.setElementTarget(), otherwise triggers the move.

Specified by:

asynchronousMoveTo in interface Scannable

Parameters:

position -

Throws:

DeviceException - if move threw one, or if this is an input field.