Encapsulation d'un pointeur. Plus de détails...

#include <arccore/base/CheckedPointer.h>

Graphe d'héritage de Arccore::CheckedPointer< T >:

Graphe de collaboration de Arccore::CheckedPointer< T >:

Fonctions membres publiques
	CheckedPointer ()
	Construit une instance sans référence.

	CheckedPointer (T *t)
	Construit une instance référant t.

	operator bool () const

T *	operator-> () const
	Retourne l'objet référé par l'instance.

T &	operator* () const
	Retourne l'objet référé par l'instance.

T *	get () const
	Retourne l'objet référé par l'instance.

bool	isNull () const

Fonctions membres protégées
const CheckedPointer< T > &	operator= (const CheckedPointer< T > &from)
	Opérateur de copie.

template<typename T2 >
const CheckedPointer< T > &	operator= (const CheckedPointer< T2 > &from)

const CheckedPointer< T > &	operator= (T *new_value)
	Affecte à l'instance la value new_value.

	CheckedPointer (const CheckedPointer< T > &from)
	Construit une référence référant from.

template<typename T2 >
	CheckedPointer (const CheckedPointer< T2 > &from)
	Construit une référence référant from.

Attributs protégés
T *	m_value
	Pointeur sur l'objet référencé

Amis
template<typename T2 >
bool	operator== (const CheckedPointer< T > &v1, const CheckedPointer< T2 > &v2)
	Compare les objets référencés par v1 et v2 La comparaison se fait pointeur par pointeur.

template<typename T2 >
bool	operator!= (const CheckedPointer< T > &v1, const CheckedPointer< T2 > &v2)
	Compare les objets référencés par v1 et v2 La comparaison se fait pointeur par pointeur.

Description détaillée

template<class T>
class Arccore::CheckedPointer< T >

Encapsulation d'un pointeur.

Cette classe ne fait rien de particulier si ce n'est encapsulé un pointeur d'un type quelconque. Elle sert de classe de base à d'autres classes qui fournissent des fonctionnalités plus évoluées comme AutoRefT.

Afin d'éviter des copies malencontreuses, le constructeur de copie et les opérateurs de copie sont protégés.

En mode débug, vérifie qu'on accède pas à un pointeur nul.

Le paramètre template n'a pas besoin d'être défini. Cette classe peut donc être instanciée pour un type opaque.

Définition à la ligne 43 du fichier CheckedPointer.h.

Documentation des constructeurs et destructeur

◆ CheckedPointer() [1/4]

template<class T >

Arccore::CheckedPointer< T >::CheckedPointer ( const CheckedPointer< T > & from )

inlineprotected

Construit une référence référant from.

Définition à la ligne 69 du fichier CheckedPointer.h.

◆ CheckedPointer() [2/4]

template<class T >

template<typename T2 >

Arccore::CheckedPointer< T >::CheckedPointer ( const CheckedPointer< T2 > & from )

inlineprotected

Construit une référence référant from.

Définition à la ligne 73 du fichier CheckedPointer.h.

◆ CheckedPointer() [3/4]

template<class T >

Arccore::CheckedPointer< T >::CheckedPointer ( )

inline

Construit une instance sans référence.

Définition à la ligne 78 du fichier CheckedPointer.h.

◆ CheckedPointer() [4/4]

template<class T >

Arccore::CheckedPointer< T >::CheckedPointer ( T * t )

inlineexplicit

Construit une instance référant t.

Définition à la ligne 81 du fichier CheckedPointer.h.

Documentation des fonctions membres

◆ get()

template<class T >

T * Arccore::CheckedPointer< T >::get ( ) const

inline

Retourne l'objet référé par l'instance.

Avertissement: En général, il faut être prudent lorsqu'on utilise cette fonction et ne pas conservé le pointeur retourné.

Définition à la ligne 113 du fichier CheckedPointer.h.

Références Arccore::CheckedPointer< T >::m_value.

Référencé par Arccore::impl::ReferenceCounterWrapper< InstanceType >::get().

