OperationControl Struct Reference

The data sent by a BaseExperimentGUI instance to the corresponding experiment. More...

Public Types

enum  Action {
  StartOperation, StartOperationPaused, StopOperation, PauseOperation,
  StepOperation, ResumeOperation, ChangeInterval
}
 The list of possible actions to perform. More...
 

Public Attributes

Action action
 The action to perform. More...
 
unsigned long interval
 The new interval in milliseconds. More...
 
unsigned int operationID
 The id of the operation to start. More...
 

Detailed Description

The data sent by a BaseExperimentGUI instance to the corresponding experiment.

Definition at line 105 of file baseexperiment.h.

Member Enumeration Documentation

enum Action

The list of possible actions to perform.

Enumerator
StartOperation 

Start an operation

StartOperationPaused 

Start an operation and immediately puts it in pause. If the operation is not steppable, this is the same as StartOperation

StopOperation 

Stop the current operation

PauseOperation 

Pause the current operation

StepOperation 

Perform a step of the current operation

ResumeOperation 

Resumes the current operation if paused

ChangeInterval 

Change the interval between steps for the current operation

Definition at line 109 of file baseexperiment.h.

Member Data Documentation

Action action

The action to perform.

Definition at line 129 of file baseexperiment.h.

unsigned long interval

The new interval in milliseconds.

This only makes sense if action is ChangeInterval

Definition at line 143 of file baseexperiment.h.

unsigned int operationID

The id of the operation to start.

This only makes sense if action is StartOperation

Definition at line 136 of file baseexperiment.h.


The documentation for this struct was generated from the following file: