Package gda.device.scannable

Class DummyContinuouslyScannable

java.lang.Object

gda.factory.ConfigurableBase

gda.factory.FindableConfigurableBase

gda.device.DeviceBase

gda.device.scannable.ScannableBase

gda.device.scannable.ScannableMotionBase

gda.device.scannable.ScannableMotionUnitsBase

gda.device.scannable.DummyContinuouslyScannable

All Implemented Interfaces:

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

public class DummyContinuouslyScannable
extends ScannableMotionUnitsBase
implements SimulatedContinuouslyScannable

Dummy implementation for testing / simulations. Works with the SimulatedBufferedDetector class.

This works on the assumption that its position is defined by a single number.

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

Method Summary

Modifier and Type	Method	Description
void	addObserver(SimulatedBufferedDetector detector)	For testing and simulation only.
void	asynchronousMoveTo(Object externalPosition)	Trigger a move/operation and return immediately.
double	calculateEnergy(int frameIndex)	As this scannable controls the motion, it is responsible for knowing the energy at each frame
String	checkPositionValid(Object illDefinedPosObject)	Checks the position against the Scannable's limits and against any additional position validators added with additionalPositionValidators().
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.
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.
Object	getPosition()	Returns the current position of the Scannable.
boolean	isBusy()	Check if the Scannable is moving/operating.
void	performContinuousMove()	Perform the move based on the supplied continuous parameters.
void	prepareForContinuousMove()	Prepare hardware for the continuous move.
void	removeObserver(SimulatedBufferedDetector detector)	For testing and simulation only.
void	run()
void	setContinuousParameters(ContinuousParameters parameters)	Sets the parameters which define the continuous movement to use

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, 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, getScanMetadataAttribute, getScanMetadataAttributeNames, getScanMetadataAttributes, rawAsynchronousMoveTo, 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

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

atCommandFailure, atLevelEnd, atLevelMoveStart, atLevelStart, atPointEnd, atPointStart, atScanEnd, atScanLineEnd, atScanLineStart, atScanStart, getExtraNames, getInputNames, getLevel, getOutputFormat, getScanMetadataAttribute, getScanMetadataAttributeNames, getScanMetadataAttributes, isAt, 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

Constructor Details

DummyContinuouslyScannable

public DummyContinuouslyScannable()

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

asynchronousMoveTo

public void asynchronousMoveTo(Object externalPosition)
                        throws DeviceException

Description copied from class: ScannableBase

Trigger a move/operation and return immediately. Implementations of this method should be non-blocking to allow concurrent motion; the isBusy method will be used to determine when the move has completed. Converts the external (user) position to an internal position and passes this to rawAsynchronousMoveTo.

Specified by:

asynchronousMoveTo in interface Scannable

Overrides:

asynchronousMoveTo in class ScannableMotionBase

Parameters:

externalPosition - Position to move to should have an element for each input field.

Throws:

DeviceException

performContinuousMove

public void performContinuousMove()
                           throws DeviceException

Description copied from interface: ContinuouslyScannable

Perform the move based on the supplied continuous parameters.

Specified by:

performContinuousMove in interface ContinuouslyScannable

Throws:

DeviceException

run

public void run()

Specified by:

run in interface Runnable

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

isBusy

public boolean isBusy()

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

See Also:

• Scannable.isBusy()

addObserver

public void addObserver(SimulatedBufferedDetector detector)

For testing and simulation only. Real hardware represented by the ContinuousScannable and DummyHistogramDetector interfaces would be physically wired together.

Parameters:

detector -

removeObserver

public void removeObserver(SimulatedBufferedDetector detector)

For testing and simulation only.

Parameters:

detector -

checkPositionValid

public String checkPositionValid(Object illDefinedPosObject)

Description copied from class: ScannableMotionBase

Checks the position against the Scannable's limits and against any additional position validators added with additionalPositionValidators().

Specified by:

checkPositionValid in interface Scannable

Overrides:

checkPositionValid in class ScannableMotionBase

Parameters:

illDefinedPosObject -

Returns:

null if position is valid, or returns a description if not.

See Also:

• Scannable.checkPositionValid(java.lang.Object)

getContinuousParameters

public ContinuousParameters getContinuousParameters()

Specified by:

getContinuousParameters in interface ContinuouslyScannable

Returns:

ContinuousParameters

setContinuousParameters

public void setContinuousParameters(ContinuousParameters parameters)

Description copied from interface: ContinuouslyScannable

Sets the parameters which define the continuous movement to use

Specified by:

setContinuousParameters in interface ContinuouslyScannable

Parameters:

parameters -

continuousMoveComplete

public void continuousMoveComplete()
                            throws DeviceException

Description copied from interface: ContinuouslyScannable

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

Specified by:

continuousMoveComplete in interface ContinuouslyScannable

Throws:

DeviceException

prepareForContinuousMove

public void prepareForContinuousMove()
                              throws DeviceException

Description copied from interface: ContinuouslyScannable

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

Specified by:

prepareForContinuousMove in interface ContinuouslyScannable

Throws:

DeviceException

calculateEnergy

public double calculateEnergy(int frameIndex)

Description copied from interface: ContinuouslyScannable

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

Specified by:

calculateEnergy in interface ContinuouslyScannable

Parameters:

frameIndex -

Returns:

double energy in eV of the given frame

getNumberOfDataPoints

public int getNumberOfDataPoints()

Description copied from interface: ContinuouslyScannable

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.

Specified by:

getNumberOfDataPoints in interface ContinuouslyScannable

Returns:

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