Package gda.device.scannable

Class XesSpectrometerScannableBase

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.XesSpectrometerScannableBase

All Implemented Interfaces:

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

Direct Known Subclasses:

JohannSpectrometer, XesSpectrometerScannable

public abstract class XesSpectrometerScannableBase
extends ScannableMotionUnitsBase
implements gda.observable.IObserver, IXesSpectrometerScannable

Field Summary

Fields

Modifier and Type	Field	Description
protected List<XesSpectrometerCrystal>	crystalList	List of spectrometer crystals extracted from crystals ScannableGroup
protected ScannableGroup	crystalsAllowedToMove	ScannableGroup containing Positioners that control which of the crystals are allowed to be moved.
protected ScannableGroup	crystalsGroup	ScannableGroup containing the XesSpectrometerCrystal objects for the spectrometer.
protected ScannableGroup	detectorGroup	ScannableGroup containing the detector x, y and rotation scannables
protected double	maxTheta
protected double	minTheta
protected double	radius
protected Scannable	radiusScannable

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

Method Summary

Modifier and Type	Method	Description
protected void	checkPositionValid(XesSpectrometerCrystal scannableGroup, double[] target)	Check that a target position is finite and within limits of a scannable group.
protected void	checkPositionValid(Scannable scannable, Object target)	Check that a target position is finite and within limits of a scannable.
protected Double	extractDouble(Object position)	Extract a double value from position Object (first value is returned if there is more than one present)
ScannableGroup	getCrystalsAllowedToMove()
ScannableGroup	getCrystalsGroup()
List<XesSpectrometerCrystal>	getCrystalsList()	Return a list of XesSpectrometerCrystal objects extracted from crystals ScannableGroup (set by setCrystalsGroup(ScannableGroup)).
ScannableGroup	getDetectorGroup()
Scannable	getDetRotScannable()
Scannable	getDetXScannable()
Scannable	getDetYScannable()
protected ScannableGroup	getGroupedScannables()
double	getMaxTheta()
double	getMinTheta()
double	getRadius()
Scannable	getRadiusScannable()
List<Scannable>	getScannables()
protected <T> List<T>	getScannablesOfTypeFromGroup(ScannableGroup scnGroup, Class<T> classType)
boolean	isBusy()	Check if the Scannable is moving/operating.
void	setCrystalsAllowedToMove(ScannableGroup crystalsAllowedToMove)
void	setCrystalsGroup(ScannableGroup crystalsGroup)
void	setDetectorGroup(ScannableGroup detectorGroup)
void	setMaxTheta(double maxTheta)
void	setMinTheta(double minTheta)
void	setRadius(double radius)	Set the radius of the Rowland circle
void	setRadiusScannable(Scannable radiusScannable)
void	stop()	Stop the current move/operation.
protected void	tryToUpdateRadiusFromScannable()
void	update(Object source, Object arg)
protected void	updateActiveGroups()	Update the 'allowedToMove' flag of each XesSpectrometerCrystal in the crystalList based on the crystalsAllowedToMove positioners.
protected void	updateRadiusFromScannable()
protected void	validateAndSetup()	Perform a number of validation and initialisation steps, typically called during Spring configuration by 'configure' method : Check that all required scannables have been set Set crystalList using scannables extracted from crystalsGroup object.
protected String	validatePosition(Object[] position)	Check to make sure angle position is valid.

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, rawAsynchronousMoveTo, rawGetPosition, 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

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

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.exafs.xes.IXesSpectrometerScannable

getSpectrometerPositions

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

Field Details

crystalsGroup

protected ScannableGroup crystalsGroup

ScannableGroup containing the XesSpectrometerCrystal objects for the spectrometer.

crystalList

protected List<XesSpectrometerCrystal> crystalList

List of spectrometer crystals extracted from crystals ScannableGroup

crystalsAllowedToMove

protected ScannableGroup crystalsAllowedToMove

ScannableGroup containing Positioners that control which of the crystals are allowed to be moved. // If these are left as null allowedToMove is not modified.

detectorGroup

protected ScannableGroup detectorGroup

ScannableGroup containing the detector x, y and rotation scannables

radiusScannable

protected Scannable radiusScannable

radius

protected double radius

minTheta

protected double minTheta

maxTheta

protected double maxTheta

Constructor Details

XesSpectrometerScannableBase

public XesSpectrometerScannableBase()

Method Details

validateAndSetup

protected void validateAndSetup()
                         throws FactoryException

