Package gda.device.currentamplifier

Class EpicsCurrAmpSingle

java.lang.Object

gda.factory.ConfigurableBase

gda.factory.FindableConfigurableBase

gda.device.DeviceBase

gda.device.scannable.ScannableBase

gda.device.currentamplifier.CurrentAmplifierBase

gda.device.currentamplifier.EpicsCurrAmpSingle

All Implemented Interfaces:

CurrentAmplifier, Device, Scannable, InitializationListener, Configurable, Findable, gda.observable.IObservable

public class EpicsCurrAmpSingle
extends CurrentAmplifierBase
implements InitializationListener

EPICS template interface class for Single Channel Current Amplifier device.

Nested Class Summary

Nested classes/interfaces inherited from interface gda.device.CurrentAmplifier

CurrentAmplifier.Status

Field Summary

Fields inherited from class gda.device.currentamplifier.CurrentAmplifierBase

gainPositions, gainUnits, modePositions

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

Method Summary

Modifier and Type	Method	Description
void	configure()	Configures the class with the PV information from the gda-interface.xml file.
void	disableValueMonitoring()
void	enableValueMonitoring()
double	getCurrent()	returns the current value
String	getGain()	returns the current gain position
String[]	getGainPositions()	Returns an array of all possible gain positions which this device can be moved to.
String	getGainUnit()	returns the current gain unit
String	getMode()	gets the amplifier's mode of operation
String[]	getModePositions()	Returns an array of all possible mode positions which this device can be set to.
String	getPvName()
CurrentAmplifier.Status	getStatus()	Returns the overload status
void	initializationCompleted()	Called when all critical channels are connected.
boolean	isAcdcAvailable()
boolean	isEnableValueMonitoring()
boolean	isPoll()
void	listGains()	returns a parsed list of gains available for this amplifier.
void	setAcdcAvailable(boolean acdcAvailable)
void	setEnableValueMonitoring(boolean enableValueMonitoring)
void	setGain(String position)	Moves amplifier's gain to the named position.
void	setGainUnit(String unit)	Moves amplifier's gain unit to the named unit.
void	setMode(String mode)	sets the amplifier's mode of operation
void	setPoll(boolean poll)
void	setPvName(String pvName)
String	toFormattedString()	Returns a string representation of the Scannable and its current position/value/status

Methods inherited from class gda.device.currentamplifier.CurrentAmplifierBase

asynchronousMoveTo, checkPositionValid, getGainUnits, getPosition, isBusy

Methods inherited from class gda.device.scannable.ScannableBase

__call__, __call__, __doc__, __getitem__, __len__, __repr__, __str__, atCommandFailure, atLevelEnd, atLevelMoveStart, atLevelStart, atPointEnd, atPointStart, atScanEnd, atScanLineEnd, atScanLineStart, atScanStart, externalToInternal, getExtraNames, getInputNames, getLevel, getOutputFormat, getScanMetadataAttribute, getScanMetadataAttributeNames, getScanMetadataAttributes, internalToExternal, isAt, moveTo, rawAsynchronousMoveTo, rawGetPosition, 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

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, stop, waitWhileBusy

Constructor Details

EpicsCurrAmpSingle

public EpicsCurrAmpSingle()

Constructor

Method Details

configure

public void configure()
               throws FactoryException

Configures the class with the PV information from the gda-interface.xml file. Vendor and model are available through EPICS but are currently not supported in GDA.

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

See Also:

• ConfigurableBase.configure()

getGainPositions

public String[] getGainPositions()
                          throws DeviceException

Description copied from interface: CurrentAmplifier

Returns an array of all possible gain positions which this device can be moved to.

Specified by:

getGainPositions in interface CurrentAmplifier

Overrides:

getGainPositions in class CurrentAmplifierBase

Returns:

an array of gain positions

Throws:

DeviceException

getModePositions

public String[] getModePositions()
                          throws DeviceException

Description copied from interface: CurrentAmplifier

Returns an array of all possible mode positions which this device can be set to.

Specified by:

getModePositions in interface CurrentAmplifier

Overrides:

getModePositions in class CurrentAmplifierBase

Returns:

an array of mode positions

Throws:

DeviceException

listGains

public void listGains()
               throws DeviceException

returns a parsed list of gains available for this amplifier.

Specified by:

listGains in interface CurrentAmplifier

Throws:

DeviceException

getStatus

public CurrentAmplifier.Status getStatus()
                                  throws DeviceException

Description copied from interface: CurrentAmplifier

Returns the overload status

Specified by:

getStatus in interface CurrentAmplifier

Returns:

the status

Throws:

DeviceException

setGain

public void setGain(String position)
             throws DeviceException

Description copied from interface: CurrentAmplifier

Moves amplifier's gain to the named position.

Specified by:

setGain in interface CurrentAmplifier

Parameters:

position -

Throws:

DeviceException

getGain

public String getGain()
               throws DeviceException

Description copied from interface: CurrentAmplifier

returns the current gain position

Specified by:

getGain in interface CurrentAmplifier

Returns:

gain position

Throws:

DeviceException

getCurrent

public double getCurrent()
                  throws DeviceException

Description copied from interface: CurrentAmplifier

returns the current value

Specified by:

getCurrent in interface CurrentAmplifier

Returns:

current

Throws:

DeviceException

getMode

public String getMode()
               throws DeviceException

Description copied from interface: CurrentAmplifier

gets the amplifier's mode of operation

Specified by:

getMode in interface CurrentAmplifier

Returns:

mode

Throws:

DeviceException

setMode

public void setMode(String mode)
             throws DeviceException

Description copied from interface: CurrentAmplifier

sets the amplifier's mode of operation

Specified by:

setMode in interface CurrentAmplifier

Parameters:

mode -

Throws:

DeviceException

initializationCompleted

public void initializationCompleted()

Description copied from interface: InitializationListener

Called when all critical channels are connected.

Specified by:

initializationCompleted in interface InitializationListener

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 ScannableBase

Returns:

string as defined above

getGainUnit

public String getGainUnit()
                   throws DeviceException

Description copied from interface: CurrentAmplifier

returns the current gain unit

Specified by:

getGainUnit in interface CurrentAmplifier

Returns:

gain unit

Throws:

DeviceException

setGainUnit

public void setGainUnit(String unit)
                 throws DeviceException

Description copied from interface: CurrentAmplifier

Moves amplifier's gain unit to the named unit.

Specified by:

setGainUnit in interface CurrentAmplifier

Parameters:

unit -

Throws:

DeviceException

isEnableValueMonitoring

public boolean isEnableValueMonitoring()

setEnableValueMonitoring

public void setEnableValueMonitoring(boolean enableValueMonitoring)

enableValueMonitoring

public void enableValueMonitoring()

disableValueMonitoring

public void disableValueMonitoring()

isPoll

public boolean isPoll()

setPoll

public void setPoll(boolean poll)

getPvName

public String getPvName()

setPvName

public void setPvName(String pvName)

isAcdcAvailable

public boolean isAcdcAvailable()

setAcdcAvailable

public void setAcdcAvailable(boolean acdcAvailable)