classe de base d'implémentation d'une collection. Plus de détails...

#include </__w/arcaneframework.github.io/arcaneframework.github.io/framework/arccore/src/common/arccore/common/Collection.h>

Graphe d'héritage de Arcane::CollectionImplBase:

Graphe de collaboration de Arcane::CollectionImplBase:

Types publics
typedef Integer	size_type
	Type indexant le tableau.

typedef ptrdiff_t	difference_type
	Type d'une distance entre itérateur éléments du tableau.

Fonctions membres publiques
	CollectionImplBase ()=default
	Construit une collection vide.

	CollectionImplBase (Integer acount)
	Construit une collection avec acount éléments.

	CollectionImplBase (const CollectionImplBase &from)=delete
	Opérateur de recopie. les handlers d'évènements ne sont pas recopiés.

Integer	count () const
	Retourne le nombre d'éléments de la collection.

virtual void	clear ()=0
	Supprime tous les éléments de la collection.

virtual void	onClear ()
	Evènement envoyé avant de supprimer tous les éléments.

virtual void	onClearComplete ()
	Evènement envoyé lorsque tous les éléments ont été supprimés.

virtual void	onInsert ()
	Evènement envoyé avant d'insérer un élément.

virtual void	onInsertComplete (void *object, Integer position)
	Evènement envoyé après insertion d'un élément.

virtual void	onRemove ()
	Evènement envoyé avant de supprimer un élément.

virtual void	onRemoveComplete (void *object, Integer position)
	Evènement envoyé après supression d'un élément.

virtual void	onSet ()

virtual void	onSetComplete (void *object, Integer position)

virtual void	onValidate ()

virtual EnumeratorImplBase *	enumerator () const =0
	Retourne un énumérateur générique sur la collection.

CollectionChangeEventHandler &	change ()

Fonctions membres publiques hérités de Arcane::ObjectImpl
	ObjectImpl (const ObjectImpl &rhs)=delete

ObjectImpl &	operator= (const ObjectImpl &rhs)=delete

void	addRef ()
	Incrémente le compteur de référence.

void	removeRef ()
	Décrémente le compteur de référence.

Int32	refCount () const
	Retourne la valeur du compteur de référence.

virtual void	deleteMe ()
	Détruit cet objet.

Fonctions membres protégées
void	_setCount (Integer acount)

Fonctions membres privées
void	_sendEvent (CollectionEventArgs::eAction action, void *object, Integer position)

Attributs privés
Integer	m_count = 0

CollectionChangeEventHandler	m_collection_handlers

Description détaillée

classe de base d'implémentation d'une collection.

Une collection est un objet contenant des éléments (i.e. un conteneur).

Il est possible de parcourir les éléments d'une collection au moyen d'un énumerateur obtenu par enumerator(). L'énumérateur ainsi obtenu est générique quel que soit le type de la collection. Il est par conséquent moins performant qu'un énumérateur dédié à un type et il vaut mieux utiliser ce dernier si cela est possible.

Une collection génère des événements lorsque des éléments sont supprimés, insérés ou modifiés. Il est possible d'enregistrer un handler pour obtenir ces évènements avec change().

Les opérations constantes sont threadsafe.

Cette classe est destinée à être dérivée pour chaque implémentation d'une collection.

Voir également: EnumeratorImpl

Définition à la ligne 322 du fichier arccore/src/common/arccore/common/Collection.h.

Documentation des définitions de type membres

◆ difference_type

typedef ptrdiff_t Arcane::CollectionImplBase::difference_type

Type d'une distance entre itérateur éléments du tableau.

Définition à la ligne 330 du fichier arccore/src/common/arccore/common/Collection.h.

◆ size_type

typedef Integer Arcane::CollectionImplBase::size_type

Type indexant le tableau.

Définition à la ligne 328 du fichier arccore/src/common/arccore/common/Collection.h.

Documentation des constructeurs et destructeur

◆ CollectionImplBase()

Arcane::CollectionImplBase::CollectionImplBase ( Integer acount )

inlineexplicit

Construit une collection avec acount éléments.

Définition à la ligne 337 du fichier arccore/src/common/arccore/common/Collection.h.

Documentation des fonctions membres

◆ _sendEvent()

void Arcane::CollectionImplBase::_sendEvent	(	CollectionEventArgs::eAction	action,
		void *	object,
		Integer	position )

inlineprivate

Définition à la ligne 401 du fichier arccore/src/common/arccore/common/Collection.h.

◆ _setCount()

void Arcane::CollectionImplBase::_setCount ( Integer acount )

inlineprotected

Définition à la ligne 392 du fichier arccore/src/common/arccore/common/Collection.h.

◆ change()

CollectionChangeEventHandler & Arcane::CollectionImplBase::change ( )

inline

