Package gda.device.scannable

Class XESEnergyScannable

java.lang.Object

gda.factory.ConfigurableBase

gda.factory.FindableConfigurableBase

gda.device.DeviceBase

gda.device.scannable.ScannableBase

gda.device.scannable.ScannableMotionBase

gda.device.scannable.ScannableMotionUnitsBase

gda.device.scannable.XESEnergyScannable

All Implemented Interfaces:

INeXusInfoWriteable, Device, Scannable, ScannableMotion, ScannableMotionUnits, IXesEnergyScannable, Configurable, Findable, gda.observable.IObservable, gda.observable.IObserver

@ServiceInterface(IXesEnergyScannable.class)
public class XESEnergyScannable
extends ScannableMotionUnitsBase
implements gda.observable.IObserver, IXesEnergyScannable

Field Summary

Fields inherited from class gda.device.scannable.ScannableMotionUnitsBase

unitsComponent

Fields inherited from class gda.device.scannable.ScannableMotionBase

numberTries, tolerance

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

Fields inherited from interface gda.device.ScannableMotion

FIRSTINPUTLIMITS

Fields inherited from interface gda.device.ScannableMotionUnits

HARDWAREUNITS, USERUNITS

Constructor Summary

Constructors

Constructor	Description
XESEnergyScannable()

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.
int[]	getCrystalCut()
Scannable	getCut1()
Scannable	getCut2()
Scannable	getCut3()
double[]	getEnergyRange()
Scannable	getMaterial()
CrystalParameters.CrystalMaterial	getMaterialType()
Map<String,Double>	getPositionsMap(double energy)	Calculate the positions of all the scannables in the spectrometer for the given energy (This function is called by the client on the exported XesEnergyScannable object)
double	getRadius()
Map<Scannable,Double>	getScannablePositionsMap(double energy)	Calculate the positions of all scannables for the given energy
IXesSpectrometerScannable	getXes()
boolean	isBusy()	Check if the Scannable is moving/operating.
void	rawAsynchronousMoveTo(Object position)	[Consider abstract] Trigger a move/operation to an internal/hardware position and return immediately.
Object	rawGetPosition()	[Consider abstract] Read the position in its internal (user) representation.
void	setCut1(Scannable cut1)
void	setCut2(Scannable cut2)
void	setCut3(Scannable cut3)
void	setMaterial(Scannable material)
void	setXes(IXesSpectrometerScannable xes)
void	stop()	Stop the current move/operation.
void	update(Object source, Object arg)

Methods inherited from class gda.device.scannable.ScannableMotionUnitsBase

addAcceptableUnit, externalToInternal, getAcceptableUnits, getAttribute, getHardwareUnitString, getInitialUserUnits, getOffset, getUserUnits, internalToExternal, isAt, setHardwareUnitString, setInitialUserUnits, setOffset, setOffset, setUserUnits, toFormattedString

Methods inherited from class gda.device.scannable.ScannableMotionBase

a, addPositionValidator, ar, asynchronousMoveTo, checkPositionValid, checkPositionWithinGdaLimits, checkPositionWithinGdaLimits, completeInstantiation, generateScannableLimitsReport, getAdditionalPositionValidators, getFirstInputLimits, getInputLimits, getInputLimits, getLimitsComponent, getLowerGdaLimits, getNumberTries, getScalingFactor, getTolerances, getUpperGdaLimits, moveTo, r, rawIsBusy, removePositionValidator, setAdditionalPositionValidators, setLimitsComponent, setLowerGdaLimits, setLowerGdaLimits, setNumberTries, setOffsetAndScalingComponent, setScalingFactor, setTolerance, setTolerances, setUpperGdaLimits, setUpperGdaLimits, writeNeXusInformation, writeNeXusInformationLimits

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, getExtraNames, getInputNames, getLevel, getOutputFormat, getPosition, getScanMetadataAttribute, getScanMetadataAttributeNames, getScanMetadataAttributes, setExtraNames, setInputNames, setLevel, setOutputFormat, setScanMetadataAttribute, setScanMetadataAttributes, throwExceptionIfInvalidTarget, toString, validateScannable, valueUnavailableString, waitWhileBusy, waitWhileBusy

Methods inherited from class gda.device.DeviceBase

addIObserver, close, deleteIObserver, deleteIObservers, 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

asynchronousMoveTo, 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, toFormattedString, waitWhileBusy

