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

Class HklScannable

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

All Implemented Interfaces:

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

Direct Known Subclasses:

ParametrisedHklScannable

public class HklScannable
extends ScannableMotionWithScannableFieldsBase

Nested Class Summary

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

ScannableMotionWithScannableFieldsBase.ScannableField

Field Summary

Fields

Modifier and Type	Field	Description
protected DiffcalcContext	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
HklScannable()

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.
DiffcalcContext	getDiffcalcContext()
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	setDiffcalcContext(DiffcalcContext diffcalcContext)
String	simulateMoveTo(Object position)

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

diffcalcContext

protected DiffcalcContext diffcalcContext

Constructor Details

HklScannable

public HklScannable()

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

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

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

simulateMoveTo

public String simulateMoveTo(Object position)
                      throws DeviceException

Throws:

DeviceException

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 ScannableMotionWithScannableFieldsBase

Returns:

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

Throws:

DeviceException

See Also:

• Scannable.isBusy()

getDiffcalcContext

public DiffcalcContext getDiffcalcContext()

setDiffcalcContext

public void setDiffcalcContext(DiffcalcContext diffcalcContext)