Package gda.device.scannable

Class DummyScannable

java.lang.Object

gda.factory.ConfigurableBase

gda.factory.FindableConfigurableBase

gda.device.DeviceBase

gda.device.scannable.ScannableBase

gda.device.scannable.ScannableMotionBase

gda.device.scannable.DummyScannable

All Implemented Interfaces:

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

Direct Known Subclasses:

AbsorptionCoefficient, DataReductionScannable, DoseCalculator, DummyPersistentScannable, DummyScannableMotor, EndstationPhotonEnergyProvider

@ServiceInterface(ScannableMotion.class)
public class DummyScannable
extends ScannableMotionBase
implements ControllerRecord

Dummy object extending ScannableMotion which represents a single number.

Field Summary

Fields

Modifier and Type	Field	Description
protected double	currentPosition
protected double	increment

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
DummyScannable()
DummyScannable(String name)
DummyScannable(String name, double d)
DummyScannable(String name, double d, String pvName)

Method Summary

Modifier and Type	Method	Description
String	getControllerRecordName()	Gets the name of the controller record, e.g.
Object	getPosition()	Returns the current position of the Scannable.
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	setControllerRecordName(String controllerRecordName)
void	setIncrement(Double increment)
void	setName(String name)	Set the name of the device

Methods inherited from class gda.device.scannable.ScannableMotionBase

a, addPositionValidator, ar, asynchronousMoveTo, 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__, atCommandFailure, atLevelEnd, atLevelMoveStart, atLevelStart, atPointEnd, atPointStart, atScanEnd, atScanLineEnd, atScanLineStart, atScanStart, getExtraNames, getInputNames, getLevel, getOutputFormat, 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, 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

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, setExtraNames, setInputNames, setLevel, setOutputFormat, setScanMetadataAttribute, setScanMetadataAttributes, stop, waitWhileBusy

Field Details

currentPosition

protected double currentPosition

increment

protected double increment

Constructor Details

DummyScannable

public DummyScannable()

DummyScannable

public DummyScannable(String name)

DummyScannable

public DummyScannable(String name,
 double d)

DummyScannable

public DummyScannable(String name,
 double d,
 String pvName)

Method Details

setName

public void setName(String name)

Description copied from class: DeviceBase

Set the name of the device

Specified by:

setName in interface Findable

Overrides:

setName in class DeviceBase

Parameters:

name - The name to set.

setIncrement

public void setIncrement(Double increment)

getControllerRecordName

public String getControllerRecordName()

Description copied from interface: ControllerRecord

Gets the name of the controller record, e.g. EPICS process variable name. For example, in NeXus this value can be written as the value of the controller_record field for the NXpositioner for the scannable.

Specified by:

getControllerRecordName in interface ControllerRecord

Returns:

controller record name

See Also:

• Nexus documentation for NXpositioner

setControllerRecordName

public void setControllerRecordName(String controllerRecordName)

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

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

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