|
DynExp
Highly flexible laboratory automation for dynamically changing experiments.
|
|
DynExp
Highly flexible laboratory automation for dynamically changing experiments.
|
Inheritance diagram for DynExpInstr::DummyDataStreamInstrumentTasks::ExitTask:Private Member Functions | |
| void | ExitFuncImpl (dispatch_tag< FunctionGeneratorTasks::ExitTask >, DynExp::InstrumentInstance &Instance) override final |
Deinitializes the respective instrument within the instrument inheritance hierarchy. Call ExitFuncImpl() of a derived instrument's exit task as the first command in a base instrument's exit task ExitFuncImpl() to ensure that derived instruments can shut down before base instruments. Overriding functions must throw an exception in case of an error. More... | |
| virtual void | ExitFuncImpl (dispatch_tag< ExitTask >, DynExp::InstrumentInstance &Instance) |
Additional Inherited Members | |
| Public Types inherited from DynExp::TaskBase | |
| enum class | TaskState { Waiting , Locked , Running , Finished , Failed , Aborted } |
| Defines states an instrument's task can undergo. Possible state transitions are: More... | |
| using | CallbackType = std::function< void(const TaskBase &, ExceptionContainer &)> |
| Type of a callback function which is invoked when a task has finished, failed or has been aborted. The function receives a reference to the task it originates from as well as a reference to a wrapper holding an exception which might have occurred while executing the task. More... | |
| Public Member Functions inherited from DynExp::TaskBase | |
| TaskBase (CallbackType CallbackFunc=nullptr) noexcept | |
| Constructs an instrument task. More... | |
| virtual | ~TaskBase ()=0 |
The destructor aborts a waiting task setting State to TaskState::Aborted. Then, it calls CallbackFunc with a default-constructed ExceptionContainer instance. More... | |
| TaskState | GetState () const noexcept |
| Getter for the instrument task's current state. More... | |
| bool | IsLocked () const noexcept |
| Determines whether the task is locked. More... | |
| bool | IsAborting () const noexcept |
| Determines whether the task should abort. A derived task is encouraged to call this method before performing any action or in between the individual steps of a more complex action. More... | |
| int | GetErrorCode () const noexcept |
| Getter for the error code related to an error possibly occurred while the task was executed. More... | |
| void | Abort () |
Requests the task to abort. There is no guarantee that the derived task does call IsAborting() to check whether it should abort. The task could have finished already or the implementation of RunChild() in the derived class does not allow for aborting. More... | |
| Public Attributes inherited from DynExp::TaskBase | |
| InstrumentBaseOnlyType | InstrumentBaseOnly |
Allow exclusive access to some of TaskBase's private methods to InstrumentBase. More... | |
| InstrumentDataBaseOnlyType | InstrumentDataBaseOnly |
Allow exclusive access to some of TaskBase's private methods to InstrumentDataBase. More... | |
Definition at line 26 of file DummyDataStreamInstrument.h.
|
inlineprivatevirtual |
Definition at line 29 of file DummyDataStreamInstrument.h.
|
inlinefinaloverrideprivatevirtual |
Deinitializes the respective instrument within the instrument inheritance hierarchy. Call ExitFuncImpl() of a derived instrument's exit task as the first command in a base instrument's exit task ExitFuncImpl() to ensure that derived instruments can shut down before base instruments. Overriding functions must throw an exception in case of an error.
| Instance | Handle to the instrument thread's data |
Reimplemented from DynExpInstr::FunctionGeneratorTasks::ExitTask.
Definition at line 28 of file DummyDataStreamInstrument.h.
1.9.1