Methods inherited from interface gda.device.ScannableMotion

a, ar, checkPositionWithinGdaLimits, checkPositionWithinGdaLimits, getLowerGdaLimits, getNumberTries, getOffset, getScalingFactor, getTolerances, getUpperGdaLimits, r, setLowerGdaLimits, setLowerGdaLimits, setNumberTries, setOffset, setScalingFactor, setTolerance, setTolerances, setUpperGdaLimits, setUpperGdaLimits

Methods inherited from interface gda.device.ScannableMotionUnits

addAcceptableUnit, getAcceptableUnits, getHardwareUnitString, getUserUnits, setHardwareUnitString, setOffset, setUserUnits

Constructor Details

XESEnergyScannable

public XESEnergyScannable()

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 ConfigurableBase

isBusy

public boolean isBusy()
               throws DeviceException

Description copied from class: ScannableMotionBase

Check if the Scannable is moving/operating.. Calls onto rawIsBusy for historical reasons, although there is currently no need for this.

Specified by:

isBusy in interface Scannable

Overrides:

isBusy in class ScannableMotionBase

Returns:

true - if operation carried out by moveTo has not completed yet

Throws:

DeviceException

See Also:

• Scannable.isBusy()

update

public void update(Object source,
 Object arg)

Specified by:

update in interface gda.observable.IObserver

getCrystalCut

public int[] getCrystalCut()
                    throws DeviceException

Specified by:

getCrystalCut in interface IXesEnergyScannable

Returns:

Array of crystal cut values

Throws:

DeviceException

getMaterialType

public CrystalParameters.CrystalMaterial getMaterialType()
                                                  throws DeviceException

Specified by:

getMaterialType in interface IXesEnergyScannable

Returns:

CrystalMaterial ordinal value for the crystal material i.e. 0 = Si, 1 = Ge (see

invalid reference

CrystalParameters#CrystalMaterial

)

Throws:

DeviceException

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 ScannableBase

Parameters:

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

Throws:

DeviceException

See Also:

• asynchronousMoveTo

rawGetPosition

public Object rawGetPosition()
                      throws DeviceException

Description copied from class: ScannableBase

[Consider abstract] Read the position in its internal (user) representation.

Overrides:

rawGetPosition in class ScannableBase

Returns:

the value represented by this Scannable

Throws:

DeviceException

See Also:

• Scannable.getPosition()

stop

public void stop()
          throws DeviceException

Description copied from class: ScannableBase

Stop the current move/operation. Default behaviour is to do nothing. Inheriting classes have the option to implement this if their specific behaviour requires it.

Specified by:

stop in interface Scannable

Overrides:

stop in class ScannableBase

Throws:

DeviceException

See Also:

• Scannable.stop()

getXes

public IXesSpectrometerScannable getXes()

setXes

public void setXes(IXesSpectrometerScannable xes)

getCut1

public Scannable getCut1()

setCut1

public void setCut1(Scannable cut1)

getCut2

public Scannable getCut2()

setCut2

public void setCut2(Scannable cut2)

getCut3

public Scannable getCut3()

setCut3

public void setCut3(Scannable cut3)

getMaterial

public Scannable getMaterial()

setMaterial

public void setMaterial(Scannable material)

getRadius

public double getRadius()
                 throws DeviceException

Specified by:

getRadius in interface IXesEnergyScannable

Returns:

Radius of spectrometer Rowland circle.

Throws:

DeviceException

getPositionsMap

public Map<String,Double> getPositionsMap(double energy)
                                   throws DeviceException

Description copied from interface: IXesEnergyScannable

Calculate the positions of all the scannables in the spectrometer for the given energy (This function is called by the client on the exported XesEnergyScannable object)

Specified by:

getPositionsMap in interface IXesEnergyScannable

Parameters:

energy -

Returns:

Map with key = scannable name, value = position.

Throws:

DeviceException

getScannablePositionsMap

public Map<Scannable,Double> getScannablePositionsMap(double energy)
                                               throws DeviceException

Calculate the positions of all scannables for the given energy

Parameters:

energy -

Returns:

map of scannable positions (key=scannable, value=position)

Throws:

DeviceException

getEnergyRange

public double[] getEnergyRange()
                        throws DeviceException

Specified by:

getEnergyRange in interface IXesEnergyScannable

Returns:

Return an array containing the energy range allowed for this spectrometer [low energy, high energy]

Throws:

DeviceException