Package gda.device.currentamplifier

Class StanfordScannable

java.lang.Object

gda.factory.ConfigurableBase

gda.factory.FindableConfigurableBase

gda.device.DeviceBase

gda.device.scannable.ScannableBase

gda.device.currentamplifier.CurrentAmplifierBase

gda.device.currentamplifier.StanfordScannable

All Implemented Interfaces:

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

@ServiceInterface(StanfordAmplifier.class)
public class StanfordScannable
extends CurrentAmplifierBase
implements StanfordAmplifier

Scannable to drive Stanford current amplifier, originally written for B18 and moved from a B18 specific plugin to uk.ac.gda.epics. To facilitate exporting from server to client over RMI, it has been modified to implement the StanfordAmplifier interface and to extend CurrentAmplifierBase.

See also DummyStanfordScannable

Since:

12/10/2016

Nested Class Summary

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

CurrentAmplifier.Status

Field Summary

Fields

Modifier and Type	Field	Description
protected List<String>	currentOffsetUnits

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

Method Summary

Modifier and Type	Method	Description
String[]	getAllowedPositions()
double	getCurrent()	returns the current value
String	getGain()	returns the current gain position
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
int	getOffset()
int	getOffsetUnit()
String[]	getOffsetUnits()
Object	getPosition()	Returns the current position of the Scannable.
int	getSensitivity()
int	getSensitivityUnit()
CurrentAmplifier.Status	getStatus()	Returns the overload status
boolean	isBusy()	Check if the Scannable is moving/operating.
boolean	isOffsetCurrentOn()
void	listGains()	returns a parsed list of gains available for this amplifier.
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	setBase_pv(String basePv)
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	setOffset(int offset)
void	setOffsetCurrentOn(boolean switchOn)
void	setOffsetUnit(int unit)
void	setSensitivity(int sensitivityValue)
void	setSensitivityUnit(int unit)

Methods inherited from class gda.device.currentamplifier.CurrentAmplifierBase

asynchronousMoveTo, checkPositionValid, getGainPositions, getModePositions

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

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

configure, isConfigureAtStartup, isConfigured, reconfigure

Methods inherited from interface gda.device.CurrentAmplifier

getGainPositions, getModePositions

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

Field Details

currentOffsetUnits

protected List<String> currentOffsetUnits

Constructor Details

StanfordScannable

public StanfordScannable()

Method Details

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

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

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

setSensitivity

public void setSensitivity(int sensitivityValue)
                    throws DeviceException

Specified by:

setSensitivity in interface StanfordAmplifier

Throws:

DeviceException

getSensitivity

public int getSensitivity()
                   throws DeviceException

Specified by:

getSensitivity in interface StanfordAmplifier

Throws:

DeviceException

setSensitivityUnit

public void setSensitivityUnit(int unit)
                        throws DeviceException

Specified by:

setSensitivityUnit in interface StanfordAmplifier

Throws:

DeviceException

getSensitivityUnit

public int getSensitivityUnit()
                       throws DeviceException

Specified by:

getSensitivityUnit in interface StanfordAmplifier

Throws:

DeviceException

setOffsetCurrentOn

public void setOffsetCurrentOn(boolean switchOn)
                        throws DeviceException

Specified by:

setOffsetCurrentOn in interface StanfordAmplifier

Throws:

DeviceException

isOffsetCurrentOn

public boolean isOffsetCurrentOn()
                          throws DeviceException

Specified by:

isOffsetCurrentOn in interface StanfordAmplifier

Throws:

DeviceException

setOffset

public void setOffset(int offset)
               throws DeviceException

Specified by:

setOffset in interface StanfordAmplifier

Throws:

DeviceException

getOffset

public int getOffset()
              throws DeviceException

Specified by:

getOffset in interface StanfordAmplifier

Throws:

DeviceException

setOffsetUnit

public void setOffsetUnit(int unit)
                   throws DeviceException

Specified by:

setOffsetUnit in interface StanfordAmplifier

Throws:

DeviceException

getOffsetUnit

public int getOffsetUnit()
                  throws DeviceException

Specified by:

getOffsetUnit in interface StanfordAmplifier

Throws:

DeviceException

getOffsetUnits

public String[] getOffsetUnits()

Specified by:

getOffsetUnits in interface StanfordAmplifier

getAllowedPositions

public String[] getAllowedPositions()

Specified by:

getAllowedPositions in interface StanfordAmplifier

getGainUnits

public String[] getGainUnits()

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

Specified by:

getGainUnits in interface StanfordAmplifier

Overrides:

getGainUnits in class CurrentAmplifierBase

Returns:

an array of gain units

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

setBase_pv

public void setBase_pv(String basePv)

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

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

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

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

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

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

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