Référence de la classe Castor::Collection< TObj, TKey > (modèle)

Classe de collection d'éléments. Plus de détails...

Graphe de collaboration de Castor::Collection< TObj, TKey >:

Liste de tous les membres

Types publics
typedef std::shared_ptr< TObj >	obj_ptr
typedef std::map< TKey, obj_ptr >	obj_map
	Typedef sur un pointeur du type d'objet collectionné.
typedef obj_map::iterator	iterator
	Typedef sur la map utilisée pour collectionner les objets.
typedef obj_map::const_iterator	const_iterator
	Typedef sur l'itérateur de la map.
typedef obj_map::value_type	value_type
	Typedef sur l'itérateur constant de la map.
typedef call_traits< TKey > ::param_type	key_param_type
	Typedef sur le type de valeur de la map.
Fonctions membres publiques
	Collection ()
	Constructeur.
virtual	~Collection ()
	Destructeur.
void	lock () const
	Locke le mutex de la collection.
void	unlock () const
	Délocke le mutex de la collection.
iterator	begin ()
	Renvoie un itérateur sur le premier élément de la collection.
const_iterator	begin () const
	Renvoie un itérateur constant sur le premier élément de la collection.
iterator	end ()
	Renvoie un itérateur sur l'après dernier élément de la collection.
const_iterator	end () const
	Renvoie un itérateur constant sur l'après dernier élément de la collection.
void	clear () throw ()
	Vide la collection.
obj_ptr	find (key_param_type p_key)
	Recherche dans la collection un objet situé à la clef donnée.
std::size_t	size () const
	Donne le nombre d'objets de la collection.
bool	insert (key_param_type p_key, obj_ptr p_element)
	Insère un élément à la clef donnée.
bool	has (key_param_type p_key) const
	Teste si un élément est associé à la clef donnée.
obj_ptr	erase (key_param_type p_key)
	Enlève de la collection l'élément associé à la clef donnée.

---

Description détaillée

template<typename TObj, typename TKey>
class Castor::Collection< TObj, TKey >

Classe de collection d'éléments.

Auteur:

Sylvain DOREMUS

Version:

0.6.1.0

Date:

19/10/2011

Remarques:

Une classe de collection, permettant de stocker des éléments nommés, les enlever, les rechercher.

---

Documentation des définitions de type membres

template<typename TObj, typename TKey>

typedef obj_map::const_iterator Castor::Collection< TObj, TKey >::const_iterator

Typedef sur l'itérateur de la map.

template<typename TObj, typename TKey>

typedef obj_map::iterator Castor::Collection< TObj, TKey >::iterator

Typedef sur la map utilisée pour collectionner les objets.

template<typename TObj, typename TKey>

typedef call_traits< TKey >::param_type Castor::Collection< TObj, TKey >::key_param_type

Typedef sur le type de valeur de la map.

template<typename TObj, typename TKey>

typedef std::map< TKey, obj_ptr > Castor::Collection< TObj, TKey >::obj_map

Typedef sur un pointeur du type d'objet collectionné.

template<typename TObj, typename TKey>

typedef std::shared_ptr< TObj > Castor::Collection< TObj, TKey >::obj_ptr

template<typename TObj, typename TKey>

typedef obj_map::value_type Castor::Collection< TObj, TKey >::value_type

Typedef sur l'itérateur constant de la map.

---

Documentation des constructeurs et destructeur

template<typename T , typename U >

Castor::Collection< T, U >::Collection

(

)

Constructeur.

template<typename T , typename U >

Castor::Collection< T, U >::~Collection

(

)

[virtual]

Destructeur.

---

Documentation des fonctions membres

template<typename T , typename U >

Collection< T, U >::iterator Castor::Collection< T, U >::begin

(

)

[inline]

Renvoie un itérateur sur le premier élément de la collection.

Renvoie:

L'itérateur

template<typename T , typename U >

Collection< T, U >::const_iterator Castor::Collection< T, U >::begin

(

)

const [inline]

Renvoie un itérateur constant sur le premier élément de la collection.

Renvoie:

L'itérateur

template<typename T , typename U >

void Castor::Collection< T, U >::clear

(

)

throw () [inline]

Vide la collection.

template<typename T , typename U >

Collection< T, U >::iterator Castor::Collection< T, U >::end

(

)

[inline]

Renvoie un itérateur sur l'après dernier élément de la collection.

Renvoie:

L'itérateur

template<typename T , typename U >

Collection< T, U >::const_iterator Castor::Collection< T, U >::end

(

)

const [inline]

Renvoie un itérateur constant sur l'après dernier élément de la collection.

Renvoie:

L'itérateur

template<typename T , typename U >

Collection< T, U >::obj_ptr Castor::Collection< T, U >::erase

(

key_param_type

p_key

)

[inline]

Enlève de la collection l'élément associé à la clef donnée.

Paramètres:

[in]

p_key

La clef

Renvoie:

L'élément associé, null_ptr sinon

template<typename T , typename U >

Collection< T, U >::obj_ptr Castor::Collection< T, U >::find

(

key_param_type

p_key

)

[inline]

Recherche dans la collection un objet situé à la clef donnée.

Paramètres:

[in]

p_key

La clef

Renvoie:

L'objet trouvé s'il existe, null_ptr sinon

template<typename T , typename U >

bool Castor::Collection< T, U >::has

(

key_param_type

p_key

)

const [inline]

Teste si un élément est associé à la clef donnée.

Paramètres:

[in]

p_key

La clef à tester

Renvoie:

Le résultat du test

template<typename T , typename U >

bool Castor::Collection< T, U >::insert	(	key_param_type	p_key,
		obj_ptr	p_element
	)			[inline]

Insère un élément à la clef donnée.

Paramètres:

[in]	p_key	La clef à laquelle l'élément sera associé
[in]	p_element	L'élément à insérer

Renvoie:

false si un élément est déjà associé à la clef

template<typename T , typename U >

void Castor::Collection< T, U >::lock

(

)

const [inline]

Locke le mutex de la collection.

template<typename T , typename U >

std::size_t Castor::Collection< T, U >::size

(

)

const [inline]

Donne le nombre d'objets de la collection.

Renvoie:

Le compte

template<typename T , typename U >

void Castor::Collection< T, U >::unlock

(

)

const [inline]

Délocke le mutex de la collection.

---

La documentation de cette classe a été générée à partir des fichiers suivants :

• include/CastorUtils/Collection.hpp