Package gda.device.scannable

Class RingCurrentMonitor

java.lang.Object

gda.factory.ConfigurableBase

gda.factory.FindableConfigurableBase

gda.device.DeviceBase

gda.device.scannable.ScannableBase

gda.device.scannable.BeamlineConditionMonitorBase

gda.device.scannable.PVConditionMonitorBase

gda.device.scannable.RingCurrentMonitor

All Implemented Interfaces:

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

public class RingCurrentMonitor
extends PVConditionMonitorBase

A zero-input, zero-output Scannable which when used in a scan will pause the scan if the machine ring current drops below 1mA.

It will resume the scan once the machine current returns.

This should be used with something else which checks for shutters etc. as the ring current returning should not be the only check to confirm beam is on target.

Field Summary

Fields inherited from class gda.device.scannable.PVConditionMonitorBase

controller, theChannel

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
RingCurrentMonitor()

Method Summary

Modifier and Type	Method	Description
String	getRingCurrentPV()
protected boolean	machineHasCurrent()
void	setRingCurrentPV(String ringCurrentPV)
protected void	testShouldPause()	The test is performed inside this method.

Methods inherited from class gda.device.scannable.PVConditionMonitorBase

atScanStart, configure, getThePV, initializationCompleted, isConnected, setThePV

Methods inherited from class gda.device.scannable.BeamlineConditionMonitorBase

atPointStart, atScanLineStart, getMachineModeMonitor, isBusy, isPauseBeforeLine, isPauseBeforePoint, isPauseBeforeScan, machineIsRunning, rawAsynchronousMoveTo, rawGetPosition, sendAndPrintMessage, setMachineModeMonitor, setPauseBeforeLine, setPauseBeforePoint, setPauseBeforeScan

Methods inherited from class gda.device.scannable.ScannableBase

__call__, __call__, __doc__, __getitem__, __len__, __repr__, __str__, asynchronousMoveTo, atCommandFailure, atLevelEnd, atLevelMoveStart, atLevelStart, atPointEnd, atScanEnd, atScanLineEnd, 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

RingCurrentMonitor

public RingCurrentMonitor()

Method Details

testShouldPause

protected void testShouldPause()
                        throws DeviceException

Description copied from class: BeamlineConditionMonitorBase

The test is performed inside this method. An inheriting class could either wait inside this method until the condition has passed, or throw an Exception to end the scan, or throw a RedoScanLineThrowable to repeat the current scan.

Specified by:

testShouldPause in class BeamlineConditionMonitorBase

Throws:

DeviceException

See Also:

• ConcurrentScan

machineHasCurrent

protected boolean machineHasCurrent()

setRingCurrentPV

public void setRingCurrentPV(String ringCurrentPV)

getRingCurrentPV

public String getRingCurrentPV()