Package uk.ac.gda.beamline.i19.server.common.scannable

Class I19BeamlineHealthScannable

java.lang.Object

gda.factory.ConfigurableBase

gda.factory.FindableConfigurableBase

gda.device.DeviceBase

gda.device.scannable.ScannableBase

gda.device.enumpositioner.EnumPositionerBase

gda.device.enumpositioner.EditableEnumPositionerBase

gda.device.enumpositioner.DummyEnumPositioner

uk.ac.gda.beamline.i19.server.common.scannable.I19BeamlineHealthScannable

All Implemented Interfaces:

Device, EditableEnumPositioner, EnumPositioner, Scannable, Configurable, Findable, gda.observable.IObservable, gda.observable.IObserver

public class I19BeamlineHealthScannable
extends DummyEnumPositioner
implements gda.observable.IObserver

Returns whether the beamline is OK to collect data based on shutters, machine state etc.

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

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.
Scannable	getBeamCurrent()
EnumPositioner	getExptShutter1()
EnumPositioner	getExptShutter2()
EnumPositioner	getOpticsShutter()
EnumPositioner	getPortShutter()
String	getPosition()	Returns the current position of the Scannable.
EnumPositionerStatus	getStatus()	Returns the current status
void	moveTo(Object position)	Trigger a move/operation and block until completion.
void	rawAsynchronousMoveTo(Object position)	[Consider abstract] Trigger a move/operation to an internal/hardware position and return immediately.
void	setBeamCurrent(Scannable beamCurrent)
void	setExptShutter1(EnumPositioner exptShutter1)
void	setExptShutter2(EnumPositioner exptShutter2)
void	setOpticsShutter(EnumPositioner opticsShutter)
void	setPortShutter(EnumPositioner portShutter)
void	update(Object source, Object arg)

Methods inherited from class gda.device.enumpositioner.DummyEnumPositioner

addPosition, getTimeToMove, isInPos, isPosChangeEventFlag, setPosChangeEventFlag, setPosition, setTimeToMove, stop

Methods inherited from class gda.device.enumpositioner.EditableEnumPositionerBase

setPositions, setPositions

Methods inherited from class gda.device.enumpositioner.EnumPositionerBase

addPositions, checkPositionValid, clearPositions, containsPosition, createFormattedListAcceptablePositions, getNumberOfPositions, getPosition, getPositionerStatus, getPositionIndex, getPositions, getPositionsList, isBusy, setPositionerStatus, setPositionsInternal, toFormattedString

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, externalToInternal, getExtraNames, getInputNames, getLevel, getOutputFormat, getScanMetadataAttribute, getScanMetadataAttributeNames, getScanMetadataAttributes, internalToExternal, isAt, rawGetPosition, setExtraNames, setInputNames, setLevel, setOutputFormat, setScanMetadataAttribute, setScanMetadataAttributes, throwExceptionIfInvalidTarget, 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.device.EnumPositioner

getPositions, getPositionsList

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

asynchronousMoveTo, atCommandFailure, atLevelEnd, atLevelMoveStart, atLevelStart, atPointEnd, atPointStart, atScanEnd, atScanLineEnd, atScanLineStart, atScanStart, checkPositionValid, getExtraNames, getInputNames, getLevel, getOutputFormat, getScanMetadataAttribute, getScanMetadataAttributeNames, getScanMetadataAttributes, isAt, isBusy, setExtraNames, setInputNames, setLevel, setOutputFormat, setScanMetadataAttribute, setScanMetadataAttributes, toFormattedString, waitWhileBusy

Constructor Details

I19BeamlineHealthScannable

public I19BeamlineHealthScannable()

Method Details

configure

public void configure()

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 DummyEnumPositioner

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 DummyEnumPositioner

Parameters:

position - Position in its internal/hardware representation. e.g. with units and offsets removed

Throws:

DeviceException

See Also:

• asynchronousMoveTo

getPosition

public String getPosition()
                   throws DeviceException

Description copied from class: ScannableBase

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 DummyEnumPositioner

Returns:

Current position with an element for each input and extra field. null if their are no fields.

Throws:

DeviceException

getStatus

public EnumPositionerStatus getStatus()
                               throws DeviceException

Description copied from interface: EnumPositioner

Returns the current status

Specified by:

getStatus in interface EnumPositioner

Overrides:

getStatus in class DummyEnumPositioner

Returns:

the status

Throws:

DeviceException

moveTo

public void moveTo(Object position)
            throws DeviceException

Description copied from class: ScannableBase

Trigger a move/operation and block until completion. If this is overridden, asynchronousMoveTo must also be valid, and the externalToInternal conversion must be applied.

Specified by:

moveTo in interface Scannable

Overrides:

moveTo in class DummyEnumPositioner

Parameters:

position -

Throws:

DeviceException

update

public void update(Object source,
 Object arg)

Specified by:

update in interface gda.observable.IObserver

getBeamCurrent

public Scannable getBeamCurrent()

setBeamCurrent

public void setBeamCurrent(Scannable beamCurrent)

getPortShutter

public EnumPositioner getPortShutter()

setPortShutter

public void setPortShutter(EnumPositioner portShutter)

getOpticsShutter

public EnumPositioner getOpticsShutter()

setOpticsShutter

public void setOpticsShutter(EnumPositioner opticsShutter)

getExptShutter1

public EnumPositioner getExptShutter1()

setExptShutter1

public void setExptShutter1(EnumPositioner exptShutter1)

getExptShutter2

public EnumPositioner getExptShutter2()

setExptShutter2

public void setExptShutter2(EnumPositioner exptShutter2)