Package uk.ac.gda.server.ncd.scannable

Class ScanResetDummyUnitScannable<Q extends javax.measure.Quantity<Q>>

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

uk.ac.gda.server.ncd.scannable.ScanResetDummyUnitScannable<Q>

All Implemented Interfaces:

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

@ServiceInterface(Scannable.class)
public class ScanResetDummyUnitScannable<Q extends javax.measure.Quantity<Q>>
extends DummyUnitsScannable<Q>
implements gda.observable.IObserver

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

Method Summary

Modifier and Type	Method	Description
void	asynchronousMoveTo(Object externalPosition)	Trigger a move/operation and return immediately.
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.
Double	getPosition()	Returns the current position of the Scannable.
void	moveTo(Object position)	If the numberTries and tolerance attributes have been set then repeatedly tries to move this Scannable until the position is within the tolerance range.
void	reset()
void	setResetValue(double reset)
void	update(Object source, Object arg)

Methods inherited from class gda.device.scannable.DummyUnitsScannable

getControllerRecordName, getCurrentPosition, isBusy, setControllerRecordName, setCurrentPosition, toString

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, checkPositionValid, checkPositionWithinGdaLimits, checkPositionWithinGdaLimits, completeInstantiation, generateScannableLimitsReport, getAdditionalPositionValidators, getFirstInputLimits, getInputLimits, getInputLimits, getLimitsComponent, getLowerGdaLimits, getNumberTries, getScalingFactor, getTolerances, getUpperGdaLimits, 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, 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, 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, checkPositionValid, getExtraNames, getInputNames, getLevel, getOutputFormat, getScanMetadataAttribute, getScanMetadataAttributeNames, getScanMetadataAttributes, 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

ScanResetDummyUnitScannable

public ScanResetDummyUnitScannable()

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

getPosition

public Double 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 DummyUnitsScannable<Q extends javax.measure.Quantity<Q>>

Returns:

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

Throws:

DeviceException

moveTo

public void moveTo(Object position)
            throws DeviceException

Description copied from class: ScannableMotionBase

If the numberTries and tolerance attributes have been set then repeatedly tries to move this Scannable until the position is within the tolerance range.

Specified by:

moveTo in interface Scannable

Overrides:

moveTo in class ScannableMotionBase

Parameters:

position -

Throws:

DeviceException

See Also:

• ScannableBase.moveTo(java.lang.Object)

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 DummyUnitsScannable<Q extends javax.measure.Quantity<Q>>

Parameters:

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

Throws:

DeviceException

setResetValue

public void setResetValue(double reset)

reset

public void reset()
           throws DeviceException

Throws:

DeviceException

update

public void update(Object source,
 Object arg)

Specified by:

update in interface gda.observable.IObserver