DynExp
Highly flexible laboratory automation for dynamically changing experiments.
|
Defines a task for updating an instrument within an instrument inheritance hierarchy. Each instrument (indirectly) derived from class InstrumentBase
must be accompanied by an update task class derived from UpdateTaskBase
. Even if the task does not do anything, at least it has to call UpdateTaskBase::UpdateFuncImpl() of the derived instrument's update task class.
More...
Classes | |
struct | dispatch_tag |
Refer to DynExp::ParamsBase::dispatch_tag. More... | |
Private Member Functions | |
TaskResultType | RunChild (InstrumentInstance &Instance) override final |
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... | |
virtual void | UpdateFuncImpl (dispatch_tag< UpdateTaskBase >, InstrumentInstance &Instance)=0 |
Updates the respective instrument within the instrument inheritance hierarchy. Call UpdateFuncImpl() of a derived instrument's update task as the last command in a base instrument's update task UpdateFuncImpl() to ensure that derived instruments are updated after base instruments. Overriding functions must throw an exception in case of an error. 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 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... | |
Defines a task for updating an instrument within an instrument inheritance hierarchy. Each instrument (indirectly) derived from class InstrumentBase
must be accompanied by an update task class derived from UpdateTaskBase
. Even if the task does not do anything, at least it has to call UpdateTaskBase::UpdateFuncImpl() of the derived instrument's update task class.
Definition at line 1174 of file Instrument.h.
struct DynExp::UpdateTaskBase::dispatch_tag |
Refer to DynExp::ParamsBase::dispatch_tag.
Type | (derived from DynExp::UpdateTaskBase) to instantiate the dispatch tag template with. |
Definition at line 1182 of file Instrument.h.
|
finaloverrideprivatevirtual |
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 543 of file Instrument.cpp.
|
privatepure virtual |
Updates the respective instrument within the instrument inheritance hierarchy. Call UpdateFuncImpl()
of a derived instrument's update task as the last command in a base instrument's update task UpdateFuncImpl()
to ensure that derived instruments are updated after base instruments. Overriding functions must throw an exception in case of an error.
Instance | Handle to the instrument thread's data |
Implemented in DynExpInstr::InterModuleCommunicatorTasks::UpdateTask.