Defines data for a thread belonging to a ModuleBase instance. Refer to RunnableInstance. More...

#include <Module.h>

Inheritance diagram for DynExp::ModuleInstance:

Public Member Functions
	ModuleInstance (ModuleBase &Owner, std::promise< void > &&ThreadExitedPromise, const ModuleBase::ModuleDataGetterType ModuleDataGetter)
	Constructs a non-empty `RunnableInstance` instance.

	ModuleInstance (ModuleInstance &&Other)
	Move-constructs a `RunnableInstance` instance. `Other` becomes empty. Not noexcept since LinkedObjectWrapperBase::ListType (`std::list`) move constructor might throw.

	~ModuleInstance ()=default

void	Exit () noexcept
	Might be called from anywhere where this `ModuleInstance` instance is accessible to make the associated module terminate.

bool	IsExiting () const noexcept
	Getter for ShouldExit.

Public Member Functions inherited from DynExp::RunnableInstance
	~RunnableInstance ()

const auto &	GetOwner () const noexcept
	Returns Owner.

void	BlockUntilReadyToStart () const noexcept
	Blocks until ThreadMayStart is set to true. Thread functions to be run by `RunnableObject` instances are required to call this function before they access the parameters passed to them (except to call this function).

template<typename ObjectT >
void	TryLockObject (const ParamsBase::Param< ObjectLink< ObjectT > > &LinkParam, LinkedObjectWrapperContainer< ObjectT > &ObjectWrapperContainer, std::chrono::milliseconds Timeout=ObjectLinkBase::LockObjectTimeoutDefault)
	Locks an `Object` instance referenced by a parameter `LinkParam` of type ParamsBase::Param< ObjectLink< ObjectT > > and makes the `LinkedObjectWrapperContainer` `ObjectWrapperContainer` point to the locked resource.

template<typename ObjectT >
void	LockObject (const ParamsBase::Param< ObjectLink< ObjectT > > &LinkParam, LinkedObjectWrapperContainer< ObjectT > &ObjectWrapperContainer, std::chrono::milliseconds Timeout=ObjectLinkBase::LockObjectTimeoutDefault)
	Locks an `Object` instance referenced by a parameter `LinkParam` of type ParamsBase::Param< ObjectLink< ObjectT > > and makes the `LinkedObjectWrapperContainer` `ObjectWrapperContainer` point to the locked resource.

template<typename ObjectT >
void	UnlockObject (LinkedObjectWrapperContainer< ObjectT > &ObjectWrapperContainer)
	Unlocks an `Object` instance stored in the `LinkedObjectWrapperContainer` `ObjectWrapperContainer`. The `LinkedObjectWrapperPointer` contained in `ObjectWrapperContainer` is invalidated (set to nullptr)!

template<typename ObjectT >
void	LockObject (const ParamsBase::ListParam< ObjectLink< ObjectT > > &LinkListParam, LinkedObjectWrapperContainerList< ObjectT > &ObjectWrapperContainerList, std::chrono::milliseconds Timeout=ObjectLinkBase::LockObjectTimeoutDefault)
	Locks `Object` instances referenced by a list parameter `LinkListParam` of type ParamsBase::ListParam< ObjectLink< ObjectT > > and creates containers in `LinkedObjectWrapperContainerList` `ObjectWrapperContainerList` which point to the locked resources.

template<typename ObjectT >
void	UnlockObject (LinkedObjectWrapperContainerList< ObjectT > &ObjectWrapperContainerList)
	Unlocks `Object` instances stored in the `LinkedObjectWrapperContainerList` `ObjectWrapperContainerList`.

bool	CareAboutWrappers ()
	Unregisters owned `LinkedObjectWrapper` instances from their destiny resources in case of the respective destiny resource not being in a ready state (e.g. a stopped/error state). Registers again after the respective destiny resource has returned to a ready state.

