Package gda.device.enumpositioner
Class EpicsPneumaticCallback
java.lang.Object
gda.factory.ConfigurableBase
gda.factory.FindableConfigurableBase
gda.device.DeviceBase
gda.device.scannable.ScannableBase
gda.device.enumpositioner.EnumPositionerBase
gda.device.enumpositioner.EpicsPneumaticCallback
- All Implemented Interfaces:
ControllerRecord,Device,EnumPositioner,Scannable,InitializationListener,Configurable,Findable,gda.observable.IObservable
- Direct Known Subclasses:
NameMappedEpicsPneumaticCallback
@ServiceInterface(EnumPositioner.class)
public class EpicsPneumaticCallback
extends EnumPositionerBase
implements InitializationListener, ControllerRecord
This class maps onto the EPICS PneumaticCallback template.
-
Field Summary
FieldsModifier and TypeFieldDescriptionbooleanIf statusPv is simply a list of positions and does not contains state such as IDLE, MOVING etc set this to trueFields inherited from class gda.device.scannable.ScannableBase
__doc__, DEFAULT_INPUT_NAME, DEFAULT_OUTPUT_FORMAT, extraNames, inputNames, level, outputFormatFields inherited from class gda.device.DeviceBase
DEFAULT_PROTECTION_LEVEL_PROPERTYFields inherited from interface gda.device.Scannable
ATTR_NEXUS_CATEGORY, ATTR_NX_CLASS, DEFAULT_INPUT_NAME, VALUE_UNAVAILABLE -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidDefault 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.Gets the name of the controller record, e.g.gets the current status position of this device.String[]gets the available positions from this device.String[]gets the available status positions from this device.voidCalled when all critical channels are connected.booleanbooleanbooleanvoidrawAsynchronousMoveTo(Object position) [Consider abstract] Trigger a move/operation to an internal/hardware position and return immediately.voidsetAllPVsSet(boolean allPVsSet) voidsetControlPv(String controlPv) Sets the control PV used by this object.voidvoidsetReadOnly(boolean readOnly) voidsetStatusPv(String statusPv) Sets the status PV used by this object.voidsetStatusPvIndicatesPositionOnly(boolean statusPvIndicatesPositionOnly) voidstop()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, toFormattedStringMethods 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, waitWhileBusyMethods inherited from class gda.device.DeviceBase
addIObserver, close, deleteIObserver, deleteIObservers, getAttribute, getName, getProtectionLevel, isBeingObserved, isConfigureAtStartup, notifyIObservers, setAttribute, setConfigureAtStartup, setName, setProtectionLevelMethods inherited from class gda.factory.ConfigurableBase
isConfigured, reconfigure, setConfiguredMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface gda.factory.Configurable
isConfigureAtStartup, isConfigured, reconfigureMethods inherited from interface gda.device.Device
close, getAttribute, getProtectionLevel, setAttribute, setProtectionLevelMethods inherited from interface gda.observable.IObservable
addIObserver, deleteIObserver, deleteIObserversMethods 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
-
statuspositions
-
statusPvIndicatesPositionOnly
public boolean statusPvIndicatesPositionOnlyIf statusPv is simply a list of positions and does not contains state such as IDLE, MOVING etc set this to true
-
-
Constructor Details
-
EpicsPneumaticCallback
public EpicsPneumaticCallback()constructor
-
-
Method Details
-
isStatusPvIndicatesPositionOnly
public boolean isStatusPvIndicatesPositionOnly() -
setStatusPvIndicatesPositionOnly
public void setStatusPvIndicatesPositionOnly(boolean statusPvIndicatesPositionOnly) -
getPvBase
-
setPvBase
-
setControlPv
Sets the control PV used by this object.- Parameters:
controlPv- the control PV
-
getControlPv
-
setStatusPv
Sets the status PV used by this object.- Parameters:
statusPv- the status PV
-
getStatusPv
-
configure
Description copied from class:ConfigurableBaseDefault 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:
configurein interfaceConfigurable- Overrides:
configurein classConfigurableBase- Throws:
FactoryException- if there is an error in configuration e.g. required variable not set or cannot connect to device
-
getPosition
gets the current status position of this device.- Specified by:
getPositionin interfaceScannable- Overrides:
getPositionin classScannableBase- Returns:
- position in String
- Throws:
DeviceException
-
rawAsynchronousMoveTo
Description copied from class:ScannableBase[Consider abstract] Trigger a move/operation to an internal/hardware position and return immediately.- Overrides:
rawAsynchronousMoveToin classScannableBase- Parameters:
position- Position in its internal/hardware representation. e.g. with units and offsets removed- Throws:
DeviceException- See Also:
-
stop
Description copied from class:ScannableBaseStop 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:
stopin interfaceScannable- Overrides:
stopin classScannableBase- Throws:
DeviceException- See Also:
-
getPositions
gets the available positions from this device.- Specified by:
getPositionsin interfaceEnumPositioner- Overrides:
getPositionsin classEnumPositionerBase- Returns:
- the available positions from this device.
- Throws:
DeviceException
-
getStatusPositions
gets the available status positions from this device.- Returns:
- the available status positions from this device.
- Throws:
DeviceException
-
initializationCompleted
Description copied from interface:InitializationListenerCalled when all critical channels are connected.- Specified by:
initializationCompletedin interfaceInitializationListener- Throws:
DeviceException
-
isAllPVsSet
public boolean isAllPVsSet() -
setAllPVsSet
public void setAllPVsSet(boolean allPVsSet) -
setReadOnly
public void setReadOnly(boolean readOnly) -
isReadOnly
public boolean isReadOnly() -
getControllerRecordName
Description copied from interface:ControllerRecordGets 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 thecontroller_recordfield for theNXpositionerfor the scannable.- Specified by:
getControllerRecordNamein interfaceControllerRecord- Returns:
- controller record name
- See Also:
-