Package gda.device.scannable

Class DummyPersistentEnumScannable

java.lang.Object

gda.factory.ConfigurableBase

gda.factory.FindableConfigurableBase

gda.device.DeviceBase

gda.device.scannable.ScannableBase

gda.device.scannable.DummyPersistentEnumScannable

All Implemented Interfaces:

Device, EditableEnumPositioner, EnumPositioner, Scannable, Configurable, Findable, gda.observable.IObservable

@ServiceInterface(EnumPositioner.class)
public class DummyPersistentEnumScannable
extends ScannableBase
implements EditableEnumPositioner

Accepts and returns a String from a list of Strings.

If given integer, uses the index from the list of acceptable Strings

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

Method Summary

Modifier and Type	Method	Description
String[]	getPositions()	Returns an array of the positions which this device can be moved to.
List<String>	getPositionsList()	Returns a list of the positions which this device can be moved to.
EnumPositionerStatus	getStatus()	Returns the current status
boolean	isBusy()	Check if the Scannable is moving/operating.
boolean	isInPos()	Reports whether the positioner is in the most recent demand position
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	setPositions(String[] positions)	Sets the positions of this positioner.
void	setPositions(Collection<String> positions)	Sets the positions from a collection

Methods inherited from class gda.device.scannable.ScannableBase

__call__, __call__, __doc__, __getitem__, __len__, __repr__, __str__, asynchronousMoveTo, atCommandFailure, atLevelEnd, atLevelMoveStart, atLevelStart, atPointEnd, atPointStart, atScanEnd, atScanLineEnd, atScanLineStart, atScanStart, checkPositionValid, externalToInternal, getExtraNames, getInputNames, getLevel, getOutputFormat, getPosition, getScanMetadataAttribute, getScanMetadataAttributeNames, getScanMetadataAttributes, internalToExternal, isAt, moveTo, 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

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

Constructor Details

DummyPersistentEnumScannable

public DummyPersistentEnumScannable()

Constructor

Method Details

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

rawAsynchronousMoveTo

public void rawAsynchronousMoveTo(Object position)
                           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:

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

Throws:

DeviceException

See Also:

• asynchronousMoveTo

isBusy

public boolean isBusy()

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

getPositions

public String[] getPositions()
                      throws DeviceException

Description copied from interface: EnumPositioner

Returns an array of the positions which this device can be moved to.

Specified by:

getPositions in interface EnumPositioner

Returns:

an array of positions

Throws:

DeviceException

getPositionsList

public List<String> getPositionsList()
                              throws DeviceException

Description copied from interface: EnumPositioner

Returns a list of the positions which this device can be moved to.

Specified by:

getPositionsList in interface EnumPositioner

Returns:

a list of positions

Throws:

DeviceException

setPositions

public void setPositions(String[] positions)

Description copied from interface: EditableEnumPositioner

Sets the positions of this positioner.

Specified by:

setPositions in interface EditableEnumPositioner

Parameters:

positions - the positions

setPositions

public void setPositions(Collection<String> positions)

Description copied from interface: EditableEnumPositioner

Sets the positions from a collection

Specified by:

setPositions in interface EditableEnumPositioner

Parameters:

positions - the positions

getStatus

public EnumPositionerStatus getStatus()
                               throws DeviceException

Description copied from interface: EnumPositioner

Returns the current status

Specified by:

getStatus in interface EnumPositioner

Returns:

the status

Throws:

DeviceException

isInPos

public boolean isInPos()
                throws DeviceException

Description copied from interface: EnumPositioner

Reports whether the positioner is in the most recent demand position

Specified by:

isInPos in interface EnumPositioner

Throws:

DeviceException