Package gda.device.scannable

Class PIE725ConstantVelocityRasterScannable

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

gda.device.scannable.PIE725ConstantVelocityRasterScannable

All Implemented Interfaces:

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

Direct Known Subclasses:

PIE725ConstantVelocityRasterScannable3Axis

public class PIE725ConstantVelocityRasterScannable
extends ScannableMotionWithScannableFieldsBase

A Scannable suitable for use in ConstantVelocityRasterScans inorder to control a PIE725 2d piezo controller.

WFrom Jython two fields will be made, name.nameX and name.nameY which represent the x and y dimensions of stage respectively. Us e.g.:

ConstantVelocityRasterScan([name.nameY, s, s, s, name.nameX, s, s, s, deta, time ...])

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 PVWithSeparateReadback<Double>	pvXpair
protected PVWithSeparateReadback<Double>	pvYpair

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
PIE725ConstantVelocityRasterScannable(String name, String pvName)

Method Summary

Modifier and Type	Method	Description
void	atCommandFailure()	Hook to be used by Scan and pos commands to inform the Scannable that an exception, such as a DeviceExcpetion, has occurred.
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	stop()	Stop the current move/operation.

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

__getattr__, addChildToMove, asynchronousMoveFieldTo, asynchronousMoveTo, atScanEnd, atScanStart, completePartialMoveTarget, createScannableForEachField, getContinuousMoveController, getFieldPosition, getFieldScannable, getPositionAtScanStart, getPositionWhileMovingContinuousely, isAutoCompletePartialMoveToTargets, isOperatingContinously, isTargeting, isUsePositionAtScanStartWhenCompletingPartialMoves, setAutoCompletePartialMoveToTargets, setChildTarget, setContinuousMoveController, setExtraNames, setInputNames, setMembers, setOperatingContinuously, setPositionAtScanStart, setUsePositionAtScanStartWhenCompletingPartialMoves, 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

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

pvXpair

protected PVWithSeparateReadback<Double> pvXpair

pvYpair

protected PVWithSeparateReadback<Double> pvYpair

Constructor Details

PIE725ConstantVelocityRasterScannable

public PIE725ConstantVelocityRasterScannable(String name,
 String pvName)

Parameters:

name -

pvName - e.g. BL16I-EA-PIEZO-01:C1:

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 ScannableMotionWithScannableFieldsBase

Returns:

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

Throws:

DeviceException

See Also:

• Scannable.isBusy()

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 ScannableMotionWithScannableFieldsBase

Throws:

DeviceException

See Also:

• Scannable.stop()

atCommandFailure

public void atCommandFailure()
                      throws DeviceException

Description copied from class: ScannableBase

Hook to be used by Scan and pos commands to inform the Scannable that an exception, such as a DeviceExcpetion, has occurred. However not called when the command is aborted using an InterruptionException. If a Scan is aborted then only Scannable.stop() will be called by the Scan or pos command.

Useful for telling Scannables which hold state during a scan for example, to reset themselves. Used for example by CoordinatedMotionScannables. This hook should be used not in the same way as the stop hook. Default behaviour is to do nothing. Inheriting classes have the option to implement this if their specific behaviour requires it.

Specified by:

atCommandFailure in interface Scannable

Overrides:

atCommandFailure in class ScannableMotionWithScannableFieldsBase

Throws:

DeviceException

See Also:

• Scannable.atCommandFailure()