Définition à la ligne 388 du fichier arccore/src/common/arccore/common/Collection.h.

◆ clear()

virtual void Arcane::CollectionImplBase::clear ( )

pure virtual

Supprime tous les éléments de la collection.

Implémenté dans Arcane::ListImplBase< T >.

◆ count()

Integer Arcane::CollectionImplBase::count ( ) const

inline

Retourne le nombre d'éléments de la collection.

Définition à la ligne 347 du fichier arccore/src/common/arccore/common/Collection.h.

Référencé par Arcane::ListImplBase< T >::add(), Arcane::ListImplBase< T >::end(), Arcane::ListImplBase< T >::end(), et Arcane::ListImplBase< T >::end2().

Voici le graphe des appelants de cette fonction :

◆ enumerator()

virtual EnumeratorImplBase * Arcane::CollectionImplBase::enumerator ( ) const

pure virtual

Retourne un énumérateur générique sur la collection.

Implémenté dans Arcane::ListImplBase< T >.

◆ onClear()

virtual void Arcane::CollectionImplBase::onClear ( )

inlinevirtual

Evènement envoyé avant de supprimer tous les éléments.

Définition à la ligne 354 du fichier arccore/src/common/arccore/common/Collection.h.

Référencé par Arcane::ListImplBase< T >::clear().

Voici le graphe des appelants de cette fonction :

◆ onClearComplete()

virtual void Arcane::CollectionImplBase::onClearComplete ( )

inlinevirtual

Evènement envoyé lorsque tous les éléments ont été supprimés.

Définition à la ligne 356 du fichier arccore/src/common/arccore/common/Collection.h.

Référencé par Arcane::ListImplBase< T >::clear().

Voici le graphe des appelants de cette fonction :

◆ onInsert()

virtual void Arcane::CollectionImplBase::onInsert ( )

inlinevirtual

Evènement envoyé avant d'insérer un élément.

Définition à la ligne 361 du fichier arccore/src/common/arccore/common/Collection.h.

Référencé par Arcane::ListImplBase< T >::add().

Voici le graphe des appelants de cette fonction :

◆ onInsertComplete()

virtual void Arcane::CollectionImplBase::onInsertComplete	(	void *	object,
		Integer	position )

inlinevirtual

Evènement envoyé après insertion d'un élément.

Définition à la ligne 363 du fichier arccore/src/common/arccore/common/Collection.h.

Référencé par Arcane::ListImplBase< T >::add().

Voici le graphe des appelants de cette fonction :

◆ onRemove()

virtual void Arcane::CollectionImplBase::onRemove ( )

inlinevirtual

Evènement envoyé avant de supprimer un élément.

Définition à la ligne 368 du fichier arccore/src/common/arccore/common/Collection.h.

◆ onRemoveComplete()

virtual void Arcane::CollectionImplBase::onRemoveComplete	(	void *	object,
		Integer	position )

inlinevirtual

Evènement envoyé après supression d'un élément.

Définition à la ligne 370 du fichier arccore/src/common/arccore/common/Collection.h.

◆ onSet()

virtual void Arcane::CollectionImplBase::onSet ( )

inlinevirtual

Définition à la ligne 374 du fichier arccore/src/common/arccore/common/Collection.h.

◆ onSetComplete()

virtual void Arcane::CollectionImplBase::onSetComplete	(	void *	object,
		Integer	position )

inlinevirtual

Définition à la ligne 375 du fichier arccore/src/common/arccore/common/Collection.h.

◆ onValidate()

virtual void Arcane::CollectionImplBase::onValidate ( )

inlinevirtual

Définition à la ligne 379 du fichier arccore/src/common/arccore/common/Collection.h.

Documentation des données membres

◆ m_collection_handlers

CollectionChangeEventHandler Arcane::CollectionImplBase::m_collection_handlers

private

Définition à la ligne 397 du fichier arccore/src/common/arccore/common/Collection.h.

◆ m_count

Integer Arcane::CollectionImplBase::m_count = 0

private

Définition à la ligne 396 du fichier arccore/src/common/arccore/common/Collection.h.

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

arccore/src/common/arccore/common/Collection.h

Types publics

Fonctions membres publiques

Fonctions membres protégées

Fonctions membres privées

Attributs privés

Description détaillée

Documentation des définitions de type membres

◆ difference_type

◆ size_type

Documentation des constructeurs et destructeur

◆ CollectionImplBase()

Documentation des fonctions membres

◆ _sendEvent()

◆ _setCount()

◆ change()

◆ clear()

◆ count()

◆ enumerator()

◆ onClear()

◆ onClearComplete()

◆ onInsert()

◆ onInsertComplete()

◆ onRemove()

◆ onRemoveComplete()

◆ onSet()

◆ onSetComplete()

◆ onValidate()

Documentation des données membres

◆ m_collection_handlers

◆ m_count