Set of instances inheriting from the Base type. More...

#include <SystemInstances.hpp>

Collaboration diagram for ecstasy::SystemInstances:

Classes
class	Comparer

Public Member Functions
	SystemInstances ()=default
	Construct a new SystemInstances storage.

	~SystemInstances ()=default
	Destroy the SystemInstances storage.

	SystemInstances (const SystemInstances &other)=delete
	SystemInstances aren't copy constructible.

template<std::derived_from< ISystem > Derived, size_t Priority = 0, typename... Args>
Derived &	emplace (Args &&...args)
	Emplace a new instance of type Derived in the storage.

const ISystem &	get (const std::type_index &type) const
	Get a const reference to the contained instance identified by type.

template<std::derived_from< ISystem > Derived>
const Derived &	get () const
	Get a const reference to the contained instance of Derived.

ISystem &	get (const std::type_index &type)
	Get a reference to the contained instance identified by type.

template<std::derived_from< ISystem > Derived>
Derived &	get ()
	Get a reference to the contained instance of Derived.

ISystem *	getPtr (const std::type_index &type) const
	Get a pointer to the contained instance identified by type.

template<std::derived_from< ISystem > Derived>
Derived *	getPtr () const
	Get a pointer to the contained instance of Derived.

bool	contains (const std::type_index &type) const
	Check wheter the instance identified by type is contained in the set.

template<std::derived_from< ISystem > Derived>
bool	contains () const
	Check whether an instance of Derived is contained in the set.

void	clear ()
	Remove all stored instances.

constexpr const std::map< key_type, std::unique_ptr< ISystem >, Comparer > &	getInner () const noexcept
	Get the backing container.

Private Types
using	key_type = std::pair< std::type_index, size_t >
	The internal map key type.

Private Attributes
std::map< key_type, std::unique_ptr< ISystem >, Comparer >	_instances
	The internal map of instances.

Detailed Description

Set of instances inheriting from the Base type.

Template Parameters

Base	base type for all instances.

Author: Andréas Leroux (andre.nosp@m.as.l.nosp@m.eroux.nosp@m.@epi.nosp@m.tech..nosp@m.eu)

Since: 1.0.0 (2022-10-17)

Definition at line 33 of file SystemInstances.hpp.

Member Typedef Documentation

◆ key_type

using ecstasy::SystemInstances::key_type = std::pair<std::type_index, size_t>

private

The internal map key type.

Definition at line 36 of file SystemInstances.hpp.

Constructor & Destructor Documentation

◆ SystemInstances() [1/2]

ecstasy::SystemInstances::SystemInstances ( )

default

Construct a new SystemInstances storage.

Author: Andréas Leroux (andre.nosp@m.as.l.nosp@m.eroux.nosp@m.@epi.nosp@m.tech..nosp@m.eu)

Since: 1.0.0 (2022-10-17)

◆ ~SystemInstances()

ecstasy::SystemInstances::~SystemInstances ( )

default

Destroy the SystemInstances storage.

All elements are freed.

Author: Andréas Leroux (andre.nosp@m.as.l.nosp@m.eroux.nosp@m.@epi.nosp@m.tech..nosp@m.eu)

Since: 1.0.0 (2022-10-17)

◆ SystemInstances() [2/2]

ecstasy::SystemInstances::SystemInstances ( const SystemInstances & other )

delete

SystemInstances aren't copy constructible.

Parameters

[in] other instance to copy.

Author: Andréas Leroux (andre.nosp@m.as.l.nosp@m.eroux.nosp@m.@epi.nosp@m.tech..nosp@m.eu)

Since: 1.0.0 (2022-10-17)

Member Function Documentation

◆ clear()

void ecstasy::SystemInstances::clear ( )

inline

Remove all stored instances.

Author: Andréas Leroux (andre.nosp@m.as.l.nosp@m.eroux.nosp@m.@epi.nosp@m.tech..nosp@m.eu)

Since: 1.0.0 (2022-10-17)

Definition at line 310 of file SystemInstances.hpp.

        {
            _instances.clear();
        }

◆ contains() [1/2]

