Package gda.device.enumpositioner

Class EpicsSimplePneumatic

java.lang.Object

gda.factory.ConfigurableBase

gda.factory.FindableConfigurableBase

gda.device.DeviceBase

gda.device.scannable.ScannableBase

gda.device.enumpositioner.EnumPositionerBase

gda.device.enumpositioner.EpicsSimplePneumatic

All Implemented Interfaces:

ControllerRecord, Device, EnumPositioner, Scannable, InitializationListener, Configurable, Findable, gda.observable.IObservable

@ServiceInterface(EnumPositioner.class)
public class EpicsSimplePneumatic
extends EnumPositionerBase
implements InitializationListener, ControllerRecord

This class maps onto the EPICS PneumaticCallback template.

Field Summary

Fields

Modifier and Type	Field	Description
protected String	pvName
protected Vector<String>	statuspositions

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

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	getControllerRecordName()	Gets the name of the controller record, e.g.
String[]	getControlPositions()	gets the available status positions from this device.
String	getPosition()	gets the current status position of this device.
String[]	getPositions()	gets the available positions from this device.
String	getPvName()
void	initializationCompleted()	Called when all critical channels are connected.
boolean	isReadOnly()
void	rawAsynchronousMoveTo(Object position)	[Consider abstract] Trigger a move/operation to an internal/hardware position and return immediately.
void	setPvName(String pvName)
void	setReadOnly(boolean readOnly)
void	stop()	Stop the current move/operation.

Methods inherited from class gda.device.enumpositioner.EnumPositionerBase

addPosition, addPositions, checkPositionValid, clearPositions, containsPosition, createFormattedListAcceptablePositions, getNumberOfPositions, getPosition, getPositionerStatus, getPositionIndex, getPositionsList, getStatus, isBusy, isInPos, 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, moveTo, 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.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, getExtraNames, getInputNames, getLevel, getOutputFormat, getScanMetadataAttribute, getScanMetadataAttributeNames, getScanMetadataAttributes, isAt, moveTo, setExtraNames, setInputNames, setLevel, setOutputFormat, setScanMetadataAttribute, setScanMetadataAttributes, waitWhileBusy

Field Details

pvName

protected String pvName

statuspositions

protected Vector<String> statuspositions

Constructor Details

EpicsSimplePneumatic

public EpicsSimplePneumatic()

constructor

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 ConfigurableBase

Throws:

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

getPosition

public String getPosition()
                   throws DeviceException

gets the current status position of this device.

Specified by:

getPosition in interface Scannable

Overrides:

getPosition in class ScannableBase

Returns:

position in String

Throws:

DeviceException

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

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

getPositions

public String[] getPositions()
                      throws DeviceException

gets the available positions from this device.

Specified by:

getPositions in interface EnumPositioner

Overrides:

getPositions in class EnumPositionerBase

Returns:

the available positions from this device.

Throws:

DeviceException

getControlPositions

public String[] getControlPositions()
                             throws DeviceException

gets the available status positions from this device.

Returns:

the available status positions from this device.

Throws:

DeviceException

initializationCompleted

public void initializationCompleted()
                             throws DeviceException

Description copied from interface: InitializationListener

Called when all critical channels are connected.

Specified by:

initializationCompleted in interface InitializationListener

Throws:

DeviceException

getPvName

public String getPvName()

setPvName

public void setPvName(String pvName)

getControllerRecordName

public String getControllerRecordName()

Description copied from interface: ControllerRecord

Gets the name of the controller record, e.g. EPICS process variable name. For example, in NeXus this value can be written as the value of the controller_record field for the NXpositioner for the scannable.

Specified by:

getControllerRecordName in interface ControllerRecord

Returns:

controller record name

See Also:

• Nexus documentation for NXpositioner

setReadOnly

public void setReadOnly(boolean readOnly)

isReadOnly

public boolean isReadOnly()