Package org.eclipse.scanning.example.scannable

Class MockCountingPositionScannable

java.lang.Object

org.eclipse.scanning.api.AbstractNameable

org.eclipse.scanning.api.AbstractNameableTimeoutable

org.eclipse.scanning.api.AbstractScannable<Number>

org.eclipse.scanning.api.CountableScannable<Number>

org.eclipse.scanning.example.scannable.MockScannable

org.eclipse.scanning.example.scannable.MockCountingPositionScannable

All Implemented Interfaces:

IActivatable, IBoundable<Number>, ILevel, INameable, IScanAttributeContainer, IScannable<Number>, ITerminatable, ITimeoutable, ITolerable<Number>, IPositionListenable

public class MockCountingPositionScannable
extends MockScannable

Nested Class Summary

Nested classes/interfaces inherited from interface org.eclipse.scanning.api.ITerminatable

ITerminatable.TerminationPreference

Field Summary

Fields inherited from class org.eclipse.scanning.example.scannable.MockScannable

position

Fields inherited from class org.eclipse.scanning.api.AbstractScannable

delegate

Fields inherited from interface org.eclipse.scanning.api.ILevel

MAXIMUM

Constructor Summary

Constructors

Constructor	Description
MockCountingPositionScannable(String name, double position, boolean returnPosition)

Method Summary

Modifier and Type	Method	Description
Number	getPosition()	The position is the value which should be: 1.
Number	setPosition(Number value, IPosition loc)	Moves to the position required, blocking until it is complete.

Methods inherited from class org.eclipse.scanning.example.scannable.MockScannable

abort, doRealisticMove, equalsWithinTolerance, getMaximum, getMinimum, getMoveRate, getUnit, getValues, isRealisticMove, isRequireSleep, setInitialPosition, setMaximum, setMinimum, setMoveRate, setPosition, setRealisticMove, setRequireSleep, setUnit, terminate, toString, verify

Methods inherited from class org.eclipse.scanning.api.CountableScannable

count, getCount, getMethodName, resetCount

Methods inherited from class org.eclipse.scanning.api.AbstractScannable

addPositionListener, getDeviceInformation, getLevel, getModel, getScanAttribute, getScanAttributeNames, getTolerance, isActivated, register, removePositionListener, setActivated, setLevel, setModel, setPublisher, setScanAttribute, setTolerance

Methods inherited from class org.eclipse.scanning.api.AbstractNameableTimeoutable

equals, getTimeout, hashCode, setTimeout

Methods inherited from class org.eclipse.scanning.api.AbstractNameable

getName, setName

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.eclipse.scanning.api.IBoundable

getPermittedValues

Methods inherited from interface org.eclipse.scanning.api.INameable

getName, setName

Methods inherited from interface org.eclipse.scanning.api.scan.event.IPositionListenable

getPositioner, setPositioner

Methods inherited from interface org.eclipse.scanning.api.ITimeoutable

getTimeout, setTimeout

Constructor Details

MockCountingPositionScannable

public MockCountingPositionScannable(String name,
 double position,
 boolean returnPosition)

Method Details

setPosition

public Number setPosition(Number value,
 IPosition loc)
                   throws ScanningException

Description copied from interface: IScannable

Moves to the position required, blocking until it is complete. Similar to moveTo(...) in GDA8

Specified by:

setPosition in interface IScannable<Number>

Overrides:

setPosition in class MockScannable

Parameters:

value - that this scalar should take.

loc - if within in a scan or null if not within a scan.

Returns:

the new position attained by the device, if known. (Saves additional call to getPosition()) If not know the demand value is returned. NOTE if null is returned the system will call getPosition() again.

Throws:

ScanningException

getPosition

public Number getPosition()

Description copied from interface: IBoundable

The position is the value which should be: 1. Greater than or equal to the lower 2. Less than or equal to the upper. 3. One of the permitted values, if they are not null.

Specified by:

getPosition in interface IBoundable<Number>

Overrides:

getPosition in class MockScannable

Returns: