#include <NP_Conex_CC.h>

Inheritance diagram for DynExpInstr::NP_Conex_CC_Tasks::MoveAbsoluteExecutionTask:

Public Member Functions
	MoveAbsoluteExecutionTask (PositionerStageData::PositionType Position, CallbackType CallbackFunc, std::chrono::system_clock::time_point DeferUntil={}) noexcept

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.

Private Member Functions
virtual DynExp::TaskResultType	RunChild (DynExp::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()`.

Private Attributes
const PositionerStageData::PositionType	Position

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 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 157 of file NP_Conex_CC.h.

Constructor & Destructor Documentation

◆ MoveAbsoluteExecutionTask()

DynExpInstr::NP_Conex_CC_Tasks::MoveAbsoluteExecutionTask::MoveAbsoluteExecutionTask	(	PositionerStageData::PositionType	Position,
		CallbackType	CallbackFunc,
		std::chrono::system_clock::time_point	DeferUntil = `{}`
	)

inlinenoexcept

Definition at line 160 of file NP_Conex_CC.h.

Member Function Documentation

◆ RunChild()

DynExp::TaskResultType DynExpInstr::NP_Conex_CC_Tasks::MoveAbsoluteExecutionTask::RunChild ( DynExp::InstrumentInstance & Instance )

overrideprivatevirtual

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().

Parameters

Instance Handle to the instrument thread's data

Returns: Returns whether task handling should continue or whether the instrument thread should terminate.

Exceptions

Util::InvalidStateException is thrown if the task is not in the TaskState::Waiting or TaskState::Locked state.

Implements DynExp::TaskBase.

Definition at line 267 of file NP_Conex_CC.cpp.

Member Data Documentation

◆ Position

const PositionerStageData::PositionType DynExpInstr::NP_Conex_CC_Tasks::MoveAbsoluteExecutionTask::Position

private

Definition at line 166 of file NP_Conex_CC.h.

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

Public Member Functions

Private Member Functions

Private Attributes