Package gda.device.currentamplifier

Class DummyEpicsCurrAmpSingle

java.lang.Object

gda.factory.ConfigurableBase

gda.factory.FindableConfigurableBase

gda.device.DeviceBase

gda.device.scannable.ScannableBase

gda.device.currentamplifier.CurrentAmplifierBase

gda.device.currentamplifier.DummyEpicsCurrAmpSingle

All Implemented Interfaces:

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

public class DummyEpicsCurrAmpSingle
extends CurrentAmplifierBase

simulation for a single Channel Current Amplifier device, provide controls for gain and mode, and reading for current value.

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
DummyEpicsCurrAmpSingle()	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.
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
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
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, getModePositions, 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

DummyEpicsCurrAmpSingle

public DummyEpicsCurrAmpSingle()

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

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

listGains

public void listGains()
               throws DeviceException

returns a parsed list of gains available for this amplifier.

Throws:

DeviceException

getStatus

public CurrentAmplifier.Status getStatus()
                                  throws DeviceException

Description copied from interface: CurrentAmplifier

Returns the overload status

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.

Parameters:

position -

Throws:

DeviceException

getGain

public String getGain()

Description copied from interface: CurrentAmplifier

returns the current gain position

Returns:

gain position

getCurrent

public double getCurrent()

Description copied from interface: CurrentAmplifier

returns the current value

Returns:

current

getMode

public String getMode()

Description copied from interface: CurrentAmplifier

gets the amplifier's mode of operation

Returns:

mode

setMode

public void setMode(String mode)
             throws DeviceException

Description copied from interface: CurrentAmplifier

sets the amplifier's mode of operation

Parameters:

mode -

Throws:

DeviceException

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

Description copied from interface: CurrentAmplifier

returns the current gain unit

Returns:

gain unit

setGainUnit

public void setGainUnit(String unit)
                 throws DeviceException

Description copied from interface: CurrentAmplifier

Moves amplifier's gain unit to the named unit.

Parameters:

unit -

Throws:

DeviceException