Package org.eclipse.scanning.api.device

Interface IDeviceController

public interface IDeviceController

A device controller takes input from several clients and ensures that each of their preferences about pausing the device being controlled is taken into account. For instance three classes control a scan, a class from the user interface, one from the topup monitor and one from the beam stop monitor, call them gui, topup, shutter If any one of gui, topup, shutter pause, the device gets paused. If all of gui, topup and shutter say resume, the device gets resumed. gui, topup and shutter have an id that goes in a map. They must always use the same id to send commands to the controller or it will not work.

Method Summary

Modifier and Type	Method	Description
void	abort(String id)	Make an abort
IPausableDevice<?>	getDevice()	The device we are controlling.
String	getName()
<T> List<T>	getObjects()	The list of objects which will participate in a scan.
boolean	isActive()
void	pause(String id, IDeviceWatchdogModel model)	Make a pause
void	resume(String id)	Make a resume
void	seek(String id, int step)	Make a seek

Method Details

getObjects

<T> List<T> getObjects()

The list of objects which will participate in a scan.

Returns:

getDevice

IPausableDevice<?> getDevice()

The device we are controlling.

Returns:

pause

void pause(String id,
 IDeviceWatchdogModel model)
    throws ScanningException,
InterruptedException

Make a pause

Parameters:

id -

Throws:

ScanningException

InterruptedException

resume

void resume(String id)
     throws ScanningException,
InterruptedException

Make a resume

Parameters:

id -

Throws:

ScanningException

InterruptedException

seek

void seek(String id,
 int step)
   throws ScanningException,
InterruptedException

Make a seek

Parameters:

id -

Throws:

ScanningException

InterruptedException

abort

void abort(String id)
    throws ScanningException,
InterruptedException

Make an abort

Parameters:

id -

Throws:

ScanningException

InterruptedException

getName

String getName()

Returns:

the name of the device that we are controlling

isActive

boolean isActive()

Returns:

true if the devices (watchdogs) in this contoller all think they are running in a scan.