Package gda.device.qbpm

Class EpicsQbpm

java.lang.Object

gda.factory.ConfigurableBase

gda.factory.FindableConfigurableBase

gda.device.DeviceBase

gda.device.scannable.ScannableBase

gda.device.enumpositioner.EnumPositionerBase

gda.device.qbpm.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, 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
EpicsQbpm()

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.
EpicsBpmController	getBpmController()
String	getBpmName()
String	getControllerRecordName()	Gets the name of the controller record, e.g.
EpicsCurrAmpQuadController	getCurrAmpController()
String	getCurrAmpQuadName()
double	getCurrent1()
double	getCurrent2()
double	getCurrent3()
double	getCurrent4()
static String[]	getCurrentPositionArray(Scannable scannable)	converts object to String array
int	getElementCount()	returns the number of elements in this monitor.
double	getIntensityTotal()
String	getRangeValue()
EnumPositionerStatus	getStatus()	Returns the current status
String	getUnit()	gets the physical unit of the monitor.
double	getXPosition()
double	getYPosition()
void	initializationCompleted()	Called when all critical channels are connected.
void	moveTo(Object position)	Trigger a move/operation and block until completion.
void	rawAsynchronousMoveTo(Object externalPosition)	[Consider abstract] Trigger a move/operation to an internal/hardware position and return immediately.
Object	rawGetPosition()	[Consider abstract] Read the position in its internal (user) representation.
void	setBpmController(EpicsBpmController bpmController)
void	setBpmName(String name)
void	setCurrAmpController(EpicsCurrAmpQuadController currAmpController)
void	setCurrAmpQuadName(String name)
String	toFormattedString()	Returns a string representation of the Scannable and its current position/value/status

Methods inherited from class gda.device.enumpositioner.EnumPositionerBase

addPosition, addPositions, checkPositionValid, clearPositions, containsPosition, createFormattedListAcceptablePositions, getNumberOfPositions, getPosition, getPositionerStatus, getPositionIndex, getPositions, getPositionsList, 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, getPosition, getScanMetadataAttribute, getScanMetadataAttributeNames, getScanMetadataAttributes, internalToExternal, isAt, setExtraNames, setInputNames, setLevel, setOutputFormat, setScanMetadataAttribute, setScanMetadataAttributes, stop, 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, 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

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

getBpmName

public String getBpmName()

Specified by:

getBpmName in interface Qbpm

Returns:

BPM name

setBpmName

public void setBpmName(String name)

Specified by:

setBpmName in interface Qbpm

Parameters:

name -

getCurrAmpQuadName

public String getCurrAmpQuadName()

Specified by:

getCurrAmpQuadName in interface Qbpm

Returns:

Current Amp Quad Name

setCurrAmpQuadName

public void setCurrAmpQuadName(String name)

Specified by:

setCurrAmpQuadName in interface Qbpm

Parameters:

name -

getElementCount

public int getElementCount()
                    throws DeviceException

Description copied from interface: Monitor

returns the number of elements in this monitor.

Specified by:

getElementCount in interface Monitor

Returns:

int the element count

Throws:

DeviceException

getUnit

public String getUnit()
               throws DeviceException

Description copied from interface: Monitor

gets the physical unit of the monitor.

Specified by:

getUnit in interface Monitor

Returns:

String the physical unit

Throws:

DeviceException

initializationCompleted

public void initializationCompleted()

Description copied from interface: InitializationListener

Called when all critical channels are connected.

Specified by:

initializationCompleted in interface InitializationListener

getStatus

public EnumPositionerStatus getStatus()
                               throws DeviceException

Description copied from interface: EnumPositioner

Returns the current status

Specified by:

getStatus in interface EnumPositioner

Overrides:

getStatus in class EnumPositionerBase

Returns:

the status

Throws:

DeviceException

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 ScannableBase

Parameters:

position -

Throws:

DeviceException

rawAsynchronousMoveTo

public void rawAsynchronousMoveTo(Object externalPosition)
                           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:

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

Throws:

DeviceException

See Also:

• asynchronousMoveTo

getCurrent1

public double getCurrent1()
                   throws DeviceException

Specified by:

getCurrent1 in interface Qbpm

Returns:

current1

Throws:

DeviceException

getCurrent2

public double getCurrent2()
                   throws DeviceException

Specified by:

getCurrent2 in interface Qbpm

Returns:

current2

Throws:

DeviceException

getCurrent3

public double getCurrent3()
                   throws DeviceException

Specified by:

getCurrent3 in interface Qbpm

Returns:

current3

Throws:

DeviceException

getCurrent4

public double getCurrent4()
                   throws DeviceException

Specified by:

getCurrent4 in interface Qbpm

Returns:

current4

Throws:

DeviceException

getRangeValue

public String getRangeValue()
                     throws DeviceException

Specified by:

getRangeValue in interface Qbpm

Returns:

range value

Throws:

DeviceException

getIntensityTotal

public double getIntensityTotal()
                         throws DeviceException

Specified by:

getIntensityTotal in interface Qbpm

Returns:

intensity total

Throws:

DeviceException

getXPosition

public double getXPosition()
                    throws DeviceException

Specified by:

getXPosition in interface Qbpm

Returns:

X Position

Throws:

DeviceException

getYPosition

public double getYPosition()
                    throws DeviceException

Specified by:

getYPosition in interface Qbpm

Returns:

Y position

Throws:

DeviceException

rawGetPosition

public Object rawGetPosition()
                      throws DeviceException

Description copied from class: ScannableBase

[Consider abstract] Read the position in its internal (user) representation.

Overrides:

rawGetPosition in class ScannableBase

Returns:

the value represented by this Scannable

Throws:

DeviceException

See Also:

• Scannable.getPosition()

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

getCurrentPositionArray

public static String[] getCurrentPositionArray(Scannable scannable)
                                        throws Exception

converts object to String array

Parameters:

scannable -

Returns:

String Array

Throws:

Exception

getCurrAmpController

public EpicsCurrAmpQuadController getCurrAmpController()

setCurrAmpController

public void setCurrAmpController(EpicsCurrAmpQuadController currAmpController)

getBpmController

public EpicsBpmController getBpmController()

setBpmController

public void setBpmController(EpicsBpmController bpmController)

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