Package gda.device.currentamplifier

Class EpicsFemtoAmplifier

java.lang.Object

gda.factory.ConfigurableBase

gda.factory.FindableConfigurableBase

gda.device.DeviceBase

gda.device.scannable.ScannableBase

gda.device.currentamplifier.CurrentAmplifierBase

gda.device.currentamplifier.EpicsFemtoAmplifier

All Implemented Interfaces:

AmplifierAutoGain, CurrentAmplifier, Device, Scannable, Configurable, Findable, gda.observable.IObservable, org.springframework.beans.factory.InitializingBean

public class EpicsFemtoAmplifier
extends CurrentAmplifierBase
implements AmplifierAutoGain, org.springframework.beans.factory.InitializingBean

This class is for controlling a Femto current amplifier.

The Femto amplifies the input current usually in mA or less and outputs a voltage as determined by the gain setting. i.e a 1x10^-6 A current with a 10^6 gain will output 1 V

The output of Femto usually feeds into ADC which offers the ability to average the voltage over time to improve the signal to noise ratio.

The EPICS EDM for these devices are:
The Femto

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	EpicsFemtoAmplifier.CouplingMode

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

Method Summary

Modifier and Type	Method	Description
void	afterPropertiesSet()	check all essential bean properties have been set.
void	asynchronousMoveTo(Object position)	Trigger a move/operation and return immediately.
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.
String	getBasePVName()
String	getCouplingMode()
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.
double	getInstantaneousVoltage()
double	getLowerVoltageBound()
String	getMode()	Gets the operation mode of the femto.
String[]	getModePositions()	Returns an array of all possible mode positions which this device can be set to.
Map<String,Map<String,String>>	getModeToGainToGainStringMap()
Object	getPosition()	Returns the current position of the Scannable.
long	getSettleTime()
CurrentAmplifier.Status	getStatus()	Returns the overload status
double	getUpperVoltageBound()
boolean	hasMultipleModes()
boolean	increaseOrDecreaseGain(int indexIncrement)
boolean	isBusy()	Check if the Scannable is moving/operating.
boolean	isHasIinPV()
boolean	isSupportsCoupling()
void	listGains()	returns a parsed list of gains available for this amplifier.
void	setBasePVName(String basePVName)
void	setCouplingMode(String couplingMode)	Set the Femto coupling mode, takes a string for Jython to use
void	setFemtoCouplingMode(EpicsFemtoAmplifier.CouplingMode couplingMode)
void	setGain(double newGain)
void	setGain(String gain)	This is the method which actually writes to the gain PV.
void	setGainUnit(String unit)	Moves amplifier's gain unit to the named unit.
void	setHasIinPV(boolean hasIinPV)
void	setLowerVoltageBound(double lowerVoltageBound)
void	setMode(String mode)	Changes the operation mode of the femto.
void	setModeToGainToGainStringMap(Map<String,Map<String,String>> modeToGainToGainStringMap)
void	setSettleTime(long settleTime)
void	setSupportsCoupling(boolean supportsCoupling)
void	setUpperVoltageBound(double upperVoltageBound)

Methods inherited from class gda.device.currentamplifier.CurrentAmplifierBase

checkPositionValid

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, toFormattedString, 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.device.AmplifierAutoGain

decreaseGain, increaseGain, optimiseGain

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, checkPositionValid, getExtraNames, getInputNames, getLevel, getOutputFormat, getScanMetadataAttribute, getScanMetadataAttributeNames, getScanMetadataAttributes, isAt, moveTo, setExtraNames, setInputNames, setLevel, setOutputFormat, setScanMetadataAttribute, setScanMetadataAttributes, stop, toFormattedString, waitWhileBusy

Constructor Details

EpicsFemtoAmplifier

public EpicsFemtoAmplifier()

Method Details

afterPropertiesSet

public void afterPropertiesSet()

check all essential bean properties have been set. This must be used to specify a custom init-method in an XML bean definition.

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

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

asynchronousMoveTo

public void asynchronousMoveTo(Object position)
                        throws DeviceException

Description copied from class: ScannableBase

Trigger a move/operation and return immediately. Implementations of this method should be non-blocking to allow concurrent motion; the isBusy method will be used to determine when the move has completed. Converts the external (user) position to an internal position and passes this to rawAsynchronousMoveTo.

Specified by:

asynchronousMoveTo in interface Scannable

Overrides:

asynchronousMoveTo in class CurrentAmplifierBase

Parameters:

position - Position to move to should have an element for each input field.

Throws:

DeviceException

getPosition

