Package uk.ac.diamond.daq.beamline.i06_shared.scannables

Class BeforeAfterScannables

java.lang.Object

gda.factory.ConfigurableBase

gda.factory.FindableConfigurableBase

gda.device.DeviceBase

gda.device.scannable.ScannableBase

gda.device.scannable.ScannableMotionBase

gda.device.scannable.ScannableMotionUnitsBase

uk.ac.diamond.daq.beamline.i06_shared.scannables.BeforeAfterScannables

All Implemented Interfaces:

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

public class BeforeAfterScannables
extends ScannableMotionUnitsBase

Field Summary

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
BeforeAfterScannables()
BeforeAfterScannables(ScannableMotionUnits delegate, Map<Scannable,Object> beforeScannables, Map<Scannable,Object> afterScannables)

Method Summary

Modifier and Type	Method	Description
Map<Scannable,Object>	getAfterScannables()
Map<Scannable,Object>	getBeforeScannables()
long	getDelayBeforeMovingDelegate()
Scannable	getDelegate()
List<String>	getJythonCommandsAfter()
List<String>	getJythonCommandsBefore()
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	setAfterScannables(Map<Scannable,Object> afterScannables)
void	setBeforeScannables(Map<Scannable,Object> beforeScannables)
void	setDelayBeforeMovingDelegate(long milliseconds)	Minimum time to wait between initial move of 'beforeAfter' and before moving 'delegate'.
void	setDelegate(Scannable delegate)
void	setJythonCommandsAfter(List<String> jythonCommandsAfter)
void	setJythonCommandsBefore(List<String> jythonCommandsBefore)

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

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

Methods inherited from interface gda.device.ScannableMotion

a, ar, checkPositionWithinGdaLimits, checkPositionWithinGdaLimits, getLowerGdaLimits, getNumberTries, getScalingFactor, getTolerances, getUpperGdaLimits, r, setLowerGdaLimits, setLowerGdaLimits, setNumberTries, setScalingFactor, setTolerance, setTolerances, setUpperGdaLimits, setUpperGdaLimits

Constructor Details

BeforeAfterScannables

public BeforeAfterScannables()

BeforeAfterScannables

public BeforeAfterScannables(ScannableMotionUnits delegate,
 Map<Scannable,Object> beforeScannables,
 Map<Scannable,Object> afterScannables)

Method Details

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

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

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

getDelayBeforeMovingDelegate

public long getDelayBeforeMovingDelegate()

setDelayBeforeMovingDelegate

public void setDelayBeforeMovingDelegate(long milliseconds)

Minimum time to wait between initial move of 'beforeAfter' and before moving 'delegate'.

getDelegate

public Scannable getDelegate()

setDelegate

public void setDelegate(Scannable delegate)

getBeforeScannables

public Map<Scannable,Object> getBeforeScannables()

setBeforeScannables

public void setBeforeScannables(Map<Scannable,Object> beforeScannables)

getAfterScannables

public Map<Scannable,Object> getAfterScannables()

setAfterScannables

public void setAfterScannables(Map<Scannable,Object> afterScannables)

getJythonCommandsBefore

public List<String> getJythonCommandsBefore()

setJythonCommandsBefore

public void setJythonCommandsBefore(List<String> jythonCommandsBefore)

getJythonCommandsAfter

public List<String> getJythonCommandsAfter()

setJythonCommandsAfter

public void setJythonCommandsAfter(List<String> jythonCommandsAfter)