|
DynExp
Highly flexible laboratory automation for dynamically changing experiments.
|
|
DynExp
Highly flexible laboratory automation for dynamically changing experiments.
|
Defines a task for initializing an instrument within an instrument inheritance hierarchy. Each instrument (indirectly) derived from class InstrumentBase must be accompanied by an initialization task class derived from InitTaskBase. Even if the task does not do anything, at least it has to call InitTaskBase::InitFuncImpl() of the derived instrument's initialization task class.
More...
Inheritance diagram for DynExpInstr::OutputPortTasks::InitTask:Private Member Functions | |
| void | InitFuncImpl (dispatch_tag< FunctionGeneratorTasks::InitTask >, DynExp::InstrumentInstance &Instance) override final |
Initializes the respective instrument within the instrument inheritance hierarchy. Call InitFuncImpl() of a derived instrument's initialization task as the last command in a base instrument's initialization task InitFuncImpl() to ensure that derived instruments are initialized after base instruments. Overriding functions must throw an exception in case of an error. More... | |
| virtual void | InitFuncImpl (dispatch_tag< InitTask >, DynExp::InstrumentInstance &Instance) |
Initializes the respective instrument within the instrument inheritance hierarchy. Call InitFuncImpl() of a derived instrument's initialization task as the last command in a base instrument's initialization task InitFuncImpl() to ensure that derived instruments are initialized after base instruments. Overriding functions must throw an exception in case of an error. More... | |
Override | |
Override by derived tasks. | |
| virtual bool | ApplyDataStreamSizeFromParams () const noexcept |
| Determines whether to update the instrument's data stream size according to the instrument parameters. 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 initializing an instrument within an instrument inheritance hierarchy. Each instrument (indirectly) derived from class InstrumentBase must be accompanied by an initialization task class derived from InitTaskBase. Even if the task does not do anything, at least it has to call InitTaskBase::InitFuncImpl() of the derived instrument's initialization task class.
Definition at line 26 of file OutputPort.h.
|
inlineprivatevirtualnoexcept |
Determines whether to update the instrument's data stream size according to the instrument parameters.
OutputPort's data stream should be adjusted by the task automatically to the result of OutputPort::GetStreamSizeParams(), false otherwise. Definition at line 46 of file OutputPort.h.
|
finaloverrideprivatevirtual |
Initializes the respective instrument within the instrument inheritance hierarchy. Call InitFuncImpl() of a derived instrument's initialization task as the last command in a base instrument's initialization task InitFuncImpl() to ensure that derived instruments are initialized after 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::InitTask.
Definition at line 8 of file OutputPort.cpp.
|
inlineprivatevirtual |
Initializes the respective instrument within the instrument inheritance hierarchy. Call InitFuncImpl() of a derived instrument's initialization task as the last command in a base instrument's initialization task InitFuncImpl() to ensure that derived instruments are initialized after base instruments. Overriding functions must throw an exception in case of an error.
| Instance | Handle to the instrument thread's data |
Reimplemented in DynExpInstr::DigitalOutTasks::InitTask, and DynExpInstr::AnalogOutTasks::InitTask.
Definition at line 33 of file OutputPort.h.
1.9.1