Package gda.device.monitor

Class AdcMonitor

java.lang.Object

gda.factory.ConfigurableBase

gda.factory.FindableConfigurableBase

gda.device.DeviceBase

gda.device.scannable.ScannableBase

gda.device.monitor.MonitorBase

gda.device.monitor.AdcMonitor

All Implemented Interfaces:

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

public class AdcMonitor
extends MonitorBase

Class to monitor an ADC

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
AdcMonitor()	Constructor.

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.
String	getAdcName()
int	getChannel()
int	getElementCount()	returns the number of elements in this monitor.
long	getPollTime()
Object	getPosition()	Returns the latest value of the ADC's channel this class is monitoring Returns the current position of the Scannable.
String	getUnit()	gets the physical unit of the monitor.
void	setAdcName(String adcName)
void	setChannel(int channel)
void	setPollTime(long pollTime)

Methods inherited from class gda.device.monitor.MonitorBase

asynchronousMoveTo, isBusy

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

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

Methods inherited from interface gda.device.Scannable

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

Constructor Details

AdcMonitor

public AdcMonitor()

Constructor.

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

setAdcName

public void setAdcName(String adcName)

Parameters:

adcName -

getAdcName

public String getAdcName()

Returns:

name of the monitored adc

setChannel

public void setChannel(int channel)

Parameters:

channel -

getChannel

public int getChannel()

Returns:

name of the monitored channel

setPollTime

public void setPollTime(long pollTime)

Parameters:

pollTime - the poll time in milliseconds

getPollTime

public long getPollTime()

Returns:

The poll time.

getPosition

public Object getPosition()
                   throws DeviceException

Returns the latest value of the ADC's channel this class is monitoring 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

See Also:

• Scannable.getPosition()

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

Overrides:

getElementCount in class MonitorBase

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

Overrides:

getUnit in class MonitorBase

Returns:

String the physical unit

Throws:

DeviceException