mage::ResourcePool< KeyT, ResourceT > Class Template Reference

#include <resource_pool.hpp>

Classes
class	Resource

Public Types
using	key_type = KeyT
using	value_type = ResourceT

Public Member Functions
	ResourcePool ()=default
	ResourcePool (const ResourcePool &pool)=delete
	ResourcePool (ResourcePool &&pool) noexcept
	~ResourcePool () noexcept
ResourcePool &	operator= (const ResourcePool &pool)=delete
ResourcePool &	operator= (ResourcePool &&pool)=delete
bool	empty () const noexcept
std::size_t	size () const noexcept
bool	Contains (const KeyT &key) noexcept
SharedPtr< ResourceT >	Get (const KeyT &key) noexcept
template<typename... ConstructorArgsT>
SharedPtr< ResourceT >	GetOrCreate (const KeyT &key, ConstructorArgsT &&... args)
template<typename DerivedResourceT , typename... ConstructorArgsT>
SharedPtr< ResourceT >	GetOrCreateDerived (const KeyT &key, ConstructorArgsT &&... args)
void	Remove (const KeyT &key)
void	RemoveAll () noexcept

Private Types
using	ResourceMap = std::map< KeyT, WeakPtr< ResourceT > >

Private Attributes
ResourceMap	m_resource_map
std::mutex	m_mutex

Detailed Description

template<typename KeyT, typename ResourceT>
class mage::ResourcePool< KeyT, ResourceT >

A class of resource pools.

Template Parameters

KeyT	The key type.
ResourceT	The resource type.

Member Typedef Documentation

key_type

template<typename KeyT , typename ResourceT >

using mage::ResourcePool< KeyT, ResourceT >::key_type = KeyT

The key type of resource pools.

ResourceMap

template<typename KeyT , typename ResourceT >

using mage::ResourcePool< KeyT, ResourceT >::ResourceMap = std::map< KeyT, WeakPtr< ResourceT > >

private

A resource map used by a resource pool.

value_type

template<typename KeyT , typename ResourceT >

using mage::ResourcePool< KeyT, ResourceT >::value_type = ResourceT

The value type of resource pools.

Constructor & Destructor Documentation

ResourcePool() [1/3]

template<typename KeyT , typename ResourceT >

mage::ResourcePool< KeyT, ResourceT >::ResourcePool ( )

default

Constructs a resource pool.

ResourcePool() [2/3]

template<typename KeyT , typename ResourceT >

mage::ResourcePool< KeyT, ResourceT >::ResourcePool ( const ResourcePool< KeyT, ResourceT > &  pool )

delete

Constructs a resource pool from the given resource pool.

Parameters

[in]

pool

A reference to the resource pool to copy.

ResourcePool() [3/3]

template<typename KeyT , typename ResourceT >

mage::ResourcePool< KeyT, ResourceT >::ResourcePool ( ResourcePool< KeyT, ResourceT > &&  pool )

noexcept

Constructs a resource pool by moving the given resource pool.

Parameters

[in]

pool

A reference to the resource pool to move.

~ResourcePool()

template<typename KeyT , typename ResourceT >

mage::ResourcePool< KeyT, ResourceT >::~ResourcePool ( )

noexcept

Destructs this resource pool.

Member Function Documentation

Contains()

template<typename KeyT , typename ResourceT >

bool mage::ResourcePool< KeyT, ResourceT >::Contains ( const KeyT &  key )

noexcept

Checks whether this resource pool contains a resource corresponding to the given key from this resource pool.

Parameters

[in]

key

A reference to the key of the resource.

Returns

true, if a resource is contained in this resource pool corresponding to the given key. false, otherwise.

empty()

template<typename KeyT , typename ResourceT >

bool mage::ResourcePool< KeyT, ResourceT >::empty ( ) const

noexcept

Checks whether this resource pool is empty.

Returns

true if this resource pool is empty. false otherwise.

Get()

template<typename KeyT , typename ResourceT >

