Package gda.device.currentamplifier

Class GainWithScalingAndOffset

java.lang.Object

gda.factory.ConfigurableBase

gda.factory.FindableConfigurableBase

gda.device.DeviceBase

gda.device.scannable.ScannableBase

gda.device.currentamplifier.GainWithScalingAndOffset

All Implemented Interfaces:

ScalingAndOffset, Device, Scannable, Configurable, Findable, gda.observable.IObservable, gov.aps.jca.event.MonitorListener, EventListener

@ServiceInterface(Scannable.class)
public class GainWithScalingAndOffset
extends ScannableBase
implements ScalingAndOffset, gov.aps.jca.event.MonitorListener

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	GainWithScalingAndOffset.MoveProhibitedException
class	GainWithScalingAndOffset.OptionsExhausedException

Field Summary

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

Constructor Summary

Constructors

Constructor	Description
GainWithScalingAndOffset()

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.
void	decreaseAmplification()
String	getDescription()	description of the transformation
Map<Integer,ScalingAndOffsetParameters>	getGaintosando()
Double	getOffset()	offset to apply
String[]	getPositions()
String	getPvName()
Double	getScaling()	what to scale values by
void	increaseAmplification()
boolean	isBusy()	Check if the Scannable is moving/operating.
boolean	isFixed()	query if the device is configured for automatically changing gain
void	monitorChanged(gov.aps.jca.event.MonitorEvent mev)
void	rawAsynchronousMoveTo(Object position)	[Consider abstract] Trigger a move/operation to an internal/hardware position and return immediately.
String	rawGetPosition()	[Consider abstract] Read the position in its internal (user) representation.
void	setFixed(boolean auto)	configure device to inhibit auto scale (optional operation, may not be supported)
void	setGaintosando(Map<Integer,ScalingAndOffsetParameters> gaintosando)
void	setPvName(String pvName)
int	str2int(String setting)

Methods inherited from class gda.device.scannable.ScannableBase

__call__, __call__, __doc__, __getitem__, __len__, __repr__, __str__, asynchronousMoveTo, atCommandFailure, atLevelEnd, atLevelMoveStart, atLevelStart, atPointEnd, atPointStart, atScanEnd, atScanLineEnd, atScanLineStart, atScanStart, checkPositionValid, externalToInternal, getExtraNames, getInputNames, getLevel, getOutputFormat, getPosition, 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

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

Constructor Details

GainWithScalingAndOffset

public GainWithScalingAndOffset()

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

isBusy

public boolean isBusy()
               throws DeviceException

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

Throws:

DeviceException

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

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

See Also:

• Scannable.getPosition()

str2int

public int str2int(String setting)

getPvName

public String getPvName()

setPvName

public void setPvName(String pvName)

getScaling

public Double getScaling()

Description copied from interface: ScalingAndOffset

what to scale values by

Specified by:

getScaling in interface ScalingAndOffset

Returns:

scaling

getOffset

public Double getOffset()

Description copied from interface: ScalingAndOffset

offset to apply

Specified by:

getOffset in interface ScalingAndOffset

Returns:

offset

getDescription

public String getDescription()

Description copied from interface: ScalingAndOffset

description of the transformation

Specified by:

getDescription in interface ScalingAndOffset

Returns:

description

monitorChanged

public void monitorChanged(gov.aps.jca.event.MonitorEvent mev)

Specified by:

monitorChanged in interface gov.aps.jca.event.MonitorListener

getPositions

public String[] getPositions()

getGaintosando

public Map<Integer,ScalingAndOffsetParameters> getGaintosando()

setGaintosando

public void setGaintosando(Map<Integer,ScalingAndOffsetParameters> gaintosando)

decreaseAmplification

public void decreaseAmplification()
                           throws DeviceException

Throws:

DeviceException

increaseAmplification

public void increaseAmplification()
                           throws DeviceException

Throws:

DeviceException

isFixed

public boolean isFixed()

Description copied from interface: ScalingAndOffset

query if the device is configured for automatically changing gain

Specified by:

isFixed in interface ScalingAndOffset

Returns:

autoscale enable status

setFixed

public void setFixed(boolean auto)

Description copied from interface: ScalingAndOffset

configure device to inhibit auto scale (optional operation, may not be supported)

Specified by:

setFixed in interface ScalingAndOffset

Parameters:

auto -