ecstasy::Instances< Base > Class Template Reference

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

#include <Instances.hpp>

Collaboration diagram for ecstasy::Instances< Base >:

Public Member Functions
	Instances ()=default
	Construct a new Instances storage.
	~Instances ()=default
	Destroy the Instances storage.
	Instances (const Instances &other)=delete
	Instances aren't copy constructible.
template<std::derived_from< Base > Derived, typename... Args>
Derived &	emplace (Args &&...args)
	Emplace a new instance of type Derived in the storage.
const Base &	get (const std::type_index &type) const
	Get a const reference to the contained instance identified by type.
template<std::derived_from< Base > Derived>
const Derived &	get () const
	Get a const reference to the contained instance of Derived.
Base &	get (const std::type_index &type)
	Get a reference to the contained instance identified by type.
template<std::derived_from< Base > Derived>
Derived &	get ()
	Get a reference to the contained instance of Derived.
Base *	getPtr (const std::type_index &type) const
	Get a pointer to the contained instance identified by type.
template<std::derived_from< Base > 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< Base > Derived>
bool	contains () const
	Check whether an instance of Derived is contained in the set.
void	clear ()
	Remove all stored instances.
constexpr const std::unordered_map< std::type_index, std::unique_ptr< Base > > &	getInner () const noexcept
	Get the backing container.

Private Attributes
std::unordered_map< std::type_index, std::unique_ptr< Base > >	_instances
	The instances container.

Detailed Description

template<typename Base>
class ecstasy::Instances< Base >

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 32 of file Instances.hpp.

Constructor & Destructor Documentation

Instances() [1/2]

template<typename Base >

ecstasy::Instances< Base >::Instances ( )

default

Construct a new Instances 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)

~Instances()

template<typename Base >

ecstasy::Instances< Base >::~Instances ( )

default

Destroy the Instances 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)

Instances() [2/2]

template<typename Base >

ecstasy::Instances< Base >::Instances ( const Instances< Base > &  other )

delete

Instances 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()

template<typename Base >

void ecstasy::Instances< Base >::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 234 of file Instances.hpp.

        {
            _instances.clear();
        }

contains() [1/2]

template<typename Base >

template<std::derived_from< Base > Derived>

bool ecstasy::Instances< Base >::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 Base.

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 223 of file Instances.hpp.

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

contains() [2/2]

template<typename Base >

bool ecstasy::Instances< Base >::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 207 of file Instances.hpp.

        {
            return _instances.contains(type);
        }

emplace()

template<typename Base >

template<std::derived_from< Base > Derived, typename... Args>

Derived & ecstasy::Instances< Base >::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 76 of file Instances.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(id, std::make_unique<Derived, Args...>(std::forward<Args>(args)...)))
                    .first->second.get());
        }

get() [1/4]

template<typename Base >

template<std::derived_from< Base > Derived>

Derived & ecstasy::Instances< Base >::get ( )

inline

Get a reference to the contained instance of Derived.

Template Parameters

Derived

Type of the instance to get, must inherit Base.

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 153 of file Instances.hpp.

        {
            return *getPtr<Derived>();
        }

get() [2/4]

template<typename Base >

template<std::derived_from< Base > Derived>

const Derived & ecstasy::Instances< Base >::get ( ) const

inline

Get a const reference to the contained instance of Derived.

Template Parameters

Derived

Type of the instance to get, must inherit Base.

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 118 of file Instances.hpp.

        {
            return *getPtr<Derived>();
        }

get() [3/4]

template<typename Base >

Base & ecstasy::Instances< Base >::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

Base& A reference to the instance of Base 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 135 of file Instances.hpp.

        {
            return *getPtr(type);
        }

get() [4/4]

template<typename Base >

const Base & ecstasy::Instances< Base >::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 Base& A reference to the instance of Base 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 100 of file Instances.hpp.

        {
            return *getPtr(type);
        }

getInner()

template<typename Base >

constexpr const std::unordered_map< std::type_index, std::unique_ptr< Base > > & ecstasy::Instances< Base >::getInner ( ) const

inlineconstexprnoexcept

Get the backing container.

Returns

const std::unordered_map<std::type_index, std::unique_ptr<Base>>& 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 248 of file Instances.hpp.

        {
            return _instances;
        }

getPtr() [1/2]

template<typename Base >

template<std::derived_from< Base > Derived>

Derived * ecstasy::Instances< Base >::getPtr ( ) const

inline

Get a pointer to the contained instance of Derived.

Template Parameters

Derived

Type of the instance to get, must inherit Base.

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 192 of file Instances.hpp.

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

getPtr() [2/2]

template<typename Base >

Base * ecstasy::Instances< Base >::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

Base* A pointer to the instance of Base 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 170 of file Instances.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

template<typename Base >

std::unordered_map<std::type_index, std::unique_ptr<Base> > ecstasy::Instances< Base >::_instances

private

The instances container.

Definition at line 255 of file Instances.hpp.

---

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

• src/ecstasy/storages/Instances.hpp