Package gda.device.enumpositioner

Class EpicsCurrAmpQuadController

java.lang.Object

gda.factory.ConfigurableBase

gda.factory.FindableConfigurableBase

gda.device.DeviceBase

gda.device.scannable.ScannableBase

gda.device.enumpositioner.EnumPositionerBase

gda.device.enumpositioner.EpicsCurrAmpQuadController

All Implemented Interfaces:

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

Direct Known Subclasses:

EpicsLocum4Controller

public class EpicsCurrAmpQuadController
extends EnumPositionerBase
implements Monitor, InitializationListener, ControllerRecord

EpicsCurrAmpQuadController 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
EpicsCurrAmpQuadController()	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.
void	disablePoll()
void	enablePoll()
String	getControllerRecordName()	Gets the name of the controller record, e.g.
double	getCurrent1()
String	getCurrent1Pv()
double	getCurrent2()
String	getCurrent2Pv()
double	getCurrent3()
String	getCurrent3Pv()
double	getCurrent4()
String	getCurrent4Pv()
static String[]	getCurrentPositionArray(Scannable scannable)	converts object to String array
int	getElementCount()	returns the number of elements in this monitor.
String[]	getPositions()	Returns an array of the positions which this device can be moved to.
String	getRangePv()
String	getRangeRbvPv()
String	getRangeValue()
String	getUnit()	gets the physical unit of the monitor.
void	initializationCompleted()	Called when all critical channels are connected.
boolean	isPoll()
protected void	monitorRange(gov.aps.jca.event.MonitorEvent mev)
void	rawAsynchronousMoveTo(Object position)	[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	setCurrent1Pv(String current1pv)
void	setCurrent2Pv(String current2pv)
void	setCurrent3Pv(String current3pv)
void	setCurrent4Pv(String current4pv)
void	setPoll(boolean poll)
void	setRangePv(String rangePV)
void	setRangeRbvPv(String rangeRBVPV)
String	toString()

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, getPosition, getScanMetadataAttribute, getScanMetadataAttributeNames, getScanMetadataAttributes, internalToExternal, isAt, moveTo, setExtraNames, setInputNames, setLevel, setOutputFormat, setScanMetadataAttribute, setScanMetadataAttributes, stop, throwExceptionIfInvalidTarget, 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, moveTo, setExtraNames, setInputNames, setLevel, setOutputFormat, setScanMetadataAttribute, setScanMetadataAttributes, stop, toFormattedString, waitWhileBusy

Constructor Details

EpicsCurrAmpQuadController

public EpicsCurrAmpQuadController()

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

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

disablePoll

public void disablePoll()

enablePoll

public void enablePoll()

getPositions

public String[] getPositions()
                      throws DeviceException

Description copied from interface: EnumPositioner

Returns an array of the positions which this device can be moved to.

Specified by:

getPositions in interface EnumPositioner

Overrides:

getPositions in class EnumPositionerBase

Returns:

an array of positions

Throws:

DeviceException

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

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

monitorRange

protected void monitorRange(gov.aps.jca.event.MonitorEvent mev)

getRangeValue

public String getRangeValue()
                     throws DeviceException

Returns:

range value

Throws:

DeviceException

getCurrent1

public double getCurrent1()
                   throws DeviceException

Returns:

current1

Throws:

DeviceException

getCurrent2

public double getCurrent2()
                   throws DeviceException

Returns:

current2

Throws:

DeviceException

getCurrent3

public double getCurrent3()
                   throws DeviceException

Returns:

current3

Throws:

DeviceException

getCurrent4

public double getCurrent4()
                   throws DeviceException

Returns:

current4

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

toString

public String toString()

Overrides:

toString in class ScannableBase

getCurrentPositionArray

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

converts object to String array

Parameters:

scannable -

Returns:

position array

Throws:

Exception

isPoll

public boolean isPoll()

setPoll

public void setPoll(boolean poll)

getCurrent1Pv

public String getCurrent1Pv()

setCurrent1Pv

public void setCurrent1Pv(String current1pv)

getCurrent2Pv

public String getCurrent2Pv()

setCurrent2Pv

public void setCurrent2Pv(String current2pv)

getCurrent3Pv

public String getCurrent3Pv()

setCurrent3Pv

public void setCurrent3Pv(String current3pv)

getCurrent4Pv

public String getCurrent4Pv()

setCurrent4Pv

public void setCurrent4Pv(String current4pv)

getRangePv

public String getRangePv()

setRangePv

public void setRangePv(String rangePV)

getRangeRbvPv

public String getRangeRbvPv()

setRangeRbvPv

public void setRangeRbvPv(String rangeRBVPV)

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