Package gda.exafs.xes

Interface IXesEnergyScannable

All Superinterfaces:

Configurable, Device, Findable, gda.observable.IObservable, Scannable, ScannableMotion, ScannableMotionUnits

All Known Implementing Classes:

XESEnergyScannable

public interface IXesEnergyScannable
extends ScannableMotionUnits

Field Summary

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

Method Summary

Modifier and Type	Method	Description
int[]	getCrystalCut()
double[]	getEnergyRange()
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()

Methods inherited from interface gda.factory.Configurable

configure, 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, isBusy, moveTo, setExtraNames, setInputNames, setLevel, setOutputFormat, setScanMetadataAttribute, setScanMetadataAttributes, stop, 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

Method Details

getMaterialType

CrystalParameters.CrystalMaterial getMaterialType()
                                           throws DeviceException

Returns:

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

invalid reference

CrystalParameters#CrystalMaterial

)

Throws:

DeviceException

getCrystalCut

int[] getCrystalCut()
             throws DeviceException

Returns:

Array of crystal cut values

Throws:

DeviceException

getRadius

double getRadius()
          throws DeviceException

Returns:

Radius of spectrometer Rowland circle.

Throws:

DeviceException

getPositionsMap

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

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)

Parameters:

energy -

Returns:

Map with key = scannable name, value = position.

Throws:

DeviceException

getEnergyRange

double[] getEnergyRange()
                 throws DeviceException

Returns:

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

Throws:

DeviceException