Package gda.px

Class PersistentAperturePositioner

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.px.PersistentAperturePositioner

All Implemented Interfaces:

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

@ServiceInterface(AperturePositioner.class)
public class PersistentAperturePositioner
extends DummyEnumPositioner
implements AperturePositioner

Positioner whose positions correspond to the codes of each available aperture.

The positioner's positions are the codes of the available apertures. moveTo(Object) must be called with an aperture's code, and DummyEnumPositioner.getPosition() returns an aperture code.

If the positioner's position is changed, an ApertureChangedEvent is sent as an event to observers.

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

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	getApertureCode()	Gets the currently selected aperture's code.
void	moveTo(Object position)	Trigger a move/operation and block until completion.
void	setApertureCode(String code)	Sets the currently selected aperture.
void	setPositions(String[] positions)	Sets the positions of this positioner.

Methods inherited from class gda.device.enumpositioner.DummyEnumPositioner

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

Methods inherited from class gda.device.enumpositioner.EditableEnumPositionerBase

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

Constructor Details

PersistentAperturePositioner

public PersistentAperturePositioner()

Method Details

setPositions

public void setPositions(String[] positions)

Description copied from interface: EditableEnumPositioner

Sets the positions of this positioner.

Specified by:

setPositions in interface EditableEnumPositioner

Overrides:

setPositions in class EditableEnumPositionerBase

Parameters:

positions - the positions

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

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

setApertureCode

public void setApertureCode(String code)

Description copied from interface: AperturePositioner

Sets the currently selected aperture.

Specified by:

setApertureCode in interface AperturePositioner

getApertureCode

public String getApertureCode()

Description copied from interface: AperturePositioner

Gets the currently selected aperture's code.

Specified by:

getApertureCode in interface AperturePositioner