Package org.eclipse.scanning.api.device

Interface IPausableDevice<T>

All Superinterfaces:

IConfigurable<T>, IDeviceRoleActor, ILevel, IModelProvider<T>, INameable, IResettableDevice, IRunnableDevice<T>, IValidator<T>

All Known Subinterfaces:

IMalcolmDevice, IRunnableEventDevice<T>, IScanDevice, IWritableDetector<T>

All Known Implementing Classes:

AbstractAreaDetectorRunnableDevice, AbstractMalcolmDevice, AbstractRunnableDevice, AreaDetectorRunnableDevice, AreaDetectorRunnableDeviceProxy, AreaDetectorRunnableDeviceWaitForArray, AreaDetectorWritingFilesRunnableDevice, ConstantVelocityDevice, DarkImageDetector, DummyMalcolmDevice, DummyMalcolmTriggeredDetector, ElectronAnalyserRunnableDevice, MalcolmDevice, MalcolmDeviceProxy, MandelbrotDetector, PosDetector, ProcessingMalcolmDevice, RandomIntDetector, RandomLineDevice, RunnableDeviceProxy, XmapRunnableDevice, XmapRunnableDeviceBase, XmapWritingFilesRunnableDevice, ZebraRunnableDevice

public interface IPausableDevice<T>
extends IRunnableDevice<T>

Field Summary

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

MAXIMUM

Method Summary

Modifier and Type	Method	Description
void	pause()	Allowed when the device is in Running state.
void	resume()	Allowed when the device is in Paused state.
void	seek(int stepNumber)	Seek to/from a point number (absolute) in the scan.

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

configure

Methods inherited from interface org.eclipse.scanning.api.device.models.IDeviceRoleActor

getRole, getSupportedScanModes, setRole

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

getLevel, setLevel

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

setModel, updateModel

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

getName, setName

Methods inherited from interface org.eclipse.scanning.api.device.IResettableDevice

reset

Methods inherited from interface org.eclipse.scanning.api.device.IRunnableDevice

abort, disable, getDeviceHealth, getDeviceState, getModel, isAlive, isDeviceBusy, latch, latch, run, run, setAlive, start, throwFirstRunException

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

setService, validate

Method Details

pause

void pause()
    throws ScanningException,
InterruptedException

Allowed when the device is in Running state. Will block until the device is in a rest state. When paused the same thread must call resume() or abort() which has paused or an IllegalMonitorState Exception will be thrown.

Throws:

ScanningException

InterruptedException

seek

void seek(int stepNumber)
   throws ScanningException,
InterruptedException

Seek to/from a point number (absolute) in the scan.

Parameters:

amount -

Throws:

ScanningException

InterruptedException

resume

void resume()
     throws ScanningException,
InterruptedException

Allowed when the device is in Paused state. Will block until the device is unpaused. When paused the same thread must call resume() or abort() which has paused or an IllegalMonitorState Exception will be thrown.

Throws:

ScanningException

InterruptedException