Package gda.device.scannable

Interface ContinuouslyScannable

All Superinterfaces:

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

All Known Subinterfaces:

SimulatedContinuouslyScannable

All Known Implementing Classes:

DummyContinuouslyScannable, QexafsScannable, QexafsTestingScannable, TurboXasScannable, ZebraQexafsScannable

public interface ContinuouslyScannable
extends ScannableMotionUnits

This operates a device whose operation sends out trigger signals to HistogramDetectors to collect data.

Such Scannables will be used in ContinuousScans.

Field Summary

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

Method Summary

Modifier and Type	Method	Description
double	calculateEnergy(int frameIndex)	As this scannable controls the motion, it is responsible for knowing the energy at each frame
void	continuousMoveComplete()	Once move and data collection complete, reverts any hardware settings etc.
ContinuousParameters	getContinuousParameters()
int	getNumberOfDataPoints()	The actual hardware might not be able to return exactly the numbner of points requested.
void	performContinuousMove()	Perform the move based on the supplied continuous parameters.
void	prepareForContinuousMove()	Prepare hardware for the continuous move.
void	setContinuousParameters(ContinuousParameters parameters)	Sets the parameters which define the continuous movement to use

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

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

Methods inherited from interface gda.device.ScannableMotion

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

Methods inherited from interface gda.device.ScannableMotionUnits

addAcceptableUnit, getAcceptableUnits, getHardwareUnitString, getUserUnits, setHardwareUnitString, setOffset, setUserUnits

Method Details

setContinuousParameters

void setContinuousParameters(ContinuousParameters parameters)

Sets the parameters which define the continuous movement to use

Parameters:

parameters -

getContinuousParameters

ContinuousParameters getContinuousParameters()

Returns:

ContinuousParameters

prepareForContinuousMove

void prepareForContinuousMove()
                       throws DeviceException

Prepare hardware for the continuous move. This assumes that continuous parameters have been supplied.

Throws:

DeviceException

getNumberOfDataPoints

int getNumberOfDataPoints()

The actual hardware might not be able to return exactly the numbner of points requested. This method returns the actaul number the scan should expect.

Returns:

int - the number of data points which would be actually returned based on the given ContinuousParameters

performContinuousMove

void performContinuousMove()
                    throws DeviceException

Perform the move based on the supplied continuous parameters.

Throws:

DeviceException

continuousMoveComplete

void continuousMoveComplete()
                     throws DeviceException

Once move and data collection complete, reverts any hardware settings etc. set for the move.

Throws:

DeviceException

calculateEnergy

double calculateEnergy(int frameIndex)
                throws DeviceException

As this scannable controls the motion, it is responsible for knowing the energy at each frame

Parameters:

frameIndex -

Returns:

double energy in eV of the given frame

Throws:

DeviceException