Perform a number of validation and initialisation steps, typically called during Spring configuration by 'configure' method :

Check that all required scannables have been set

Set crystalList using scannables extracted from crystalsGroup object.

Set initial rowland circle radius from current value of radiusScannable.

Add validatePosition(Object[]) as position validator to the scannable

Throws:

FactoryException

getCrystalsList

public List<XesSpectrometerCrystal> getCrystalsList()

Return a list of XesSpectrometerCrystal objects extracted from crystals ScannableGroup (set by setCrystalsGroup(ScannableGroup)).

Returns:

List of XesSpecrtometerCrystal objects

getScannablesOfTypeFromGroup

protected <T> List<T> getScannablesOfTypeFromGroup(ScannableGroup scnGroup,
 Class<T> classType)

getRadius

public double getRadius()

Specified by:

getRadius in interface IXesSpectrometerScannable

Returns:

Radius of the Rowland circle

setRadius

public void setRadius(double radius)

Description copied from interface: IXesSpectrometerScannable

Set the radius of the Rowland circle

Specified by:

setRadius in interface IXesSpectrometerScannable

Parameters:

radius -

updateRadiusFromScannable

protected void updateRadiusFromScannable()
                                  throws DeviceException

Throws:

DeviceException

tryToUpdateRadiusFromScannable

protected void tryToUpdateRadiusFromScannable()

getMaxTheta

public double getMaxTheta()

Specified by:

getMaxTheta in interface IXesSpectrometerScannable

Returns:

The maximum allowed Bragg angle.

getMinTheta

public double getMinTheta()

Specified by:

getMinTheta in interface IXesSpectrometerScannable

Returns:

The minimum allowed Bragg angle.

getScannables

public List<Scannable> getScannables()

Specified by:

getScannables in interface IXesSpectrometerScannable

Returns:

List of all scannables controlled by the spectrometer

validatePosition

protected String validatePosition(Object[] position)
                           throws DeviceException

Check to make sure angle position is valid. i.e. is finite and between minTheta and maxTheta (This is used ScannableMotionBase.checkPositionValid(Object) to check demand position is valid).

Parameters:

position -

Returns:

null if position is valid

Throws:

DeviceException

checkPositionValid

protected void checkPositionValid(Scannable scannable,
 Object target)
                           throws DeviceException

Check that a target position is finite and within limits of a scannable. A DeviceException is thrown if it's not.

Parameters:

scannable -

target -

Throws:

DeviceException

checkPositionValid

protected void checkPositionValid(XesSpectrometerCrystal scannableGroup,
 double[] target)
                           throws DeviceException

Check that a target position is finite and within limits of a scannable group. A DeviceException is thrown if it's not.

Parameters:

scannableGroup -

target -

Throws:

DeviceException

getGroupedScannables

protected ScannableGroup getGroupedScannables()
                                       throws DeviceException

Returns:

ScannableGroup containing all scannables used by spectrometer (i.e. scannables returned by getScannables())

Throws:

DeviceException

updateActiveGroups

protected void updateActiveGroups()

Update the 'allowedToMove' flag of each XesSpectrometerCrystal in the crystalList based on the crystalsAllowedToMove positioners.

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

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

extractDouble

protected Double extractDouble(Object position)

Extract a double value from position Object (first value is returned if there is more than one present)

Parameters:

position -

Returns:

double

update

public void update(Object source,
 Object arg)

Specified by:

update in interface gda.observable.IObserver

getCrystalsGroup

public ScannableGroup getCrystalsGroup()

setCrystalsGroup

public void setCrystalsGroup(ScannableGroup crystalsGroup)

getCrystalsAllowedToMove

public ScannableGroup getCrystalsAllowedToMove()

setCrystalsAllowedToMove

public void setCrystalsAllowedToMove(ScannableGroup crystalsAllowedToMove)

getDetectorGroup

public ScannableGroup getDetectorGroup()

setDetectorGroup

public void setDetectorGroup(ScannableGroup detectorGroup)

setMinTheta

public void setMinTheta(double minTheta)

setMaxTheta

public void setMaxTheta(double maxTheta)

getDetXScannable

public Scannable getDetXScannable()

getDetYScannable

public Scannable getDetYScannable()

getDetRotScannable

public Scannable getDetRotScannable()

getRadiusScannable

public Scannable getRadiusScannable()

setRadiusScannable

public void setRadiusScannable(Scannable radiusScannable)