public Object getPosition()
                   throws DeviceException

Description copied from class: ScannableBase

Returns the current position of the Scannable. Called by ConcurentScan at the end of the point. Reads an internal (hardware) position from rawGetPosition, converts this to an external (user) position and returns it.

Specified by:

getPosition in interface Scannable

Overrides:

getPosition in class CurrentAmplifierBase

Returns:

Current position with an element for each input and extra field. null if their are no fields.

Throws:

DeviceException

isBusy

public boolean isBusy()

Description copied from interface: Scannable

Check if the Scannable is moving/operating.

Specified by:

isBusy in interface Scannable

Overrides:

isBusy in class CurrentAmplifierBase

Returns:

true - if operation carried out by moveTo has not completed yet

setMode

public void setMode(String mode)
             throws DeviceException

Changes the operation mode of the femto.

Specified by:

setMode in interface CurrentAmplifier

Parameters:

mode - The requested operation mode

Throws:

DeviceException - If the mode change fails

IllegalArgumentException - If mode is not in modeToGainToGainStringMap

getMode

public String getMode()
               throws DeviceException

Gets the operation mode of the femto.

Specified by:

getMode in interface CurrentAmplifier

Returns:

The current operation mode

Throws:

DeviceException - If the mode change fails

increaseOrDecreaseGain

public boolean increaseOrDecreaseGain(int indexIncrement)
                               throws DeviceException

Specified by:

increaseOrDecreaseGain in interface AmplifierAutoGain

Throws:

DeviceException

getInstantaneousVoltage

public double getInstantaneousVoltage()
                               throws DeviceException

Specified by:

getInstantaneousVoltage in interface AmplifierAutoGain

Throws:

DeviceException

setGain

public void setGain(double newGain)
             throws DeviceException

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

setGain

public void setGain(String gain)
             throws DeviceException

This is the method which actually writes to the gain PV. It should only be passed strings taken from the getModeToGainToGainStringMap()

Specified by:

setGain in interface CurrentAmplifier

Parameters:

gain -

Throws:

DeviceException

setCouplingMode

public void setCouplingMode(String couplingMode)
                     throws DeviceException

Set the Femto coupling mode, takes a string for Jython to use

Parameters:

couplingMode - The requested coupling mode

Throws:

DeviceException

setFemtoCouplingMode

public void setFemtoCouplingMode(EpicsFemtoAmplifier.CouplingMode couplingMode)
                          throws DeviceException

Throws:

DeviceException

getCouplingMode

public String getCouplingMode()
                       throws DeviceException

Specified by:

getCouplingMode in interface AmplifierAutoGain

Throws:

DeviceException

hasMultipleModes

public boolean hasMultipleModes()

Specified by:

hasMultipleModes in interface AmplifierAutoGain

getModeToGainToGainStringMap

public Map<String,Map<String,String>> getModeToGainToGainStringMap()

setModeToGainToGainStringMap

public void setModeToGainToGainStringMap(Map<String,Map<String,String>> modeToGainToGainStringMap)

isSupportsCoupling

public boolean isSupportsCoupling()

Specified by:

isSupportsCoupling in interface AmplifierAutoGain

setSupportsCoupling

public void setSupportsCoupling(boolean supportsCoupling)

getLowerVoltageBound

public double getLowerVoltageBound()

Specified by:

getLowerVoltageBound in interface AmplifierAutoGain

setLowerVoltageBound

public void setLowerVoltageBound(double lowerVoltageBound)

getUpperVoltageBound

public double getUpperVoltageBound()

Specified by:

getUpperVoltageBound in interface AmplifierAutoGain

setUpperVoltageBound

public void setUpperVoltageBound(double upperVoltageBound)

getSettleTime

public long getSettleTime()

setSettleTime

public void setSettleTime(long settleTime)

isHasIinPV

public boolean isHasIinPV()

setHasIinPV

public void setHasIinPV(boolean hasIinPV)

getBasePVName

public String getBasePVName()

setBasePVName

public void setBasePVName(String basePVName)

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

getGainUnits

public String[] getGainUnits()
                      throws DeviceException

Description copied from interface: CurrentAmplifier

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

Specified by:

getGainUnits in interface CurrentAmplifier

Overrides:

getGainUnits in class CurrentAmplifierBase

Returns:

an array of gain units

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

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

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

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

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

listGains

public void listGains()
               throws DeviceException

Description copied from interface: CurrentAmplifier

returns a parsed list of gains available for this amplifier.

Specified by:

listGains in interface CurrentAmplifier

Throws:

DeviceException