◆ isNull()

template<class T >

bool Arccore::CheckedPointer< T >::isNull ( ) const

inline

Définition à la ligne 118 du fichier CheckedPointer.h.

◆ operator bool()

template<class T >

Arccore::CheckedPointer< T >::operator bool ( ) const

inlineexplicit

Définition à la ligne 84 du fichier CheckedPointer.h.

◆ operator*()

template<class T >

T & Arccore::CheckedPointer< T >::operator* ( ) const

inline

Retourne l'objet référé par l'instance.

Définition à la ligne 98 du fichier CheckedPointer.h.

Références Arccore::arccoreNullPointerError(), et Arccore::CheckedPointer< T >::m_value.

◆ operator->()

template<class T >

T * Arccore::CheckedPointer< T >::operator-> ( ) const

inline

Retourne l'objet référé par l'instance.

Définition à la ligne 88 du fichier CheckedPointer.h.

Références Arccore::arccoreNullPointerError(), et Arccore::CheckedPointer< T >::m_value.

◆ operator=() [1/3]

template<class T >

const CheckedPointer< T > & Arccore::CheckedPointer< T >::operator= ( const CheckedPointer< T > & from )

inlineprotected

Opérateur de copie.

Définition à la ligne 48 du fichier CheckedPointer.h.

Références Arccore::CheckedPointer< T >::m_value.

◆ operator=() [2/3]

template<class T >

template<typename T2 >

const CheckedPointer< T > & Arccore::CheckedPointer< T >::operator= ( const CheckedPointer< T2 > & from )

inlineprotected

Définition à la ligne 55 du fichier CheckedPointer.h.

◆ operator=() [3/3]

template<class T >

const CheckedPointer< T > & Arccore::CheckedPointer< T >::operator= ( T * new_value )

inlineprotected

Affecte à l'instance la value new_value.

Définition à la ligne 63 du fichier CheckedPointer.h.

Références Arccore::CheckedPointer< T >::m_value.

Documentation des fonctions amies et associées

◆ operator!=

template<class T >

template<typename T2 >

bool operator!=	(	const CheckedPointer< T > &	v1,
		const CheckedPointer< T2 > &	v2
	)

friend

Compare les objets référencés par v1 et v2 La comparaison se fait pointeur par pointeur.

Valeurs retournées

false	s'ils sont égaux
true	sinon

Définition à la ligne 143 du fichier CheckedPointer.h.

◆ operator==

template<class T >

template<typename T2 >

bool operator==	(	const CheckedPointer< T > &	v1,
		const CheckedPointer< T2 > &	v2
	)

friend

Compare les objets référencés par v1 et v2 La comparaison se fait pointeur par pointeur.

Valeurs retournées

true	s'ils sont égaux
false	sinon

Définition à la ligne 131 du fichier CheckedPointer.h.

Documentation des données membres

◆ m_value

template<class T >

T* Arccore::CheckedPointer< T >::m_value

protected

Pointeur sur l'objet référencé

Définition à la ligne 150 du fichier CheckedPointer.h.

Référencé par Arccore::CheckedPointer< T >::get(), Arccore::CheckedPointer< T >::operator*(), Arccore::CheckedPointer< T >::operator->(), Arccore::CheckedPointer< T >::operator=(), et Arccore::CheckedPointer< T >::operator=().

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

Fonctions membres publiques

Fonctions membres protégées

Attributs protégés

Amis

Description détaillée

Documentation des constructeurs et destructeur

◆ CheckedPointer() [1/4]

◆ CheckedPointer() [2/4]

◆ CheckedPointer() [3/4]

◆ CheckedPointer() [4/4]

Documentation des fonctions membres

◆ get()

◆ isNull()

◆ operator bool()

◆ operator*()

◆ operator->()

◆ operator=() [1/3]

◆ operator=() [2/3]

◆ operator=() [3/3]

Documentation des fonctions amies et associées

◆ operator!=

◆ operator==

Documentation des données membres

◆ m_value