Container for components system. More...

#include <components.h>

Public Member Functions
template<std::derived_from< base_component_t > component_t>
component_t *	add (std::unique_ptr< component_t > pComponent, priority ePriority=priority::normal, flags< status > statusFlags=status::default_value) noexcept
	Add a component. More...

std::unique_ptr< base_component_t >	remove (const base_component_t *pRawComponent) noexcept
	Remove the component from the container. More...

template<std::derived_from< base_component_t > component_t>
component_t *	try_get () noexcept
	Try to get a component of the given type with the highest priority. More...

template<std::derived_from< base_component_t > component_t>
const component_t *	try_get () const noexcept
	Try to get a component of the given type with the highest priority. More...

base_component_t *	try_get (class_identificator id) noexcept
	Try to get a component of the given type id with the highest priority. More...

const base_component_t *	try_get (class_identificator id) const noexcept
	Try to get a component of the given type id with the highest priority. More...

template<std::derived_from< base_component_t > component_t>
component_t &	get () noexcept
	Get a component of the given type with the highest priority (no existence checks are performed) More...

template<std::derived_from< base_component_t > component_t>
const component_t &	get () const noexcept
	Get a component of the given type with the highest priority (no existence checks are performed) More...

template<std::derived_from< base_component_t > component_t = base_component_t>
auto	view () noexcept
	Get a view which may be used in a ranged-based for loop and consists of components of a given type with decreasing non-disabled priority. More...

template<std::derived_from< base_component_t > component_t = base_component_t>
auto	view () const noexcept
	Get a view which may be used in a ranged-based for loop and consists of components of a given type with decreasing non-disabled priority. More...

std::optional< priority >	get_priority (const base_component_t *pRawComponent) const noexcept
	Get a priority of a given component. More...

bool	set_priority (const base_component_t *pRawComponent, priority ePriority) noexcept
	Set a priority of a given component. More...

std::optional< flags< status > >	get_status (const base_component_t *pRawComponent) const noexcept
	Get a status of a given component. More...

bool	set_status (const base_component_t *pRawComponent, flags< status > status) noexcept
	Set a status of a given component. More...

bool	empty () const noexcept
	Check if container doesn't have any components. More...

void	clear () noexcept
	Clear the container, e.g. remove all the components.

Detailed Description

template<std::derived_from< rtti_pure_base > base_component_t>
class qx::components< base_component_t >

Container for components system.

Stores components and allows them to be accessed by a template argument or a class id. Each component has a priority, which is used to iterate through a sequence of objects of a type (final or any super type) or to use getter methods, where a component with the highest priority will be given. You can use qx::priority::disabled to exclude the component from iteration or getters result.

Template Parameters

base_component_t - base component type

Author: Khrapov

Date: 9.03.2021

Definition at line 37 of file components.h.

Member Function Documentation

◆ add()

template<std::derived_from< rtti_pure_base > base_component_t>

template<std::derived_from< base_component_t > component_t>

component_t * qx::components< base_component_t >::add	(	std::unique_ptr< component_t >	pComponent,
		priority	ePriority = `priority::normal`,
		flags< status >	statusFlags = `status::default_value`
	)

noexcept

Add a component.

Template Parameters

component_t - component type which doesn't have to be a final class type, may be any base or super type

Parameters

pComponent	- component object
ePriority	- initial component priority
statusFlags	- initial component status

Return values

-	raw component pointer which acts like a component's handle

Definition at line 28 of file components.inl.

◆ empty()

template<std::derived_from< rtti_pure_base > base_component_t>

bool qx::components< base_component_t >::empty

noexcept

Check if container doesn't have any components.

Return values

-	true if container doesn't have any components

Definition at line 284 of file components.inl.

◆ get() [1/2]

template<std::derived_from< rtti_pure_base > base_component_t>

template<std::derived_from< base_component_t > component_t>

const component_t & qx::components< base_component_t >::get

noexcept

Get a component of the given type with the highest priority (no existence checks are performed)

Template Parameters

component_t - component type which doesn't have to be a final class type, may be any base or super type

Return values

-	component reference

Definition at line 141 of file components.inl.

◆ get() [2/2]

template<std::derived_from< rtti_pure_base > base_component_t>

template<std::derived_from< base_component_t > component_t>

component_t & qx::components< base_component_t >::get

noexcept

Get a component of the given type with the highest priority (no existence checks are performed)

Template Parameters

component_t - component type which doesn't have to be a final class type, may be any base or super type

Return values

-	component reference

Definition at line 126 of file components.inl.

◆ get_priority()

template<std::derived_from< rtti_pure_base > base_component_t>

std::optional< priority > qx::components< base_component_t >::get_priority ( const base_component_t * pRawComponent ) const

noexcept

Get a priority of a given component.

Parameters

pRawComponent - raw component pointer which acts like a component's handle