template<std::derived_from< ISystem > Derived>

bool ecstasy::SystemInstances::contains ( ) const

inline

Check whether an instance of Derived is contained in the set.

Template Parameters

Derived The type of instance to test, must inherit from ISystem.

Returns: Whether the given instance type is contained in the set.

Author: Andréas Leroux (andre.nosp@m.as.l.nosp@m.eroux.nosp@m.@epi.nosp@m.tech..nosp@m.eu)

Since: 1.0.0 (2022-10-17)

Definition at line 299 of file SystemInstances.hpp.

        {
            return contains(std::type_index(typeid(Derived)));
        }

◆ contains() [2/2]

bool ecstasy::SystemInstances::contains ( const std::type_index & type ) const

inline

Check wheter the instance identified by type is contained in the set.

Parameters

[in] type the instance type index.

Returns: Whether the given type match one of the instance contained in the set.

Author: Andréas Leroux (andre.nosp@m.as.l.nosp@m.eroux.nosp@m.@epi.nosp@m.tech..nosp@m.eu)

Since: 1.0.0 (2022-10-17)

Definition at line 283 of file SystemInstances.hpp.

        {
            return _instances.contains(type);
        }

◆ emplace()

template<std::derived_from< ISystem > Derived, size_t Priority = 0, typename... Args>

Derived & ecstasy::SystemInstances::emplace ( Args &&... args )

inline

Emplace a new instance of type Derived in the storage.

Template Parameters

Derived	The type of the instance to create. It must inherit from Base.
Args	The arguments to pass to the constructor of Derived.

Parameters

[in] args The arguments to pass to the constructor of Derived.

Returns: Derived& A reference to the newly created object.

Exceptions

std::logic_error If an instance of type Derived was already set.

Author: Andréas Leroux (andre.nosp@m.as.l.nosp@m.eroux.nosp@m.@epi.nosp@m.tech..nosp@m.eu)

Since: 1.0.0 (2022-10-17)

Definition at line 151 of file SystemInstances.hpp.

        {
            std::type_index id(typeid(Derived));
 
            if (_instances.contains(id)) [[unlikely]]
                throw std::logic_error("Duplicate instance");
 
            return *dynamic_cast<Derived *>(_instances
                                                .emplace(std::make_pair(std::make_pair(id, Priority),
                                                    std::make_unique<Derived, Args...>(std::forward<Args>(args)...)))
                                                .first->second.get());
        }

◆ get() [1/4]

template<std::derived_from< ISystem > Derived>

Derived & ecstasy::SystemInstances::get ( )

inline

Get a reference to the contained instance of Derived.

Template Parameters

Derived Type of the instance to get, must inherit ISystem.

Returns: Derived& A reference to the instance of Derived contained within.

Exceptions

std::logic_error If no instance of Derived is in the set.

Author: Andréas Leroux (andre.nosp@m.as.l.nosp@m.eroux.nosp@m.@epi.nosp@m.tech..nosp@m.eu)

Since: 1.0.0 (2022-10-17)

Definition at line 229 of file SystemInstances.hpp.

        {
            return *getPtr<Derived>();
        }

◆ get() [2/4]

template<std::derived_from< ISystem > Derived>

const Derived & ecstasy::SystemInstances::get ( ) const

inline

Get a const reference to the contained instance of Derived.

Template Parameters

Derived Type of the instance to get, must inherit ISystem.

Returns: const Derived& A reference to the instance of Derived contained within.

Exceptions

std::logic_error If no instance of Derived is in the set.

Author: Andréas Leroux (andre.nosp@m.as.l.nosp@m.eroux.nosp@m.@epi.nosp@m.tech..nosp@m.eu)

Since: 1.0.0 (2022-10-17)

Definition at line 194 of file SystemInstances.hpp.

        {
            return *getPtr<Derived>();
        }

◆ get() [3/4]

ISystem & ecstasy::SystemInstances::get ( const std::type_index & type )

inline

Get a reference to the contained instance identified by type.

Parameters

[in] type the instance type index.

Returns: ISystem& A reference to the instance of ISystem contained within.

Exceptions

std::logic_error If no instance matching type is in the set.

