DynExp::TaskBase::InstrumentBaseOnlyType Class Reference

Allow exclusive access to some of TaskBase's private methods to InstrumentBase. More...

Private Member Functions
constexpr	InstrumentBaseOnlyType (TaskBase &Parent) noexcept
	Construcs an instance - one for each TaskBase instance.
void	Lock ()
	Locks the task to prepare it for execution.
auto	Run (InstrumentInstance &Instance)
	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().
void	SetAborted ()
	Sets TaskBase::State to TaskBase::TaskState::Aborted.

Private Attributes
TaskBase &	Parent
	Owning TaskBase instance.

Friends
class	TaskBase
class	InstrumentBase

Detailed Description

Allow exclusive access to some of TaskBase's private methods to InstrumentBase.

Definition at line 933 of file Instrument.h.

Constructor & Destructor Documentation

InstrumentBaseOnlyType()

constexpr DynExp::TaskBase::InstrumentBaseOnlyType::InstrumentBaseOnlyType ( TaskBase &  Parent )

inlineconstexprprivatenoexcept

Construcs an instance - one for each TaskBase instance.

Parameters

Parent

Owning TaskBase instance

Definition at line 942 of file Instrument.h.

Member Function Documentation

Lock()

void DynExp::TaskBase::InstrumentBaseOnlyType::Lock ( )

inlineprivate

Locks the task to prepare it for execution.

Exceptions

Util::InvalidStateException

is thrown if the task is not in the TaskState::Waiting state.

Definition at line 944 of file Instrument.h.

Run()

auto DynExp::TaskBase::InstrumentBaseOnlyType::Run ( InstrumentInstance &  Instance )

inlineprivate

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.

Definition at line 945 of file Instrument.h.

SetAborted()

void DynExp::TaskBase::InstrumentBaseOnlyType::SetAborted ( )

inlineprivate

Sets TaskBase::State to TaskBase::TaskState::Aborted.

Definition at line 946 of file Instrument.h.

Friends And Related Symbol Documentation

InstrumentBase

friend class InstrumentBase

friend

Definition at line 936 of file Instrument.h.

TaskBase

friend class TaskBase

friend

Definition at line 935 of file Instrument.h.

Member Data Documentation

Parent

TaskBase& DynExp::TaskBase::InstrumentBaseOnlyType::Parent

private

Owning TaskBase instance.

Definition at line 948 of file Instrument.h.

---

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

• Instrument.h