Package uk.ac.gda.vmxi.datacollection.process

Class DataCollectionController

java.lang.Object

gda.factory.FindableBase

uk.ac.gda.vmxi.datacollection.process.DataCollectionController

All Implemented Interfaces:

Findable, IDataCollectionController

@ServiceInterface(IDataCollectionController.class)
public class DataCollectionController
extends FindableBase
implements IDataCollectionController

Wrap a dynamically set DataCollectionProcess and expose control to the GDA client. The information exposed through this class is stripped down somewhat to allow serialisation to the client.

Constructor Summary

Constructors

Constructor	Description
DataCollectionController()

Method Summary

Modifier and Type	Method	Description
void	finishCurrentDataCollection()	Request the data collection process stops after the current collection completes.
void	finishCurrentTasks()	Request the data collection process stops after all currently running tasks complete."
List<String>	getClosedShutters()	Get a list of all closed shutters and valve for the purpose of beam check.
DataCollectionProcess	getDataCollectionProcess()
String	getError()	Get a string representation for any error that stopped data collection
ProcessStatus	getStatus()	Get the current status of the data collection process.
Map<String,Collection<String>>	getTaskDependencies()	Get a map representing the dependencies between the current tasks.
boolean	isEnableBeamMonitor()	Check if the data collection process was started with beam checks enabled.
boolean	isRunning()
List<TaskInfo>	listCurrentTasks()	Get a list of all the tasks for the current data collection.
void	openShutters(List<String> shutterIds)	Attempt to open the specified shutters.
void	setDataCollectionProcess(DataCollectionProcess process)	Set the wrapped DataCollectionProcess.
void	start(boolean enableBeamMonitor)	Asynchronously start the data collection process.
void	stop()	Request the data collection process stops immediately, interrupting currently running jobs.

Methods inherited from class gda.factory.FindableBase

equals, getName, hashCode, setName

Methods inherited from class java.lang.Object

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

Methods inherited from interface gda.factory.Findable

getName, setName

Methods inherited from interface uk.ac.gda.vmxi.datacollection.process.IDataCollectionController

start

Constructor Details

DataCollectionController

public DataCollectionController()

Method Details

isEnableBeamMonitor

public boolean isEnableBeamMonitor()

Description copied from interface: IDataCollectionController

Check if the data collection process was started with beam checks enabled.

Specified by:

isEnableBeamMonitor in interface IDataCollectionController

start

public void start(boolean enableBeamMonitor)

Description copied from interface: IDataCollectionController

Asynchronously start the data collection process.

Specified by:

start in interface IDataCollectionController

Parameters:

enableBeamMonitor - Enable checks for beam delivery.

stop

public void stop()

Description copied from interface: IDataCollectionController

Request the data collection process stops immediately, interrupting currently running jobs. The processor will only report "stopped" when all tasks have stopped.

Specified by:

stop in interface IDataCollectionController

isRunning

public boolean isRunning()

Specified by:

isRunning in interface IDataCollectionController

Returns:

true if the data collection processor is running

getStatus

public ProcessStatus getStatus()

Description copied from interface: IDataCollectionController

Get the current status of the data collection process.

Specified by:

getStatus in interface IDataCollectionController

Returns:

ProcessStatus for current run/stopped state.

finishCurrentDataCollection

public void finishCurrentDataCollection()

Description copied from interface: IDataCollectionController

Request the data collection process stops after the current collection completes.

Specified by:

finishCurrentDataCollection in interface IDataCollectionController

finishCurrentTasks

public void finishCurrentTasks()

Description copied from interface: IDataCollectionController

Request the data collection process stops after all currently running tasks complete."

Specified by:

finishCurrentTasks in interface IDataCollectionController

getDataCollectionProcess

public DataCollectionProcess getDataCollectionProcess()

setDataCollectionProcess

public void setDataCollectionProcess(DataCollectionProcess process)

Set the wrapped DataCollectionProcess. Should not be called if a process is already being executed.

Parameters:

process - The process to wrap

listCurrentTasks

public List<TaskInfo> listCurrentTasks()

Description copied from interface: IDataCollectionController

Get a list of all the tasks for the current data collection.

Specified by:

listCurrentTasks in interface IDataCollectionController

Returns:

List of TaskInfo for current tasks.

getTaskDependencies

public Map<String,Collection<String>> getTaskDependencies()

Description copied from interface: IDataCollectionController

Get a map representing the dependencies between the current tasks.

Specified by:

getTaskDependencies in interface IDataCollectionController

Returns:

Map for Task names to the names of its dependencies.

getError

public String getError()

Description copied from interface: IDataCollectionController

Get a string representation for any error that stopped data collection

Specified by:

getError in interface IDataCollectionController

Returns:

Error string

getClosedShutters

public List<String> getClosedShutters()

Description copied from interface: IDataCollectionController

Get a list of all closed shutters and valve for the purpose of beam check.

Specified by:

getClosedShutters in interface IDataCollectionController

Returns:

list of Scannable bean names, or empty

openShutters

public void openShutters(List<String> shutterIds)

Description copied from interface: IDataCollectionController

Attempt to open the specified shutters. Results in ShutterClosedEvent being raised with the outcome of opening the shutters.

Specified by:

openShutters in interface IDataCollectionController

Parameters:

shutterIds - List of the shutter device bean ids