Package gda.device

Interface CurrentAmplifier

All Superinterfaces:

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

All Known Subinterfaces:

AmplifierAutoGain, StanfordAmplifier

All Known Implementing Classes:

CurrentAmplifierBase, DummyCurrentAmplifier, DummyEpicsCurrAmpSingle, DummyStanfordScannable, EpicsCurrAmpSingle, EpicsFemtoAmplifier, EpicsStanfordAmplifer, StanfordScannable

public interface CurrentAmplifier
extends Scannable

Interface for EPICS single channel current amplifier.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	CurrentAmplifier.Status	defines the overload status of the amplifier

Field Summary

Fields inherited from interface gda.device.Scannable

ATTR_NEXUS_CATEGORY, ATTR_NX_CLASS, DEFAULT_INPUT_NAME, VALUE_UNAVAILABLE

Method Summary

Modifier and Type	Method	Description
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[]	getGainUnits()	Returns an array of all possible gain units which this device can be moved to.
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.
CurrentAmplifier.Status	getStatus()	Returns the overload status
void	listGains()	returns a parsed list of gains available for this amplifier.
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

Methods inherited from interface gda.factory.Configurable

configure, 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

Method Details

getGainPositions

String[] getGainPositions()
                   throws DeviceException

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

Returns:

an array of gain positions

Throws:

DeviceException

getGainUnits

String[] getGainUnits()
               throws DeviceException

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

Returns:

an array of gain units

Throws:

DeviceException

getModePositions

String[] getModePositions()
                   throws DeviceException

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

Returns:

an array of mode positions

Throws:

DeviceException

setGain

void setGain(String position)
      throws DeviceException

Moves amplifier's gain to the named position.

Parameters:

position -

Throws:

DeviceException

getGain

String getGain()
        throws DeviceException

returns the current gain position

Returns:

gain position

Throws:

DeviceException

setGainUnit

void setGainUnit(String unit)
          throws DeviceException

Moves amplifier's gain unit to the named unit.

Parameters:

unit -

Throws:

DeviceException

getGainUnit

String getGainUnit()
            throws DeviceException

returns the current gain unit

Returns:

gain unit

Throws:

DeviceException

getCurrent

double getCurrent()
           throws DeviceException

returns the current value

Returns:

current

Throws:

DeviceException

setMode

void setMode(String mode)
      throws DeviceException

sets the amplifier's mode of operation

Parameters:

mode -

Throws:

DeviceException

getMode

String getMode()
        throws DeviceException

gets the amplifier's mode of operation

Returns:

mode

Throws:

DeviceException

getStatus

CurrentAmplifier.Status getStatus()
                           throws DeviceException

Returns the overload status

Returns:

the status

Throws:

DeviceException

listGains

void listGains()
        throws DeviceException

returns a parsed list of gains available for this amplifier.

Throws:

DeviceException