Package uk.ac.diamond.daq.diffcalc.gda.scannables

Class ParametrisedHklScannable

java.lang.Object

gda.factory.ConfigurableBase

gda.factory.FindableConfigurableBase

gda.device.DeviceBase

gda.device.scannable.ScannableBase

gda.device.scannable.ScannableMotionBase

gda.device.scannable.scannablegroup.ScannableMotionWithScannableFieldsBase

uk.ac.diamond.daq.diffcalc.gda.scannables.HklScannable

uk.ac.diamond.daq.diffcalc.gda.scannables.ParametrisedHklScannable

All Implemented Interfaces:

INeXusInfoWriteable, Device, Scannable, ContinuouslyScannableViaController, ScannableMotion, Configurable, Findable, gda.observable.IObservable

Direct Known Subclasses:

CircHklScannable, ConicHklScannable, ConicIndexScannable, ConicThScannable

public abstract class ParametrisedHklScannable
extends HklScannable

Nested Class Summary

Nested classes/interfaces inherited from class gda.device.scannable.scannablegroup.ScannableMotionWithScannableFieldsBase

ScannableMotionWithScannableFieldsBase.ScannableField

Field Summary

Fields

Modifier and Type	Field	Description
static final String	OUTPUT_FORMAT

Fields inherited from class uk.ac.diamond.daq.diffcalc.gda.scannables.HklScannable

diffcalcContext

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

Constructor Summary

Constructors

Constructor	Description
ParametrisedHklScannable()

Method Summary

Modifier and Type	Method	Description
List<Integer>	getCachedBeamlinePositionIndices()
List<Double>	getCachedParams()
Double	getHklTolerance()
int	getNumberCachedParams()
protected abstract List<Double>	hklToParameters(List<Double> hkl)
protected abstract List<List<Double>>	parametersToHkl(List<Double> paramList)
void	rawAsynchronousMoveTo(Object params)	[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	setCachedBeamlinePositionIndices(List<Integer> cachedBeamlinePositionIndices)
void	setCachedParams(List<Double> cachedParams)
void	setHklTolerance(Double tolerance)
void	setNumberCachedParams(int numberCachedParams)

Methods inherited from class uk.ac.diamond.daq.diffcalc.gda.scannables.HklScannable

configure, getDiffcalcContext, isBusy, setDiffcalcContext, simulateMoveTo

Methods inherited from class gda.device.scannable.scannablegroup.ScannableMotionWithScannableFieldsBase

__getattr__, addChildToMove, asynchronousMoveFieldTo, asynchronousMoveTo, atCommandFailure, atScanEnd, atScanStart, completePartialMoveTarget, createScannableForEachField, getContinuousMoveController, getFieldPosition, getFieldScannable, getPositionAtScanStart, getPositionWhileMovingContinuousely, isAutoCompletePartialMoveToTargets, isOperatingContinously, isTargeting, isUsePositionAtScanStartWhenCompletingPartialMoves, setAutoCompletePartialMoveToTargets, setChildTarget, setContinuousMoveController, setExtraNames, setInputNames, setMembers, setOperatingContinuously, setPositionAtScanStart, setUsePositionAtScanStartWhenCompletingPartialMoves, stop, waitWhileBusy

Methods inherited from class gda.device.scannable.ScannableMotionBase

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

Methods inherited from class gda.device.scannable.ScannableBase

__call__, __call__, __doc__, __getitem__, __len__, __repr__, __str__, atLevelEnd, atLevelMoveStart, atLevelStart, atPointEnd, atPointStart, atScanLineEnd, atScanLineStart, getExtraNames, getInputNames, getLevel, getOutputFormat, getPosition, getScanMetadataAttribute, getScanMetadataAttributeNames, getScanMetadataAttributes, setLevel, setOutputFormat, setScanMetadataAttribute, setScanMetadataAttributes, throwExceptionIfInvalidTarget, toString, validateScannable, valueUnavailableString, 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

atLevelEnd, atLevelMoveStart, atLevelStart, atPointEnd, atPointStart, atScanLineEnd, atScanLineStart, checkPositionValid, getExtraNames, getInputNames, getLevel, getOutputFormat, getPosition, getScanMetadataAttribute, getScanMetadataAttributeNames, getScanMetadataAttributes, isAt, moveTo, setLevel, setOutputFormat, setScanMetadataAttribute, setScanMetadataAttributes, toFormattedString

Field Details

OUTPUT_FORMAT

public static final String OUTPUT_FORMAT

See Also:

• Constant Field Values

Constructor Details

ParametrisedHklScannable

public ParametrisedHklScannable()

Method Details

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 HklScannable

Returns:

the value represented by this Scannable

Throws:

DeviceException

See Also:

• Scannable.getPosition()

rawAsynchronousMoveTo

public void rawAsynchronousMoveTo(Object params)
                           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 HklScannable

Parameters:

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

Throws:

DeviceException

See Also:

• asynchronousMoveTo

parametersToHkl

protected abstract List<List<Double>> parametersToHkl(List<Double> paramList)
                                               throws DeviceException

Throws:

DeviceException

hklToParameters

protected abstract List<Double> hklToParameters(List<Double> hkl)

getNumberCachedParams

public int getNumberCachedParams()

setNumberCachedParams

public void setNumberCachedParams(int numberCachedParams)

getCachedBeamlinePositionIndices

public List<Integer> getCachedBeamlinePositionIndices()

setCachedBeamlinePositionIndices

public void setCachedBeamlinePositionIndices(List<Integer> cachedBeamlinePositionIndices)

getHklTolerance

public Double getHklTolerance()

setHklTolerance

public void setHklTolerance(Double tolerance)

getCachedParams

public List<Double> getCachedParams()

setCachedParams

public void setCachedParams(List<Double> cachedParams)