Package gda.device.enumpositioner

Class DummyEnumPositioner

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

All Implemented Interfaces:

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

Direct Known Subclasses:

DummyNamedEnumPositioner, DummyQbpm, I19BeamlineHealthScannable, PersistentAperturePositioner

@ServiceInterface(EnumPositioner.class)
public class DummyEnumPositioner
extends EditableEnumPositionerBase

A dummy class implementing the EnumPositioner for testing.

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

Method Summary

Modifier and Type	Method	Description
void	addPosition(String position)	Add a possible position to the list of positions.
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.
EnumPositionerStatus	getStatus()	Returns the current status
long	getTimeToMove()
boolean	isInPos()	Simple implementation that may not be reliable. Devices with a PV that indicates whether the device is in position should use this instead.
boolean	isPosChangeEventFlag()
void	moveTo(Object position)	Trigger a move/operation and block until completion.
void	rawAsynchronousMoveTo(Object position)	[Consider abstract] Trigger a move/operation to an internal/hardware position and return immediately.
void	setPosChangeEventFlag(boolean posChangeEventFlag)
void	setPosition(String position)
void	setTimeToMove(long timeToMove)
void	stop()	Stop the current move/operation.

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

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, toFormattedString, waitWhileBusy

Constructor Details

DummyEnumPositioner

public DummyEnumPositioner()

Method Details

isPosChangeEventFlag

public boolean isPosChangeEventFlag()

setPosChangeEventFlag

public void setPosChangeEventFlag(boolean posChangeEventFlag)

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

addPosition

public void addPosition(String position)

Add a possible position to the list of positions.

Overrides:

addPosition in class EnumPositionerBase

Parameters:

position -

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

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 ScannableBase

Returns:

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

Throws:

DeviceException

getStatus

public EnumPositionerStatus getStatus()
                               throws DeviceException

Description copied from interface: EnumPositioner

Returns the current status

Specified by:

getStatus in interface EnumPositioner

Overrides:

getStatus in class EnumPositionerBase

Returns:

the status

Throws:

DeviceException

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

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 ScannableBase

Parameters:

position -

Throws:

DeviceException

isInPos

public boolean isInPos()
                throws DeviceException

Description copied from class: EnumPositionerBase

Simple implementation that may not be reliable.
Devices with a PV that indicates whether the device is in position should use this instead.

Specified by:

isInPos in interface EnumPositioner

Overrides:

isInPos in class EnumPositionerBase

Throws:

DeviceException

setPosition

public void setPosition(String position)
                 throws DeviceException

Throws:

DeviceException

setTimeToMove

public void setTimeToMove(long timeToMove)

getTimeToMove

public long getTimeToMove()