Package uk.ac.gda.server.ncd.scannable

Class EnergyScannable

java.lang.Object

gda.factory.ConfigurableBase

gda.factory.FindableConfigurableBase

gda.device.DeviceBase

gda.device.scannable.ScannableBase

uk.ac.gda.server.ncd.scannable.EnergyScannable

All Implemented Interfaces:

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

@ServiceInterface(Scannable.class)
public class EnergyScannable
extends ScannableBase
implements gda.observable.IObserver

This is a compound scannable that operates on a bragg (wavelength determining) scannable and a number of other scannables (id_gap, detector thresholds, etc.) It is also used as metadata provider for images plotted

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

Constructor Summary

Constructors

Constructor	Description
EnergyScannable()

Method Summary

Modifier and Type	Method	Description
void	addScannable(Scannable s)
void	addScannables(Collection<Scannable> s)
void	asynchronousMoveTo(Object externalPosition)	Trigger a move/operation and return immediately.
void	clearScannables()
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	getBragg()
double	getBraggWavelength()
DiffractionCrystalEnvironment	getDiffractionCrystalEnvironment()
Object	getPosition()	Returns the current position of the Scannable.
boolean	isBusy()	Check if the Scannable is moving/operating.
void	removeScannable(Scannable s)
void	setBragg(Scannable bragg)	this bragg scannable is expected to work in keV and return double value only
void	update(Object source, Object arg)

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

Constructor Details

EnergyScannable

public EnergyScannable()

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

isBusy

public boolean isBusy()
               throws DeviceException

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

Throws:

DeviceException

asynchronousMoveTo

public void asynchronousMoveTo(Object externalPosition)
                        throws DeviceException

Description copied from class: ScannableBase

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:

externalPosition - Position to move to should have an element for each input field.

Throws:

DeviceException

getPosition

public Object 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 ScannableBase

Returns:

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

Throws:

DeviceException

addScannable

public void addScannable(Scannable s)

addScannables

public void addScannables(Collection<Scannable> s)

removeScannable

public void removeScannable(Scannable s)

clearScannables

public void clearScannables()

getBragg

public Scannable getBragg()

setBragg

public void setBragg(Scannable bragg)

this bragg scannable is expected to work in keV and return double value only

Parameters:

bragg -

getDiffractionCrystalEnvironment

public DiffractionCrystalEnvironment getDiffractionCrystalEnvironment()
                                                               throws DeviceException

Throws:

DeviceException

getBraggWavelength

public double getBraggWavelength()
                          throws DeviceException

Throws:

DeviceException

update

public void update(Object source,
 Object arg)

Specified by:

update in interface gda.observable.IObserver