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 ClassesModifier and TypeClassDescriptionclassclass -
Field Summary
Fields inherited from class gda.device.scannable.ScannableBase
__doc__, DEFAULT_INPUT_NAME, DEFAULT_OUTPUT_FORMAT, extraNames, inputNames, level, outputFormatFields inherited from class gda.device.DeviceBase
DEFAULT_PROTECTION_LEVEL_PROPERTYFields inherited from interface gda.device.Scannable
ATTR_NEXUS_CATEGORY, ATTR_NX_CLASS, VALUE_UNAVAILABLE -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidDefault 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.voiddescription of the transformationoffset to applyString[]what to scale values byvoidbooleanisBusy()Check if the Scannable is moving/operating.booleanisFixed()query if the device is configured for automatically changing gainvoidmonitorChanged(gov.aps.jca.event.MonitorEvent mev) voidrawAsynchronousMoveTo(Object position) [Consider abstract] Trigger a move/operation to an internal/hardware position and return immediately.[Consider abstract] Read the position in its internal (user) representation.voidsetFixed(boolean auto) configure device to inhibit auto scale (optional operation, may not be supported)voidsetGaintosando(Map<Integer, ScalingAndOffsetParameters> gaintosando) voidintMethods 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, waitWhileBusyMethods inherited from class gda.device.DeviceBase
addIObserver, close, deleteIObserver, deleteIObservers, getAttribute, getName, getProtectionLevel, isBeingObserved, isConfigureAtStartup, notifyIObservers, setAttribute, setConfigureAtStartup, setName, setProtectionLevelMethods inherited from class gda.factory.ConfigurableBase
isConfigured, reconfigure, setConfiguredMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface gda.factory.Configurable
isConfigureAtStartup, isConfigured, reconfigureMethods inherited from interface gda.device.Device
close, getAttribute, getProtectionLevel, setAttribute, setProtectionLevelMethods inherited from interface gda.observable.IObservable
addIObserver, deleteIObserver, deleteIObservers
-
Constructor Details
-
GainWithScalingAndOffset
public GainWithScalingAndOffset()
-
-
Method Details
-
configure
Description copied from class:ConfigurableBaseDefault 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:
configurein interfaceConfigurable- Overrides:
configurein classConfigurableBase- Throws:
FactoryException- if there is an error in configuration e.g. required variable not set or cannot connect to device
-
isBusy
Description copied from interface:ScannableCheck if the Scannable is moving/operating.- Specified by:
isBusyin interfaceScannable- Returns:
- true - if operation carried out by moveTo has not completed yet
- Throws:
DeviceException
-
rawAsynchronousMoveTo
Description copied from class:ScannableBase[Consider abstract] Trigger a move/operation to an internal/hardware position and return immediately.- Overrides:
rawAsynchronousMoveToin classScannableBase- Parameters:
position- Position in its internal/hardware representation. e.g. with units and offsets removed- Throws:
DeviceException- See Also:
-
rawGetPosition
Description copied from class:ScannableBase[Consider abstract] Read the position in its internal (user) representation.- Overrides:
rawGetPositionin classScannableBase- Returns:
- the value represented by this Scannable
- See Also:
-
str2int
-
getPvName
-
setPvName
-
getScaling
Description copied from interface:ScalingAndOffsetwhat to scale values by- Specified by:
getScalingin interfaceScalingAndOffset- Returns:
- scaling
-
getOffset
Description copied from interface:ScalingAndOffsetoffset to apply- Specified by:
getOffsetin interfaceScalingAndOffset- Returns:
- offset
-
getDescription
Description copied from interface:ScalingAndOffsetdescription of the transformation- Specified by:
getDescriptionin interfaceScalingAndOffset- Returns:
- description
-
monitorChanged
public void monitorChanged(gov.aps.jca.event.MonitorEvent mev) - Specified by:
monitorChangedin interfacegov.aps.jca.event.MonitorListener
-
getPositions
-
getGaintosando
-
setGaintosando
-
decreaseAmplification
- Throws:
DeviceException
-
increaseAmplification
- Throws:
DeviceException
-
isFixed
public boolean isFixed()Description copied from interface:ScalingAndOffsetquery if the device is configured for automatically changing gain- Specified by:
isFixedin interfaceScalingAndOffset- Returns:
- autoscale enable status
-
setFixed
public void setFixed(boolean auto) Description copied from interface:ScalingAndOffsetconfigure device to inhibit auto scale (optional operation, may not be supported)- Specified by:
setFixedin interfaceScalingAndOffset- Parameters:
auto-
-