|
DynExp
Highly flexible laboratory automation for dynamically changing experiments.
|
|
DynExp
Highly flexible laboratory automation for dynamically changing experiments.
|
Default task which does not do anything. Though, calling it ensures that TaskBase::CallbackFunc gets called. This is required to avoid InstrumentBase::AsSyncTask() getting stuck in an infinite loop. All functions overridden from meta instruments, which are expected to enqueue a task, must at least enqueue a DefaultTask (by calling MakeAndEnqueueTask< DynExp::DefaultTask >(CallbackFunc);)
More...
Inheritance diagram for DynExp::DefaultTask:Public Member Functions | |
| DefaultTask (CallbackType CallbackFunc) noexcept | |
| Constructs an instrument 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... | |
Private Member Functions | |
| virtual TaskResultType | RunChild (InstrumentInstance &Instance) override |
Runs the task. Override RunChild() to define a derived task's action(s). Any exception leaving RunChild() will terminate the instrument thread. In this case, the instrument has to be reset in order to restart it. For minor errors occurring in RunChild(), return a TaskResultType instance with TaskResultType::ErrorCode set to an appropriate (non-zero) value. This sets State to TaskState::Failed. Note that in this case there might be no way to retrieve the error if finished tasks are not kept (i.e. KeepFinishedTask() returns false) and if no CallbackFunc has been set. RunChild() is supposed to check the return value of IsAborting(). More... | |
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 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... | |
Default task which does not do anything. Though, calling it ensures that TaskBase::CallbackFunc gets called. This is required to avoid InstrumentBase::AsSyncTask() getting stuck in an infinite loop. All functions overridden from meta instruments, which are expected to enqueue a task, must at least enqueue a DefaultTask (by calling MakeAndEnqueueTask< DynExp::DefaultTask >(CallbackFunc);)
Definition at line 1096 of file Instrument.h.
|
inlinenoexcept |
Constructs an instrument task.
| CallbackFunc | This callback function is called after the task has finished (either successfully or not) with a reference to the current task and with a reference to the exception which occurred during the task execution (if an exception has occurred). |
Definition at line 1099 of file Instrument.h.
|
inlineoverrideprivatevirtual |
Runs the task. Override RunChild() to define a derived task's action(s). Any exception leaving RunChild() will terminate the instrument thread. In this case, the instrument has to be reset in order to restart it. For minor errors occurring in RunChild(), return a TaskResultType instance with TaskResultType::ErrorCode set to an appropriate (non-zero) value. This sets State to TaskState::Failed. Note that in this case there might be no way to retrieve the error if finished tasks are not kept (i.e. KeepFinishedTask() returns false) and if no CallbackFunc has been set. RunChild() is supposed to check the return value of IsAborting().
| Instance | Handle to the instrument thread's data |
| Util::InvalidStateException | is thrown if the task is not in the TaskState::Waiting or TaskState::Locked state. |
Implements DynExp::TaskBase.
Definition at line 1102 of file Instrument.h.
1.9.1