SharedPtr< ResourceT > mage::ResourcePool< KeyT, ResourceT >::Get ( const KeyT &  key )

noexcept

Returns the resource corresponding to the given key from this resource pool.

Parameters

[in]

key

A reference to the key of the resource.

Returns

nullptr, if no resource is contained in this resource pool corresponding to the given key.

A pointer to the resource corresponding to the given key from this resource pool.

GetOrCreate()

template<typename KeyT , typename ResourceT >

template<typename... ConstructorArgsT>

SharedPtr< ResourceT > mage::ResourcePool< KeyT, ResourceT >::GetOrCreate	(	const KeyT &	key,
		ConstructorArgsT &&...	args
	)

Returns the resource corresponding to the given key from this resource pool.

If no resource is contained in this resource pool corresponding to the given key, a new resource is created from the given arguments, added to this resource pool and returned.

Template Parameters

ConstructorArgsT

The argument types for creating a new resource of type ResourceT.

Parameters

[in]	key	A reference to the key of the resource.
[in]	args	The arguments for creating a new resource of type ResourceT.

Returns

A pointer to the resource corresponding to the given key from this resource pool.

GetOrCreateDerived()

template<typename KeyT , typename ResourceT >

template<typename DerivedResourceT , typename... ConstructorArgsT>

SharedPtr< ResourceT > mage::ResourcePool< KeyT, ResourceT >::GetOrCreateDerived	(	const KeyT &	key,
		ConstructorArgsT &&...	args
	)

Returns the resource corresponding to the given key from this resource pool.

If no resource is contained in this resource pool corresponding to the given key, a new resource is created from the given arguments, added to this resource pool and returned.

Precondition

DerivedResourceT is a derived class of ResourceT.

Template Parameters

DerivedResourceT	The derived resource type.
ConstructorArgsT	The argument types for creating a new resource of type DerivedResourceT.

Parameters

[in]	key	A reference to the key of the resource.
[in]	args	The arguments for creating a new resource of type DerivedResourceT.

Returns

A pointer to the resource corresponding to the given key from this resource pool.

operator=() [1/2]

template<typename KeyT , typename ResourceT >

ResourcePool& mage::ResourcePool< KeyT, ResourceT >::operator= ( const ResourcePool< KeyT, ResourceT > &  pool )

delete

Copies the given resource pool to this resource pool.

Parameters

[in]

pool

A reference to the resource pool to copy.

Returns

A reference to the copy of the given resource pool (i.e. this resource pool).

operator=() [2/2]

template<typename KeyT , typename ResourceT >

ResourcePool& mage::ResourcePool< KeyT, ResourceT >::operator= ( ResourcePool< KeyT, ResourceT > &&  pool )

delete

Moves the given resource pool to this resource pool.

Parameters

[in]

pool

A reference to the resource pool to move.

Returns

A reference to the moved resource pool (i.e. this resource pool).

Remove()

template<typename KeyT , typename ResourceT >

void mage::ResourcePool< KeyT, ResourceT >::Remove

(

const KeyT &

key

)

Removes the resource corresponding to the given key from this resource pool.

Parameters

[in]

key

A reference to the key of the resource to remove.

RemoveAll()

template<typename KeyT , typename ResourceT >

void mage::ResourcePool< KeyT, ResourceT >::RemoveAll ( )

noexcept

Removes all resources from this resource pool.

size()

template<typename KeyT , typename ResourceT >

std::size_t mage::ResourcePool< KeyT, ResourceT >::size ( ) const

noexcept

Returns the number of resources contained in this resource pool.

Member Data Documentation

m_mutex

template<typename KeyT , typename ResourceT >

std::mutex mage::ResourcePool< KeyT, ResourceT >::m_mutex

mutableprivate

The mutex for accessing the resource map of this resource pool.

m_resource_map

template<typename KeyT , typename ResourceT >

ResourceMap mage::ResourcePool< KeyT, ResourceT >::m_resource_map

private

The resource map of this resource pool.