Package gda.device.currentamplifier

Class CurrentAmplifierBase

java.lang.Object

gda.factory.ConfigurableBase

gda.factory.FindableConfigurableBase

gda.device.DeviceBase

gda.device.scannable.ScannableBase

gda.device.currentamplifier.CurrentAmplifierBase

All Implemented Interfaces:

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

Direct Known Subclasses:

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

@ServiceInterface(CurrentAmplifier.class)
public abstract class CurrentAmplifierBase
extends ScannableBase
implements CurrentAmplifier

Base class for the CurrentAmplifier interface

Nested Class Summary

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

CurrentAmplifier.Status

Field Summary

Fields

Modifier and Type	Field	Description
protected final List<String>	gainPositions
protected final List<String>	gainUnits
protected final List<String>	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
CurrentAmplifierBase()

Method Summary

Modifier and Type	Method	Description
void	asynchronousMoveTo(Object position)	Trigger a move/operation and return immediately.
String	checkPositionValid(Object position)	This default behaviour should be extended by most subclasses! This default behaviour should be extended by most subclasses! Tests if the given object is meaningful to this Scannable and so could be used by one of the move commands.
String[]	getGainPositions()	Returns an array of all possible gain positions which this device can be moved to.
String[]	getGainUnits()	Returns an array of all possible gain units which this device can be moved to.
String[]	getModePositions()	Returns an array of all possible mode positions which this device can be set to.
Object	getPosition()	Returns the current position of the Scannable.
boolean	isBusy()	Check if the Scannable is moving/operating.

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

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

getCurrent, getGain, getGainUnit, getMode, getStatus, listGains, setGain, setGainUnit, setMode

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

Field Details

gainPositions

protected final List<String> gainPositions

gainUnits

protected final List<String> gainUnits

modePositions

protected final List<String> modePositions

Constructor Details

CurrentAmplifierBase

public CurrentAmplifierBase()

Method Details

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

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

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

Returns:

an array of mode positions

Throws:

DeviceException

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 ScannableBase

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 ScannableBase

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

Returns:

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

checkPositionValid

public String checkPositionValid(Object position)

Description copied from class: ScannableBase

This default behaviour should be extended by most subclasses! Tests if the given object is meaningful to this Scannable and so could be used by one of the move commands. May check limits and other things too. This is the method called by scans on all points before the scan is run.

Specified by:

checkPositionValid in interface Scannable

Overrides:

checkPositionValid in class ScannableBase

Parameters:

position -

Returns:

null if position is valid, or returns a description if not.

See Also:

• Scannable.checkPositionValid(java.lang.Object)