Return values

-	component's priority or nullopt if can't find the component

Definition at line 185 of file components.inl.

◆ get_status()

template<std::derived_from< rtti_pure_base > base_component_t>

std::optional< flags< status > > qx::components< base_component_t >::get_status ( const base_component_t * pRawComponent ) const

noexcept

Get a status of a given component.

Parameters

pRawComponent - raw component pointer which acts like a component's handle

Return values

- status

Definition at line 236 of file components.inl.

◆ remove()

template<std::derived_from< rtti_pure_base > base_component_t>

std::unique_ptr< base_component_t > qx::components< base_component_t >::remove ( const base_component_t * pRawComponent )

noexcept

Remove the component from the container.

Parameters

pRawComponent - raw component pointer which acts like a component's handle

Return values

-	component object

Definition at line 48 of file components.inl.

◆ set_priority()

template<std::derived_from< rtti_pure_base > base_component_t>

bool qx::components< base_component_t >::set_priority	(	const base_component_t *	pRawComponent,
		priority	ePriority
	)

noexcept

Set a priority of a given component.

Parameters

pRawComponent	- raw component pointer which acts like a component's handle
ePriority	- new component's priority

Return values

-	true if the component is found and a priority was set

Definition at line 202 of file components.inl.

◆ set_status()

template<std::derived_from< rtti_pure_base > base_component_t>

bool qx::components< base_component_t >::set_status	(	const base_component_t *	pRawComponent,
		flags< status >	status
	)

noexcept

Set a status of a given component.

Parameters

pRawComponent	- raw component pointer which acts like a component's handle
status	- new component's status

Return values

-	true if the component is found and a status was set

Definition at line 254 of file components.inl.

◆ try_get() [1/4]

template<std::derived_from< rtti_pure_base > base_component_t>

template<std::derived_from< base_component_t > component_t>

const component_t * qx::components< base_component_t >::try_get

noexcept

Try to get a component of the given type with the highest priority.

Template Parameters

component_t - component type which doesn't have to be a final class type, may be any base or super type

Return values

-	component pointer or nullptr

Definition at line 97 of file components.inl.

◆ try_get() [2/4]

template<std::derived_from< rtti_pure_base > base_component_t>

template<std::derived_from< base_component_t > component_t>

component_t * qx::components< base_component_t >::try_get

noexcept

Try to get a component of the given type with the highest priority.

Template Parameters

component_t - component type which doesn't have to be a final class type, may be any base or super type

Return values

-	component pointer or nullptr

Definition at line 82 of file components.inl.

◆ try_get() [3/4]

template<std::derived_from< rtti_pure_base > base_component_t>

const base_component_t * qx::components< base_component_t >::try_get ( class_identificator id ) const

noexcept

Try to get a component of the given type id with the highest priority.

Parameters

id - type id

Return values

-	component pointer or nullptr

Definition at line 119 of file components.inl.

◆ try_get() [4/4]

template<std::derived_from< rtti_pure_base > base_component_t>

base_component_t * qx::components< base_component_t >::try_get ( class_identificator id )

noexcept

Try to get a component of the given type id with the highest priority.

Parameters

id - type id

Return values

-	component pointer or nullptr

Definition at line 103 of file components.inl.

◆ view() [1/2]

template<std::derived_from< rtti_pure_base > base_component_t>

template<std::derived_from< base_component_t > component_t>

auto qx::components< base_component_t >::view

noexcept

Get a view which may be used in a ranged-based for loop and consists of components of a given type with decreasing non-disabled priority.

Template Parameters

component_t - component type which doesn't have to be a final class type, may be any base or super type

Return values

-	view of components

Definition at line 167 of file components.inl.

◆ view() [2/2]

template<std::derived_from< rtti_pure_base > base_component_t>

template<std::derived_from< base_component_t > component_t>

auto qx::components< base_component_t >::view

noexcept

Get a view which may be used in a ranged-based for loop and consists of components of a given type with decreasing non-disabled priority.

Template Parameters

component_t - component type which doesn't have to be a final class type, may be any base or super type

Return values

-	view of components

Definition at line 148 of file components.inl.

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

include/qx/containers/components.h
include/qx/containers/components.inl

Public Member Functions

Detailed Description

template<std::derived_from< rtti_pure_base > base_component_t> class qx::components< base_component_t >

Member Function Documentation

◆ add()

◆ empty()

◆ get() [1/2]

◆ get() [2/2]

◆ get_priority()

◆ get_status()

◆ remove()

◆ set_priority()

◆ set_status()

◆ try_get() [1/4]

◆ try_get() [2/4]

◆ try_get() [3/4]

◆ try_get() [4/4]

◆ view() [1/2]

◆ view() [2/2]

template<std::derived_from< rtti_pure_base > base_component_t>
class qx::components< base_component_t >