Package uk.ac.gda.beamline.i20.scannable

Class MonoMoveWithOffsetScannable

java.lang.Object

gda.factory.ConfigurableBase

gda.factory.FindableConfigurableBase

gda.device.DeviceBase

gda.device.scannable.ScannableBase

gda.device.scannable.ScannableMotionBase

uk.ac.gda.beamline.i20.scannable.MonoMoveWithOffsetScannable

All Implemented Interfaces:

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

public class MonoMoveWithOffsetScannable
extends ScannableMotionBase

Scannable to move bragg and also adjust bragg offset for each move.

Since:

26/8/2016

Field Summary

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
MonoMoveWithOffsetScannable(String name, Scannable bragg, Scannable braggOffset)

Method Summary

Modifier and Type	Method	Description
void	adjustBraggOffsetMotor(double energy)	Apply the offset for specified energy to offset motor.
boolean	getAdjustBraggOffset()
Scannable	getBragg()
double	getEnergyOffsetStart()
boolean	getIncludeOffsetInPosition()
String	getLoopType()
MonoOptimisation	getMonoOptimiser()
int	getNumStepsPerInnerLoop()
double	getOffsetForEnergy(double energy)	Calculate bragg offset for given value of bragg energy
double	getOffsetGradient()
double	getOffsetLastMove()
double	getOffsetMoveThreshold()
double	getOffsetStartValue()
Object	getPosition()	Returns the current position of the Scannable.
int	getScanType()
double	getTimePerStepInnerLoop()
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.
void	setAdjustBraggOffset(boolean adjustBraggOffset)
void	setEnergyOffsetStart(double energyOffsetStart)
void	setIncludeOffsetInPosition(boolean includeOffsetInPosition)
void	setLoopType(String loopType)
void	setMonoOptimiser(MonoOptimisation monoOptimiser)
void	setNumStepsPerInnerLoop(int numStepsPerInnerLoop)
void	setOffsetGradient(double offsetGradient)
void	setOffsetMoveThreshold(double offsetMoveThreshold)
void	setOffsetStartValue(double offsetStartValue)
void	setScanType(int scanType)
void	setTimePerStepInnerLoop(double timePerStepInnerLoop)

Methods inherited from class gda.device.scannable.ScannableMotionBase

a, addPositionValidator, ar, asynchronousMoveTo, 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__, atCommandFailure, atLevelEnd, atLevelMoveStart, atLevelStart, atPointEnd, atPointStart, atScanEnd, atScanLineEnd, atScanLineStart, atScanStart, getExtraNames, getInputNames, getLevel, getOutputFormat, getScanMetadataAttribute, getScanMetadataAttributeNames, getScanMetadataAttributes, rawGetPosition, setExtraNames, setInputNames, setLevel, setOutputFormat, setScanMetadataAttribute, setScanMetadataAttributes, stop, 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, 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

atCommandFailure, atLevelEnd, atLevelMoveStart, atLevelStart, atPointEnd, atPointStart, atScanEnd, atScanLineEnd, atScanLineStart, atScanStart, getExtraNames, getInputNames, getLevel, getOutputFormat, getScanMetadataAttribute, getScanMetadataAttributeNames, getScanMetadataAttributes, setExtraNames, setInputNames, setLevel, setOutputFormat, setScanMetadataAttribute, setScanMetadataAttributes, stop, waitWhileBusy

Constructor Details

MonoMoveWithOffsetScannable

public MonoMoveWithOffsetScannable(String name,
 Scannable bragg,
 Scannable braggOffset)

Method Details

getTimePerStepInnerLoop

public double getTimePerStepInnerLoop()

setTimePerStepInnerLoop

public void setTimePerStepInnerLoop(double timePerStepInnerLoop)

getMonoOptimiser

public MonoOptimisation getMonoOptimiser()

setMonoOptimiser

public void setMonoOptimiser(MonoOptimisation monoOptimiser)

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

getIncludeOffsetInPosition

public boolean getIncludeOffsetInPosition()

setIncludeOffsetInPosition

public void setIncludeOffsetInPosition(boolean includeOffsetInPosition)

getPosition

public Object getPosition()
                   throws DeviceException

Description copied from class: ScannableBase

Returns the current position of the Scannable. Called by ConcurentScan at the end of the point. Reads an internal (hardware) position from rawGetPosition, converts this to an external (user) position and returns it.

Specified by:

getPosition in interface Scannable

Overrides:

getPosition in class ScannableBase

Returns:

Current position with an element for each input and extra field. null if their are no fields.

Throws:

DeviceException

getOffsetForEnergy

public double getOffsetForEnergy(double energy)

Calculate bragg offset for given value of bragg energy

adjustBraggOffsetMotor

public void adjustBraggOffsetMotor(double energy)
                            throws DeviceException

Apply the offset for specified energy to offset motor.

Parameters:

energy -

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

getLoopType

public String getLoopType()

setLoopType

public void setLoopType(String loopType)

getNumStepsPerInnerLoop

public int getNumStepsPerInnerLoop()

setNumStepsPerInnerLoop

public void setNumStepsPerInnerLoop(int numStepsPerInnerLoop)

getScanType

public int getScanType()

setScanType

public void setScanType(int scanType)

getOffsetLastMove

public double getOffsetLastMove()

getOffsetGradient

public double getOffsetGradient()

setOffsetGradient

public void setOffsetGradient(double offsetGradient)

getEnergyOffsetStart

public double getEnergyOffsetStart()

setEnergyOffsetStart

public void setEnergyOffsetStart(double energyOffsetStart)

getOffsetMoveThreshold

public double getOffsetMoveThreshold()

setOffsetMoveThreshold

public void setOffsetMoveThreshold(double offsetMoveThreshold)

getAdjustBraggOffset

public boolean getAdjustBraggOffset()

setAdjustBraggOffset

public void setAdjustBraggOffset(boolean adjustBraggOffset)

getOffsetStartValue

public double getOffsetStartValue()

setOffsetStartValue

public void setOffsetStartValue(double offsetStartValue)

getBragg

public Scannable getBragg()