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

Interface IDataCollectionController

All Superinterfaces:
Findable
All Known Implementing Classes:
DataCollectionController
public interface IDataCollectionController extends Findable

  • 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.
    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.
    default void
    start()
    Asynchronously start the data collection process with beam checks enabled.
    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 interface gda.factory.Findable

    getName, setName

  • Method Details

    • start

      default void start()
      Asynchronously start the data collection process with beam checks enabled.

    • start

      void start(boolean enableBeamMonitor)
      Asynchronously start the data collection process.
      Parameters:
      enableBeamMonitor - Enable checks for beam delivery.

    • stop

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

    • isRunning

      boolean isRunning()
      Returns:
      true if the data collection processor is running

    • isEnableBeamMonitor

      boolean isEnableBeamMonitor()
      Check if the data collection process was started with beam checks enabled.

    • getStatus

      ProcessStatus getStatus()
      Get the current status of the data collection process.
      Returns:
      ProcessStatus for current run/stopped state.

    • getError

      String getError()
      Get a string representation for any error that stopped data collection
      Returns:
      Error string

    • finishCurrentDataCollection

      void finishCurrentDataCollection()
      Request the data collection process stops after the current collection completes.

    • finishCurrentTasks

      void finishCurrentTasks()
      Request the data collection process stops after all currently running tasks complete."

    • listCurrentTasks

      List<TaskInfo> listCurrentTasks()
      Get a list of all the tasks for the current data collection.
      Returns:
      List of TaskInfo for current tasks.

    • getTaskDependencies

      Map<String,Collection<String>> getTaskDependencies()
      Get a map representing the dependencies between the current tasks.
      Returns:
      Map for Task names to the names of its dependencies.

    • getClosedShutters

      List<String> getClosedShutters()
      Get a list of all closed shutters and valve for the purpose of beam check.
      Returns:
      list of Scannable bean names, or empty

    • openShutters

      void openShutters(List<String> shutterIds)
      Attempt to open the specified shutters. Results in ShutterClosedEvent being raised with the outcome of opening the shutters.
      Parameters:
      shutterIds - List of the shutter device bean ids