Package gda.device.enumpositioner

Class DummyNamedEnumPositioner

java.lang.Object

gda.factory.ConfigurableBase

gda.factory.FindableConfigurableBase

gda.device.DeviceBase

gda.device.scannable.ScannableBase

gda.device.enumpositioner.EnumPositionerBase

gda.device.enumpositioner.EditableEnumPositionerBase

gda.device.enumpositioner.DummyEnumPositioner

gda.device.enumpositioner.DummyNamedEnumPositioner

All Implemented Interfaces:

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

Direct Known Subclasses:

DummyPersistentNamedEnumPositioner

@ServiceInterface(NamedEnumPositioner.class)
public class DummyNamedEnumPositioner
extends DummyEnumPositioner
implements NamedEnumPositioner

Be able to move to a position whose name is not necessarily the position name

Field Summary

Fields

Modifier and Type	Field	Description
protected HashMap<String,Object>	positionsMap

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

Method Summary

Modifier and Type	Method	Description
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	getPosition()	Returns the current position of the Scannable.
String	getPositionName()
List<String>	getPositionNamesList()
List<String>	getPositionsList()	Returns a list of the positions which this device can be moved to.
Object	getPositionValue()
void	moveTo(Object position)	Trigger a move/operation and block until completion.
void	setStartPositionName(String positionName)
void	setValues(Map<String,Object> values)

Methods inherited from class gda.device.enumpositioner.DummyEnumPositioner

addPosition, getStatus, getTimeToMove, isInPos, isPosChangeEventFlag, rawAsynchronousMoveTo, setPosChangeEventFlag, setPosition, setTimeToMove, stop

Methods inherited from class gda.device.enumpositioner.EditableEnumPositionerBase

setPositions, setPositions

Methods inherited from class gda.device.enumpositioner.EnumPositionerBase

addPositions, checkPositionValid, clearPositions, containsPosition, createFormattedListAcceptablePositions, getNumberOfPositions, getPosition, getPositionerStatus, getPositionIndex, getPositions, isBusy, setPositionerStatus, setPositionsInternal, toFormattedString

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, externalToInternal, getExtraNames, getInputNames, getLevel, getOutputFormat, getScanMetadataAttribute, getScanMetadataAttributeNames, getScanMetadataAttributes, internalToExternal, isAt, rawGetPosition, setExtraNames, setInputNames, setLevel, setOutputFormat, setScanMetadataAttribute, setScanMetadataAttributes, throwExceptionIfInvalidTarget, 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

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, getAttribute, getProtectionLevel, setAttribute, setProtectionLevel

Methods inherited from interface gda.device.EnumPositioner

getPositions, getStatus, isInPos

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, getScanMetadataAttribute, getScanMetadataAttributeNames, getScanMetadataAttributes, isAt, isBusy, setExtraNames, setInputNames, setLevel, setOutputFormat, setScanMetadataAttribute, setScanMetadataAttributes, stop, toFormattedString, waitWhileBusy

Field Details

positionsMap

protected HashMap<String,Object> positionsMap

Constructor Details

DummyNamedEnumPositioner

public DummyNamedEnumPositioner()

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 DummyEnumPositioner

Throws:

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

getPositionNamesList

public List<String> getPositionNamesList()

getPositionsList

public List<String> getPositionsList()

Description copied from interface: EnumPositioner

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

Specified by:

getPositionsList in interface EnumPositioner

Overrides:

getPositionsList in class EnumPositionerBase

Returns:

a list of positions

setValues

public void setValues(Map<String,Object> values)

setStartPositionName

public void setStartPositionName(String positionName)

getPosition

public String 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 DummyEnumPositioner

Returns:

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

Throws:

DeviceException

moveTo

public void moveTo(Object position)
            throws DeviceException

Description copied from class: ScannableBase

Trigger a move/operation and block until completion. If this is overridden, asynchronousMoveTo must also be valid, and the externalToInternal conversion must be applied.

Specified by:

moveTo in interface Scannable

Overrides:

moveTo in class DummyEnumPositioner

Parameters:

position -

Throws:

DeviceException

getPositionName

public String getPositionName()

Specified by:

getPositionName in interface NamedEnumPositioner

getPositionValue

public Object getPositionValue()
                        throws DeviceException

Specified by:

getPositionValue in interface NamedEnumPositioner

Throws:

DeviceException