Package gda.device.enumpositioner

Class NameMappedEpicsPneumaticCallback

java.lang.Object

gda.factory.ConfigurableBase

gda.factory.FindableConfigurableBase

gda.device.DeviceBase

gda.device.scannable.ScannableBase

gda.device.enumpositioner.EnumPositionerBase

gda.device.enumpositioner.EpicsPneumaticCallback

gda.device.enumpositioner.NameMappedEpicsPneumaticCallback

All Implemented Interfaces:

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

public class NameMappedEpicsPneumaticCallback
extends EpicsPneumaticCallback

Version of EpicsPneumaticCallback in which the EPICS names are mapped to different names at the GDA level.

For situations where 'Open' and 'Close' are 'too confusing'...

See Also:

• EpicsSimplePositioner

Field Summary

Fields inherited from class gda.device.enumpositioner.EpicsPneumaticCallback

statuspositions, statusPvIndicatesPositionOnly

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

Method Summary

Modifier and Type	Method	Description
String	checkPositionValid(Object position)	This default behaviour should be extended by most subclasses! This default behaviour should be extended by most subclasses! Tests if the given object is meaningful to this Scannable and so could be used by one of the move commands.
Map<String,String>	getControlValues()
String	getPosition()	gets the current status position of this device.
String[]	getPositions()	gets the available positions from this device.
Map<String,String>	getStatusValues()
void	rawAsynchronousMoveTo(Object position)	[Consider abstract] Trigger a move/operation to an internal/hardware position and return immediately.
void	setControlValues(Map<String,String> values)	Mapinvalid input: '<'String, String> - means invalid input: '<'GDA name, EPICS name>
void	setStatusValues(Map<String,String> statusValues)
String	toFormattedString()	Returns a string representation of the Scannable and its current position/value/status

Methods inherited from class gda.device.enumpositioner.EpicsPneumaticCallback

configure, getControllerRecordName, getControlPv, getPvBase, getStatusPositions, getStatusPv, initializationCompleted, isAllPVsSet, isReadOnly, isStatusPvIndicatesPositionOnly, setAllPVsSet, setControlPv, setPvBase, setReadOnly, setStatusPv, setStatusPvIndicatesPositionOnly, stop

Methods inherited from class gda.device.enumpositioner.EnumPositionerBase

addPosition, addPositions, clearPositions, containsPosition, createFormattedListAcceptablePositions, getNumberOfPositions, getPosition, getPositionerStatus, getPositionIndex, getPositionsList, getStatus, isBusy, isInPos, setPositionerStatus, setPositionsInternal

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

Constructor Details

NameMappedEpicsPneumaticCallback

public NameMappedEpicsPneumaticCallback()

Method Details

getControlValues

public Map<String,String> getControlValues()

Returns:

Returns the values.

setControlValues

public void setControlValues(Map<String,String> values)

Mapinvalid input: '<'String, String> - means invalid input: '<'GDA name, EPICS name>

Parameters:

values - The values to set.

getStatusValues

public Map<String,String> getStatusValues()

setStatusValues

public void setStatusValues(Map<String,String> statusValues)

getPositions

public String[] getPositions()
                      throws DeviceException

Description copied from class: EpicsPneumaticCallback

gets the available positions from this device.

Specified by:

getPositions in interface EnumPositioner

Overrides:

getPositions in class EpicsPneumaticCallback

Returns:

the available positions from this device.

Throws:

DeviceException

toFormattedString

public String toFormattedString()

Description copied from interface: Scannable

Returns a string representation of the Scannable and its current position/value/status

Typically should return:

name : position

or for detectors, name : status

If the position/status cannot be determined, the function should return Scannable.VALUE_UNAVAILABLE in its place.

Specified by:

toFormattedString in interface Scannable

Overrides:

toFormattedString in class EnumPositionerBase

Returns:

string as defined above

getPosition

public String getPosition()
                   throws DeviceException

Description copied from class: EpicsPneumaticCallback

gets the current status position of this device.

Specified by:

getPosition in interface Scannable

Overrides:

getPosition in class EpicsPneumaticCallback

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 EpicsPneumaticCallback

Parameters:

position - Position in its internal/hardware representation. e.g. with units and offsets removed

Throws:

DeviceException

See Also:

• asynchronousMoveTo

checkPositionValid

public String checkPositionValid(Object position)

Description copied from class: ScannableBase

This default behaviour should be extended by most subclasses! Tests if the given object is meaningful to this Scannable and so could be used by one of the move commands. May check limits and other things too. This is the method called by scans on all points before the scan is run.

Specified by:

checkPositionValid in interface Scannable

Overrides:

checkPositionValid in class EnumPositionerBase

Parameters:

position -

Returns:

null if position is valid, or returns a description if not.

See Also:

• Scannable.checkPositionValid(java.lang.Object)