std::string	GetNotReadyObjectNamesString () const
	Finds all linked `Object` instances Owner makes use of which are not in a ready state and builds a string identifying all these `Object` instances.

Public Member Functions inherited from Util::INonCopyable
	INonCopyable (const INonCopyable &)=delete

INonCopyable &	operator= (const INonCopyable &)=delete

Public Attributes
const ModuleBase::ModuleDataGetterType	ModuleDataGetter
	Getter for module's data. Refer to ModuleBase::ModuleDataGetterType.

Public Attributes inherited from DynExp::RunnableInstance
const Object::ParamsGetterType	ParamsGetter
	Invoke to obtain the parameters (derived from `ParamsBase`) of Owner.

RunnableObjectOnlyType	RunnableObjectOnly
	Allow exclusive access to some of `RunnableInstance's` private variables to `RunnableObject`.

Private Attributes
bool	ShouldExit = false
	Indicates whether the module thread using this `ModuleInstance` instance should terminate.

Additional Inherited Members
Protected Member Functions inherited from DynExp::RunnableInstance
	RunnableInstance (RunnableObject &Owner, std::promise< void > &&ThreadExitedPromise)
	Constructs a non-empty `RunnableInstance` instance.

	RunnableInstance (RunnableInstance &&Other)
	Move-constructs a `RunnableInstance` instance. `Other` becomes empty. Not noexcept since LinkedObjectWrapperBase::ListType (`std::list`) move constructor might throw.

Protected Member Functions inherited from Util::INonCopyable
constexpr	INonCopyable ()=default

	~INonCopyable ()=default

Detailed Description

Defines data for a thread belonging to a ModuleBase instance. Refer to RunnableInstance.

Definition at line 839 of file Module.h.

Constructor & Destructor Documentation

◆ ModuleInstance() [1/2]

DynExp::ModuleInstance::ModuleInstance	(	ModuleBase &	Owner,
		std::promise< void > &&	ThreadExitedPromise,
		const ModuleBase::ModuleDataGetterType	ModuleDataGetter
	)

Constructs a non-empty RunnableInstance instance.

Parameters

Owner	Refer to Owner.
ThreadExitedPromise	Refer to ThreadExitedPromise.
ModuleDataGetter	Getter for module's data. Refer to ModuleBase::ModuleDataGetterType.

Definition at line 416 of file Module.cpp.

◆ ModuleInstance() [2/2]

DynExp::ModuleInstance::ModuleInstance ( ModuleInstance && Other )

Move-constructs a RunnableInstance instance. Other becomes empty. Not noexcept since LinkedObjectWrapperBase::ListType (std::list) move constructor might throw.

Parameters

Other RunnableInstance instance to move from

Definition at line 423 of file Module.cpp.

◆ ~ModuleInstance()

DynExp::ModuleInstance::~ModuleInstance ( )

default

Member Function Documentation

◆ Exit()

void DynExp::ModuleInstance::Exit ( )

inlinenoexcept

Might be called from anywhere where this ModuleInstance instance is accessible to make the associated module terminate.

Definition at line 860 of file Module.h.

◆ IsExiting()

bool DynExp::ModuleInstance::IsExiting ( ) const

inlinenoexcept

Getter for ShouldExit.

Returns: Returns true if the module associated with this ModuleInstance should terminate, false otherwise.

Definition at line 867 of file Module.h.

Member Data Documentation

◆ ModuleDataGetter

const ModuleBase::ModuleDataGetterType DynExp::ModuleInstance::ModuleDataGetter

Getter for module's data. Refer to ModuleBase::ModuleDataGetterType.

Definition at line 872 of file Module.h.

◆ ShouldExit

bool DynExp::ModuleInstance::ShouldExit = false

private

Indicates whether the module thread using this ModuleInstance instance should terminate.

Definition at line 879 of file Module.h.

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

Public Member Functions

Public Attributes

Private Attributes

Additional Inherited Members