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

Private Member Functions
constexpr	InstrumentBaseOnlyType (InstrumentDataBase &Parent) noexcept
	Construcs an instance - one for each `InstrumentDataBase` instance.

void	Reset ()
	Resets the `InstrumentDataBase's` instance and calls ResetImpl(dispatch_tag<InstrumentDataBase>) subsequently.

void	IndicateException () noexcept
	Indicates to the main thread that an exception has happened in the instrument thread. Only performs atomic operations. Hence, this instrument data instance does not need to be locked for this function call.

void	SetException (std::exception_ptr Exception) noexcept
	Setter for InstrumentException.

void	EnqueueTask (std::unique_ptr< TaskBase > &&Task, bool CallFromInstrThread, bool NotifyReceiver)
	Enqueues a task at the back of an instrument's task queue and notifies the instrument about the new task.

void	EnqueuePriorityTask (std::unique_ptr< TaskBase > &&Task, bool CallFromInstrThread, bool NotifyReceiver)
	Enqueues a task at the front of an instrument's task queue and notifies the instrument about the new task.

void	RemoveTaskFromQueue (TaskQueueIteratorType &Task)
	Removes a task from the instrument's task queue and inserts it into the instrument's list of finished tasks if TaskBase::KeepFinishedTask() returns true.

void	RemoveAllTasks ()
	Clears the instrument's task queue.

void	RemoveAllTasksExceptFront ()
	Clears the instrument's task queue but keeps the front task (the task with highest priority which is handled next).

void	CloseQueue ()
	Clsoes the instrument's task queue setting QueueClosed to true.

auto &	GetNewTaskNotifier () noexcept
	Getter for NewTaskNotifier.

Private Attributes
InstrumentDataBase &	Parent
	Owning `InstrumentDataBase` instance.

Friends
class	InstrumentDataBase

class	InstrumentBase

Detailed Description

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

Definition at line 152 of file Instrument.h.

Constructor & Destructor Documentation

◆ InstrumentBaseOnlyType()

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

inlineconstexprprivatenoexcept

Construcs an instance - one for each InstrumentDataBase instance.

Parameters

Parent Owning InstrumentDataBase instance

Definition at line 161 of file Instrument.h.

Member Function Documentation

◆ CloseQueue()

void DynExp::InstrumentDataBase::InstrumentBaseOnlyType::CloseQueue ( )

inlineprivate

Clsoes the instrument's task queue setting QueueClosed to true.

Definition at line 171 of file Instrument.h.

◆ EnqueuePriorityTask()

void DynExp::InstrumentDataBase::InstrumentBaseOnlyType::EnqueuePriorityTask	(	std::unique_ptr< TaskBase > &&	Task,
		bool	CallFromInstrThread,
		bool	NotifyReceiver
	)

inlineprivate

Enqueues a task at the front of an instrument's task queue and notifies the instrument about the new task.

Parameters

Task	Task to enqueue, the queue takes ownership of the task.
CallFromInstrThread	Pass true if the instrument itself enqueues a task. This argument is forwarded to `CheckQueueState()`.
NotifyReceiver	Determines whether the instrument thread is notified that a new task has been enqueued. This is e.g. not desired when enqueuing update tasks in InstrumentBase::UpdateData().

Definition at line 167 of file Instrument.h.

◆ EnqueueTask()

void DynExp::InstrumentDataBase::InstrumentBaseOnlyType::EnqueueTask	(	std::unique_ptr< TaskBase > &&	Task,
		bool	CallFromInstrThread,
		bool	NotifyReceiver
	)

inlineprivate

Enqueues a task at the back of an instrument's task queue and notifies the instrument about the new task.

Parameters

Task	Task to enqueue, the queue takes ownership of the task.
CallFromInstrThread	Pass true if the instrument itself enqueues a task. This argument is forwarded to `CheckQueueState()`.
NotifyReceiver	Determines whether the instrument thread is notified that a new task has been enqueued. This is e.g. not desired when enqueuing update tasks in InstrumentBase::UpdateData().

Definition at line 166 of file Instrument.h.

◆ GetNewTaskNotifier()

auto & DynExp::InstrumentDataBase::InstrumentBaseOnlyType::GetNewTaskNotifier ( )

inlineprivatenoexcept

Getter for NewTaskNotifier.

Returns: Returns NewTaskNotifier to notify the instrument thread about new tasks.

Definition at line 173 of file Instrument.h.

◆ IndicateException()

void DynExp::InstrumentDataBase::InstrumentBaseOnlyType::IndicateException ( )

inlineprivatenoexcept

Indicates to the main thread that an exception has happened in the instrument thread. Only performs atomic operations. Hence, this instrument data instance does not need to be locked for this function call.

Definition at line 164 of file Instrument.h.

◆ RemoveAllTasks()

void DynExp::InstrumentDataBase::InstrumentBaseOnlyType::RemoveAllTasks ( )

inlineprivate

Clears the instrument's task queue.

Definition at line 169 of file Instrument.h.

◆ RemoveAllTasksExceptFront()

void DynExp::InstrumentDataBase::InstrumentBaseOnlyType::RemoveAllTasksExceptFront ( )

inlineprivate

Clears the instrument's task queue but keeps the front task (the task with highest priority which is handled next).

Definition at line 170 of file Instrument.h.

◆ RemoveTaskFromQueue()

void DynExp::InstrumentDataBase::InstrumentBaseOnlyType::RemoveTaskFromQueue ( TaskQueueIteratorType & Task )

inlineprivate

Removes a task from the instrument's task queue and inserts it into the instrument's list of finished tasks if TaskBase::KeepFinishedTask() returns true.

Parameters

Task	Iterator to an enqueued task.

Definition at line 168 of file Instrument.h.

◆ Reset()

void DynExp::InstrumentDataBase::InstrumentBaseOnlyType::Reset ( )

inlineprivate

Resets the InstrumentDataBase's instance and calls ResetImpl(dispatch_tag<InstrumentDataBase>) subsequently.

Definition at line 163 of file Instrument.h.

◆ SetException()

void DynExp::InstrumentDataBase::InstrumentBaseOnlyType::SetException ( std::exception_ptr Exception )

inlineprivatenoexcept

Setter for InstrumentException.

Parameters

Exception Exception to store.

Definition at line 165 of file Instrument.h.

Friends And Related Symbol Documentation

◆ InstrumentBase

friend class InstrumentBase

friend

Definition at line 155 of file Instrument.h.

◆ InstrumentDataBase

friend class InstrumentDataBase

friend

Definition at line 154 of file Instrument.h.

Member Data Documentation

◆ Parent

InstrumentDataBase& DynExp::InstrumentDataBase::InstrumentBaseOnlyType::Parent

private

Owning InstrumentDataBase instance.

Definition at line 175 of file Instrument.h.

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

Instrument.h

Private Member Functions

Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ InstrumentBaseOnlyType()

Member Function Documentation

◆ CloseQueue()

◆ EnqueuePriorityTask()

◆ EnqueueTask()

◆ GetNewTaskNotifier()

◆ IndicateException()

◆ RemoveAllTasks()

◆ RemoveAllTasksExceptFront()

◆ RemoveTaskFromQueue()

◆ Reset()

◆ SetException()

Friends And Related Symbol Documentation

◆ InstrumentBase

◆ InstrumentDataBase

Member Data Documentation

◆ Parent