Package gda.device

Interface EnumPositioner

All Superinterfaces:

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

All Known Subinterfaces:

AperturePositioner, EditableEnumPositioner, NamedEnumPositioner

All Known Implementing Classes:

AlignmentStageScannable, CamZoomPositioner, DummyEnumPositioner, DummyNamedEnumPositioner, DummyPersistentEnumScannable, DummyPersistentNamedEnumPositioner, DummyQbpm, DummyValve, EditableEnumPositionerBase, EnumPositionerBase, EpicsAirBearingControl, EpicsCurrAmpQuadController, EpicsEditablePositionerCallback, EpicsEnumPositioner, EpicsLimitBasedPositioner, EpicsLocum4Controller, EpicsPneumaticCallback, EpicsPositioner, EpicsPositionerCallback, EpicsQbpm, EpicsSimpleBinary, EpicsSimpleMbbinary, EpicsSimplePneumatic, EpicsSimplePositioner, EpicsValve, EpicsValveCallback, I19BeamlineHealthScannable, IntegerMapperBasedEnumPositioner, JythonEnumPositionerWrapper, MapperBasedEnumPositionerBase, ME2Positioner, NameMappedEpicsPneumaticCallback, PersistentAperturePositioner, PersistentEpicsAperturePositioner, SamplePlateEnumPositioner, StringMapperBasedEnumPositioner, TfgChannelEnum, ZebraShutterPositioner

public interface EnumPositioner
extends Scannable

Interface for devices which have an enumerated set of positions, for example a valve which can be open or closed.

Field Summary

Fields inherited from interface gda.device.Scannable

ATTR_NEXUS_CATEGORY, ATTR_NX_CLASS, DEFAULT_INPUT_NAME, VALUE_UNAVAILABLE

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	isInPos()	Reports whether the positioner is in the most recent demand position

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, isBusy, moveTo, setExtraNames, setInputNames, setLevel, setOutputFormat, setScanMetadataAttribute, setScanMetadataAttributes, stop, toFormattedString, waitWhileBusy

Method Details

getPositions

String[] getPositions()
               throws DeviceException

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

Returns:

an array of positions

Throws:

DeviceException

getPositionsList

List<String> getPositionsList()
                       throws DeviceException

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

Returns:

a list of positions

Throws:

DeviceException

getStatus

EnumPositionerStatus getStatus()
                        throws DeviceException

Returns the current status

Returns:

the status

Throws:

DeviceException

isInPos

boolean isInPos()
         throws DeviceException

Reports whether the positioner is in the most recent demand position

Throws:

DeviceException