Package gda.device.monitor

Class MonitorBase

java.lang.Object

gda.factory.ConfigurableBase

gda.factory.FindableConfigurableBase

gda.device.DeviceBase

gda.device.scannable.ScannableBase

gda.device.monitor.MonitorBase

All Implemented Interfaces:

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

Direct Known Subclasses:

AdcMonitor, BeamMonitor, DummyMonitor, EpicsBeamMonitor, EpicsMonitor, EtherCATSignal, IonChamberBeamMonitor, RemainingScanTimeEstimator

@ServiceInterface(Monitor.class)
public abstract class MonitorBase
extends ScannableBase
implements Monitor

Base class for objects which need to operate in scans, but which have no control over the values returned by getPosition()

This base class is important to help to distinguish types of scannables, especially when storing or presenting data from scans.

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

Constructor Summary

Constructors

Constructor	Description
MonitorBase()

Method Summary

Modifier and Type	Method	Description
void	asynchronousMoveTo(Object position)	If called with a position this triggers a delay.
int	getElementCount()	returns the number of elements in this monitor.
String	getUnit()	gets the physical unit of the monitor.
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, checkPositionValid, externalToInternal, getExtraNames, getInputNames, getLevel, getOutputFormat, getPosition, 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.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, getPosition, getScanMetadataAttribute, getScanMetadataAttributeNames, getScanMetadataAttributes, isAt, moveTo, setExtraNames, setInputNames, setLevel, setOutputFormat, setScanMetadataAttribute, setScanMetadataAttributes, stop, toFormattedString, waitWhileBusy

Constructor Details

MonitorBase

public MonitorBase()

Method Details

asynchronousMoveTo

public void asynchronousMoveTo(Object position)
                        throws DeviceException

If called with a position this triggers a delay. Very useful if the monitor is hooked up to something that calculates a running average, or that is not updated very often. 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

See Also:

• Scannable.asynchronousMoveTo(java.lang.Object)

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

getElementCount

public int getElementCount()
                    throws DeviceException

Description copied from interface: Monitor

returns the number of elements in this monitor.

Specified by:

getElementCount in interface Monitor

Returns:

int the element count

Throws:

DeviceException

getUnit

public String getUnit()
               throws DeviceException

Description copied from interface: Monitor

gets the physical unit of the monitor.

Specified by:

getUnit in interface Monitor

Returns:

String the physical unit

Throws:

DeviceException