Référence du modèle de la classe Castor3D::Cache< ElementType, KeyType >

Classe de base pour un cache d'éléments. Plus de détails...

Graphe d'héritage de Castor3D::Cache< ElementType, KeyType >:

Graphe de collaboration de Castor3D::Cache< ElementType, KeyType >:

Types publics
using	MyCacheType = CacheBase< ElementType, KeyType >
using	MyCacheTraits = typename MyCacheType::MyCacheTraits
using	Element = typename MyCacheType::Element
using	Key = typename MyCacheType::Key
using	Collection = typename MyCacheType::Collection
using	ElementPtr = typename MyCacheType::ElementPtr
using	Producer = typename MyCacheType::Producer
using	Initialiser = typename MyCacheType::Initialiser
using	Cleaner = typename MyCacheType::Cleaner
using	Merger = typename MyCacheType::Merger
Types publics hérités de Castor3D::CacheBase< ElementType, KeyType >
using	MyCacheType = CacheBase< ElementType, KeyType >
using	MyCacheTraits = CacheTraits< ElementType, KeyType >
using	Element = ElementType
using	Key = KeyType
using	Collection = Castor::Collection< Element, Key >
using	ElementPtr = std::shared_ptr< Element >
using	Producer = typename MyCacheTraits::Producer
using	Merger = typename MyCacheTraits::Merger
using	Initialiser = ElementInitialiser< Element >
using	Cleaner = ElementCleaner< Element >

Fonctions membres publiques
	Cache (Engine &p_engine, Producer &&p_produce, Initialiser &&p_initialise=Initialiser{}, Cleaner &&p_clean=Cleaner{}, Merger &&p_merge=Merger{})
	Constructeur. Plus de détails...
	~Cache ()
	Destructeur. Plus de détails...
Fonctions membres publiques hérités de Castor3D::CacheBase< ElementType, KeyType >
	CacheBase (Engine &p_engine, Producer &&p_produce, Initialiser &&p_initialise, Cleaner &&p_clean, Merger &&p_merge)
	Constructeur. Plus de détails...
	~CacheBase ()
	Destructeur. Plus de détails...
void	Cleanup ()
	Met tous les éléments à nettoyer. Plus de détails...
void	Clear ()
	Vide la collection. Plus de détails...
bool	IsEmpty ()
template<typename ... Parameters>
ElementPtr	Create (Key const &p_name, Parameters &&... p_parameters)
	Crée un élément. Plus de détails...
ElementPtr	Add (Key const &p_name, ElementPtr p_element)
	Retire un élément à partir d'un nom. Plus de détails...
template<typename ... Parameters>
ElementPtr	Add (Key const &p_name, Parameters &&... p_parameters)
	Crée un élément. Plus de détails...
void	Remove (Key const &p_name)
	Retire un élément à partir d'un nom. Plus de détails...
void	MergeInto (MyCacheType &p_destination)
template<typename FuncType >
void	ForEach (FuncType p_func) const
	Applique une fonction à tous les éléments de ce cache. Plus de détails...
template<typename FuncType >
void	ForEach (FuncType p_func)
	Applique une fonction à tous les éléments de ce cache. Plus de détails...
uint32_t	GetObjectCount () const
Engine *	GetEngine () const
Castor::String const &	GetObjectTypeName () const
bool	Has (Key const &p_name) const
ElementPtr	Find (Key const &p_name) const
	Cherche un élément par son nom. Plus de détails...
void	lock () const
	Locke le mutex de la collection. Plus de détails...
void	unlock () const
	Délocke le mutex de la collection. Plus de détails...
auto	begin ()
auto	begin () const
auto	end ()
auto	end () const

Membres hérités additionnels
Attributs protégés hérités de Castor3D::CacheBase< ElementType, KeyType >
Engine &	m_engine
Collection	m_elements
Producer	m_produce
Initialiser	m_initialise
Cleaner	m_clean
Merger	m_merge

Description détaillée

template<typename ElementType, typename KeyType>
class Castor3D::Cache< ElementType, KeyType >

Classe de base pour un cache d'éléments.

Auteur

Sylvain DOREMUS

Date

13/10/2015

Version

0.8.0

Documentation des définitions de type membres

Cleaner

template<typename ElementType , typename KeyType >

using Castor3D::Cache< ElementType, KeyType >::Cleaner = typename MyCacheType::Cleaner

Collection

template<typename ElementType , typename KeyType >

using Castor3D::Cache< ElementType, KeyType >::Collection = typename MyCacheType::Collection

Element

template<typename ElementType , typename KeyType >

using Castor3D::Cache< ElementType, KeyType >::Element = typename MyCacheType::Element

ElementPtr

template<typename ElementType , typename KeyType >

using Castor3D::Cache< ElementType, KeyType >::ElementPtr = typename MyCacheType::ElementPtr

Initialiser

template<typename ElementType , typename KeyType >

using Castor3D::Cache< ElementType, KeyType >::Initialiser = typename MyCacheType::Initialiser

Key

template<typename ElementType , typename KeyType >

using Castor3D::Cache< ElementType, KeyType >::Key = typename MyCacheType::Key

Merger

template<typename ElementType , typename KeyType >

using Castor3D::Cache< ElementType, KeyType >::Merger = typename MyCacheType::Merger

MyCacheTraits

template<typename ElementType , typename KeyType >

using Castor3D::Cache< ElementType, KeyType >::MyCacheTraits = typename MyCacheType::MyCacheTraits

MyCacheType

template<typename ElementType , typename KeyType >

using Castor3D::Cache< ElementType, KeyType >::MyCacheType = CacheBase< ElementType, KeyType >

Producer

template<typename ElementType , typename KeyType >

using Castor3D::Cache< ElementType, KeyType >::Producer = typename MyCacheType::Producer

Documentation des constructeurs et destructeur

Cache()

template<typename ElementType , typename KeyType >

Castor3D::Cache< ElementType, KeyType >::Cache ( Engine &  p_engine, Producer &&  p_produce, Initialiser &&  p_initialise = Initialiser{}, Cleaner &&  p_clean = Cleaner{}, Merger &&  p_merge = Merger{}  )

inline

Constructeur.

Paramètres

[in]	p_engine	Le moteur.
[in]	p_produce	Le créateur d'objet.
[in]	p_initialise	L'initialiseur d'objet.
[in]	p_clean	Le nettoyeur d'objet.
[in]	p_merge	Le fusionneur de collection d'objets.

~Cache()

template<typename ElementType , typename KeyType >

Castor3D::Cache< ElementType, KeyType >::~Cache ( )

inline

Destructeur.

---

La documentation de cette classe a été générée à partir du fichier suivant :

• Y:/software/perso/Castor3D/source/Core/Castor3D/Src/Cache/Cache.hpp