Author: Andréas Leroux (andre.nosp@m.as.l.nosp@m.eroux.nosp@m.@epi.nosp@m.tech..nosp@m.eu)

Since: 1.0.0 (2022-10-17)

Definition at line 211 of file SystemInstances.hpp.

        {
            return *getPtr(type);
        }

◆ get() [4/4]

const ISystem & ecstasy::SystemInstances::get ( const std::type_index & type ) const

inline

Get a const reference to the contained instance identified by type.

Parameters

[in] type the instance type index.

Returns: const ISystem& A reference to the instance of ISystem contained within.

Exceptions

std::logic_error If no instance matching type is in the set.

Author: Andréas Leroux (andre.nosp@m.as.l.nosp@m.eroux.nosp@m.@epi.nosp@m.tech..nosp@m.eu)

Since: 1.0.0 (2022-10-17)

Definition at line 176 of file SystemInstances.hpp.

        {
            return *getPtr(type);
        }

◆ getInner()

constexpr const std::map< key_type, std::unique_ptr< ISystem >, Comparer > & ecstasy::SystemInstances::getInner ( ) const

inlineconstexprnoexcept

Get the backing container.

Returns: const std::unordered_map<std::type_index, std::unique_ptr<ISystem>>& backing container.

Author: Andréas Leroux (andre.nosp@m.as.l.nosp@m.eroux.nosp@m.@epi.nosp@m.tech..nosp@m.eu)

Since: 1.0.0 (2022-10-17)

Definition at line 323 of file SystemInstances.hpp.

        {
            return _instances;
        }

◆ getPtr() [1/2]

template<std::derived_from< ISystem > Derived>

Derived * ecstasy::SystemInstances::getPtr ( ) const

inline

Get a pointer to the contained instance of Derived.

Template Parameters

Derived Type of the instance to get, must inherit ISystem.

Returns: Derived* A pointer to the instance of Derived contained within.

Exceptions

std::logic_error If no instance of Derived is in the set.

Author: Andréas Leroux (andre.nosp@m.as.l.nosp@m.eroux.nosp@m.@epi.nosp@m.tech..nosp@m.eu)

Since: 1.0.0 (2022-10-17)

Definition at line 268 of file SystemInstances.hpp.

        {
            return dynamic_cast<Derived *>(getPtr(std::type_index(typeid(Derived))));
        }

◆ getPtr() [2/2]

ISystem * ecstasy::SystemInstances::getPtr ( const std::type_index & type ) const

inline

Get a pointer to the contained instance identified by type.

Parameters

[in] type the instance type index.

Returns: ISystem* A pointer to the instance of ISystem contained within.

Exceptions

std::logic_error If no instance matching type is in the set.

Author: Andréas Leroux (andre.nosp@m.as.l.nosp@m.eroux.nosp@m.@epi.nosp@m.tech..nosp@m.eu)

Since: 1.0.0 (2022-10-17)

Definition at line 246 of file SystemInstances.hpp.

        {
            const auto &valueIt = _instances.find(type);
 
            if (valueIt == _instances.end()) [[unlikely]]
                throw std::logic_error("Instance not found");
            return valueIt->second.get();
        }

Member Data Documentation

◆ _instances

std::map<key_type, std::unique_ptr<ISystem>, Comparer> ecstasy::SystemInstances::_instances

private

The internal map of instances.

Definition at line 330 of file SystemInstances.hpp.

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

src/ecstasy/storages/SystemInstances.hpp

Classes

Public Member Functions

Private Types

Private Attributes

Detailed Description

Member Typedef Documentation

◆ key_type

Constructor & Destructor Documentation

◆ SystemInstances() [1/2]

◆ ~SystemInstances()

◆ SystemInstances() [2/2]

Member Function Documentation

◆ clear()

◆ contains() [1/2]

◆ contains() [2/2]

◆ emplace()

◆ get() [1/4]

◆ get() [2/4]

◆ get() [3/4]

◆ get() [4/4]

◆ getInner()

◆ getPtr() [1/2]

◆ getPtr() [2/2]

Member Data Documentation

◆ _instances