Package gda.device.qbpm
Class EpicsQbpm
- All Implemented Interfaces:
ControllerRecord,Device,EnumPositioner,Monitor,Qbpm,Scannable,InitializationListener,Configurable,Findable,gda.observable.IObservable
public class EpicsQbpm
extends EnumPositionerBase
implements Monitor, InitializationListener, Qbpm, ControllerRecord
EpicsQbpm Class
-
Field Summary
Fields 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.doubledoubledoubledoublestatic String[]getCurrentPositionArray(Scannable scannable) converts object to String arrayintreturns the number of elements in this monitor.doubleReturns the current statusgetUnit()gets the physical unit of the monitor.doubledoublevoidCalled when all critical channels are connected.voidTrigger a move/operation and block until completion.voidrawAsynchronousMoveTo(Object externalPosition) [Consider abstract] Trigger a move/operation to an internal/hardware position and return immediately.[Consider abstract] Read the position in its internal (user) representation.voidsetBpmController(EpicsBpmController bpmController) voidsetBpmName(String name) voidsetCurrAmpController(EpicsCurrAmpQuadController currAmpController) voidsetCurrAmpQuadName(String name) Returns a string representation of the Scannable and its current position/value/statusMethods inherited from class gda.device.enumpositioner.EnumPositionerBase
addPosition, addPositions, checkPositionValid, clearPositions, containsPosition, createFormattedListAcceptablePositions, getNumberOfPositions, getPosition, getPositionerStatus, getPositionIndex, getPositions, getPositionsList, isBusy, isInPos, setPositionerStatus, setPositionsInternalMethods 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, getPosition, getScanMetadataAttribute, getScanMetadataAttributeNames, getScanMetadataAttributes, internalToExternal, isAt, setExtraNames, setInputNames, setLevel, setOutputFormat, setScanMetadataAttribute, setScanMetadataAttributes, stop, 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, checkPositionValid, getExtraNames, getInputNames, getLevel, getOutputFormat, getPosition, getScanMetadataAttribute, getScanMetadataAttributeNames, getScanMetadataAttributes, isAt, isBusy, setExtraNames, setInputNames, setLevel, setOutputFormat, setScanMetadataAttribute, setScanMetadataAttributes, stop, waitWhileBusy
-
Constructor Details
-
EpicsQbpm
public EpicsQbpm()
-
-
Method Details
-
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
-
getBpmName
- Specified by:
getBpmNamein interfaceQbpm- Returns:
- BPM name
-
setBpmName
- Specified by:
setBpmNamein interfaceQbpm- Parameters:
name-
-
getCurrAmpQuadName
- Specified by:
getCurrAmpQuadNamein interfaceQbpm- Returns:
- Current Amp Quad Name
-
setCurrAmpQuadName
- Specified by:
setCurrAmpQuadNamein interfaceQbpm- Parameters:
name-
-
getElementCount
Description copied from interface:Monitorreturns the number of elements in this monitor.- Specified by:
getElementCountin interfaceMonitor- Returns:
- int the element count
- Throws:
DeviceException
-
getUnit
Description copied from interface:Monitorgets the physical unit of the monitor.- Specified by:
getUnitin interfaceMonitor- Returns:
- String the physical unit
- Throws:
DeviceException
-
initializationCompleted
public void initializationCompleted()Description copied from interface:InitializationListenerCalled when all critical channels are connected.- Specified by:
initializationCompletedin interfaceInitializationListener
-
getStatus
Description copied from interface:EnumPositionerReturns the current status- Specified by:
getStatusin interfaceEnumPositioner- Overrides:
getStatusin classEnumPositionerBase- Returns:
- the status
- Throws:
DeviceException
-
moveTo
Description copied from class:ScannableBaseTrigger 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:
moveToin interfaceScannable- Overrides:
moveToin classScannableBase- Parameters:
position-- 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:
externalPosition- Position in its internal/hardware representation. e.g. with units and offsets removed- Throws:
DeviceException- See Also:
-
getCurrent1
- Specified by:
getCurrent1in interfaceQbpm- Returns:
- current1
- Throws:
DeviceException
-
getCurrent2
- Specified by:
getCurrent2in interfaceQbpm- Returns:
- current2
- Throws:
DeviceException
-
getCurrent3
- Specified by:
getCurrent3in interfaceQbpm- Returns:
- current3
- Throws:
DeviceException
-
getCurrent4
- Specified by:
getCurrent4in interfaceQbpm- Returns:
- current4
- Throws:
DeviceException
-
getRangeValue
- Specified by:
getRangeValuein interfaceQbpm- Returns:
- range value
- Throws:
DeviceException
-
getIntensityTotal
- Specified by:
getIntensityTotalin interfaceQbpm- Returns:
- intensity total
- Throws:
DeviceException
-
getXPosition
- Specified by:
getXPositionin interfaceQbpm- Returns:
- X Position
- Throws:
DeviceException
-
getYPosition
- Specified by:
getYPositionin interfaceQbpm- Returns:
- Y position
- Throws:
DeviceException
-
rawGetPosition
Description copied from class:ScannableBase[Consider abstract] Read the position in its internal (user) representation.- Overrides:
rawGetPositionin classScannableBase- Returns:
- the value represented by this Scannable
- Throws:
DeviceException- See Also:
-
toFormattedString
Description copied from interface:ScannableReturns a string representation of the Scannable and its current position/value/statusTypically should return:
name : position
or for detectors, name : status
If the position/status cannot be determined, the function should return
Scannable.VALUE_UNAVAILABLEin its place.- Specified by:
toFormattedStringin interfaceScannable- Overrides:
toFormattedStringin classEnumPositionerBase- Returns:
- string as defined above
-
getCurrentPositionArray
converts object to String array- Parameters:
scannable-- Returns:
- String Array
- Throws:
Exception
-
getCurrAmpController
-
setCurrAmpController
-
getBpmController
-
setBpmController
-
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:
-