Package gda.device.scannable

Class DummyPersistentUnitsScannable

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

gda.device.scannable.DummyPersistentUnitsScannable

All Implemented Interfaces:

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

@ServiceInterface(ScannableMotionUnits.class)
public class DummyPersistentUnitsScannable
extends DummyPersistentScannable
implements ScannableMotionUnits

Field Summary

Fields inherited from class gda.device.scannable.DummyPersistentScannable

configuration

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

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
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.
String[]	getAcceptableUnits()
Object	getAttribute(String attributeName)	Get the value of the specified attribute
String	getHardwareUnitString()
String	getUserUnits()	Returns a string representation of the current reporting units
void	rawAsynchronousMoveTo(Object position)	[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	setHardwareUnitString(String hardwareUnitString)	Sets the hardware unit to hardwareUnitString.
void	setInitialUnit(String initialUnit)
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	setUserUnits(String userUnitsString)	Sets the user unit to userUnitString.

Methods inherited from class gda.device.scannable.DummyScannable

getControllerRecordName, getPosition, isBusy, setControllerRecordName, setIncrement, setName

Methods inherited from class gda.device.scannable.ScannableMotionBase

a, addPositionValidator, ar, asynchronousMoveTo, checkPositionValid, checkPositionWithinGdaLimits, checkPositionWithinGdaLimits, completeInstantiation, externalToInternal, generateScannableLimitsReport, getAdditionalPositionValidators, 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

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

isConfigureAtStartup, isConfigured, reconfigure

Methods inherited from interface gda.device.Device

close, 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

DummyPersistentUnitsScannable

public DummyPersistentUnitsScannable()

Method Details

setInitialUnit

public void setInitialUnit(String initialUnit)

configure

public void configure()

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

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

getAcceptableUnits

public String[] getAcceptableUnits()

Specified by:

getAcceptableUnits in interface ScannableMotionUnits

Returns:

Returns the acceptableUnitStrings.

getHardwareUnitString

public String getHardwareUnitString()

Specified by:

getHardwareUnitString in interface ScannableMotionUnits

Returns:

Returns the motorUnitString.

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.

setHardwareUnitString

public void setHardwareUnitString(String hardwareUnitString)

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.

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

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 ScannableMotionBase

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)

rawAsynchronousMoveTo

public void rawAsynchronousMoveTo(Object position)

Description copied from class: ScannableBase

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

Overrides:

rawAsynchronousMoveTo in class DummyPersistentScannable

Parameters:

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

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 DummyPersistentScannable

Returns:

the value represented by this Scannable

Throws:

DeviceException

See Also:

• Scannable.getPosition()

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 -