DynExp
Highly flexible laboratory automation for dynamically changing experiments.
Loading...
Searching...
No Matches
DynExpInstr::NIDAQAnalogInTasks::InitTask Class Reference

#include <NIDAQAnalogIn.h>

+ Inheritance diagram for DynExpInstr::NIDAQAnalogInTasks::InitTask:

Private Member Functions

void InitFuncImpl (dispatch_tag< AnalogInTasks::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.
 
virtual void InitFuncImpl (dispatch_tag< InitTask >, 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...
 
- Public Member Functions inherited from DynExp::TaskBase
 TaskBase (CallbackType CallbackFunc=nullptr, std::chrono::system_clock::time_point DeferUntil={}) noexcept
 Constructs an instrument task.
 
 TaskBase (TaskBase &Other, std::chrono::system_clock::time_point DeferUntil={}) noexcept
 Constructs an instrument task, moving CallbackFunc from another task to this task. The other task is left with a CallbackFunc that will not be executed anymore after this operation. Using this constructor is useful, if a running task enqueues (an)other task(s). In this case, the callback function should not be called by the original task but by the last task in this chain of tasks.
 
virtual ~TaskBase ()=0
 The destructor aborts a waiting task setting State to TaskState::Aborted. Then, it calls CallbackFunc with a default-constructed ExceptionContainer instance.
 
auto GetDeferUntil () const noexcept
 Getter for the instrument task's earliest execution time point.
 
TaskState GetState () const noexcept
 Getter for the instrument task's current state.
 
bool IsLocked () const noexcept
 Determines whether the task is locked.
 
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.
 
int GetErrorCode () const noexcept
 Getter for the error code related to an error possibly occurred while the task was executed.
 
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.
 
- Public Attributes inherited from DynExp::TaskBase
InstrumentBaseOnlyType InstrumentBaseOnly
 Allow exclusive access to some of TaskBase's private methods to InstrumentBase.
 
InstrumentDataBaseOnlyType InstrumentDataBaseOnly
 Allow exclusive access to some of TaskBase's private methods to InstrumentDataBase.
 

Detailed Description

Definition at line 22 of file NIDAQAnalogIn.h.

Member Function Documentation

◆ InitFuncImpl() [1/2]

void DynExpInstr::NIDAQAnalogInTasks::InitTask::InitFuncImpl ( dispatch_tag< AnalogInTasks::InitTask ,
DynExp::InstrumentInstance Instance 
)
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.

Parameters
InstanceHandle to the instrument thread's data

Reimplemented from DynExpInstr::AnalogInTasks::InitTask.

Definition at line 8 of file NIDAQAnalogIn.cpp.

◆ InitFuncImpl() [2/2]

virtual void DynExpInstr::NIDAQAnalogInTasks::InitTask::InitFuncImpl ( dispatch_tag< InitTask ,
DynExp::InstrumentInstance Instance 
)
inlineprivatevirtual

Definition at line 25 of file NIDAQAnalogIn.h.


The documentation for this class was generated from the following files: