Variable tableau. Plus de détails...

#include <arcane/core/VariableRefArray.h>

Types publics
typedef T	DataType

typedef Array< T >	ValueType

typedef ArrayView< T >::const_reference	ConstReturnReferenceType

typedef ArrayView< T >::reference	ReturnReferenceType

typedef DataType	ElementType
	Type des éléments de la variable.

typedef VariableRef	BaseClass
	Type de la classe de base.

typedef Array< DataType >	ContainerType
	Type de la classe gérant la valeur de la variable.

typedef ArrayView< DataType >	ArrayBase
	Type du tableau permettant d'accéder à la variable.

typedef VariableArrayT< DataType >	PrivatePartType

typedef VariableRefArrayT< DataType >	ThatClass

typedef VariableRefArrayLockT< DataType >	LockType

Types publics hérités de Arcane::ArrayView< T >
using	ThatClass = ArrayView<T>

typedef T	value_type
	Type des éléments du tableau.

typedef value_type *	pointer
	Type pointeur d'un élément du tableau.

typedef const value_type *	const_pointer
	Type pointeur constant d'un élément du tableau.

typedef ArrayIterator< pointer >	iterator
	Type de l'itérateur sur un élément du tableau.

typedef ArrayIterator< const_pointer >	const_iterator
	Type de l'itérateur constant sur un élément du tableau.

typedef value_type &	reference
	Type référence d'un élément du tableau.

typedef const value_type &	const_reference
	Type référence constante d'un élément du tableau.

typedef Integer	size_type
	Type indexant le tableau.

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

typedef IterT< ArrayView< T > >	iter
	Type d'un itérateur sur tout le tableau.

typedef ConstIterT< ArrayView< T > >	const_iter
	Type d'un itérateur constant sur tout le tableau.

typedef std::reverse_iterator< iterator >	reverse_iterator

typedef std::reverse_iterator< const_iterator >	const_reverse_iterator

Fonctions membres publiques
	VariableRefArrayT (const VariableBuildInfo &vb)
	Construit une référence à une variable tableau spécifiée dans vb.

	VariableRefArrayT (const VariableRefArrayT< DataType > &rhs)
	Construit une référence à partir de rhs.

	VariableRefArrayT (IVariable *var)
	Construit une référence à partir de var.

void	refersTo (const VariableRefArrayT< DataType > &rhs)
	Positionne la référence de l'instance à la variable rhs.

	~VariableRefArrayT () override
	Libère les ressources.

virtual void	resize (Integer new_size)
	Redimensionne le tableau pour contenir new_size éléments.

virtual void	resizeWithReserve (Integer new_size, Integer nb_additional)
	Redimensionne le tableau pour contenir new_size éléments.

virtual bool	isArrayVariable () const

Integer	arraySize () const override
	Si la variable est un tableau, retourne sa dimension, sinon retourne 0.

void	updateFromInternal () override
	Mise à jour à partir de la partie interne.

ArrayView< DataType >	asArray ()

ConstArrayView< DataType >	asArray () const

LockType	lock ()

ContainerType &	internalContainer ()
	Retourne le conteneur des valeurs de cette variable.

IArrayDataInternalT< T > *	_internalTrueData ()

Fonctions membres publiques hérités de Arcane::VariableRef
virtual	~VariableRef ()
	Libère les ressources.

ISubDomain *	subDomain () const
	Sous-domaine associé à la variable (TODO rendre obsolète fin 2023)

IVariableMng *	variableMng () const
	Gestionnaire de variable associé à la variable.

String	name () const
	Nom de la variable.

virtual eDataType	dataType () const
	Type de la variable (Real, Integer, ...)

virtual void	print (std::ostream &o) const
	Affiche la valeur de la variable.

virtual IModule *	module () const
	Module associé à la variable (ou nullptr, s'il n'y en a pas)

virtual int	property () const
	Propriétés de la variable.

virtual int	referenceProperty () const
	Propriétés de la référence (interne)

virtual void	setProperty (int property)
	Positionne la propriété property.

virtual void	unsetProperty (int property)
	Supprime la propriété property.

virtual void	registerVariable ()
	Enregistre la variable (interne)

virtual void	unregisterVariable ()
	Supprime l'enregistrement de la variable (interne)

IVariable *	variable () const
	Variable associée.

virtual Integer	checkIfSync (int max_print=0)
	Vérifie si la variable est bien synchronisée.

virtual Integer	checkIfSameOnAllReplica (int max_print=0)
	Vérifie si la variable a les mêmes valeurs sur tous les réplicas.

void	setUsed (bool v)

bool	isUsed () const

virtual void	internalSetUsed (bool)

const String &	assignmentStackTrace () const
	Pile d'appel au moment de l'assignation de cette instance.

void	addTag (const String &tagname, const String &tagvalue)
	Ajoute le tag tagname avev la valeur tagvalue.

void	removeTag (const String &tagname)
	Supprime le tag tagname.

bool	hasTag (const String &tagname) const
	true si la variable possède le tag tagname

String	tagValue (const String &tagname) const
	Valeur du tag tagname. La chaîne est nulle si le tag n'existe pas.

void	update ()
	Recalcule la variable si nécessaire.

void	setUpToDate ()
	Indique que la variable vient d'être mise à jour.

Int64	modifiedTime ()
	Temps auquel la variable a été mise à jour.

void	addDependCurrentTime (const VariableRef &var)
	Ajoute var à la liste des dépendances au temps courant.

void	addDependCurrentTime (const VariableRef &var, const TraceInfo &tinfo)
	Ajoute var à la liste des dépendances au temps courant avec les infos de trace tinfo.

void	addDependPreviousTime (const VariableRef &var)
	Ajoute var à la liste des dépendances au temps précédent.

void	addDependPreviousTime (const VariableRef &var, const TraceInfo &tinfo)
	Ajoute var à la liste des dépendances au temps précédent avec les infos de trace tinfo.

void	removeDepend (const VariableRef &var)
	Supprime var de la liste des dépendances.

template<typename ClassType>
void	setComputeFunction (ClassType instance, void(ClassType::func)())
	Positionne la fonction de recalcule de la variable.

template<typename ClassType>
void	setComputeFunction (ClassType instance, void(ClassType::func)(), const TraceInfo &tinfo)
	Positionne la fonction de recalcule de la variable.

VariableRef *	previousReference ()
	Référence précédente (ou null) sur variable()

VariableRef *	nextReference ()
	Référence suivante (ou null) sur variable()

void	setPreviousReference (VariableRef *v)

void	setNextReference (VariableRef *v)

Fonctions membres publiques hérités de Arcane::ArrayView< T >
constexpr	ArrayView () noexcept
	Construit une vue vide.

	ArrayView (const ArrayView< T > &from)=default
	Constructeur de recopie depuis une autre vue.

constexpr	ArrayView (Integer asize, pointer ptr) noexcept
	Construit une vue sur une zone mémoire commencant par ptr et.

template<std::size_t N>
constexpr	ArrayView (std::array< T, N > &v)
	Construit une vue sur une zone mémoire commencant par ptr et contenant asize éléments.

ArrayView< T > &	operator= (const ArrayView< T > &from)=default
	Opérateur de recopie.

template<std::size_t N>
constexpr ArrayView< T > &	operator= (std::array< T, N > &from)

constexpr reference	operator[] (Integer i)
	i-ème élément du tableau.

constexpr const_reference	operator[] (Integer i) const
	i-ème élément du tableau.

constexpr reference	operator() (Integer i)
	i-ème élément du tableau.

constexpr const_reference	operator() (Integer i) const
	i-ème élément du tableau.

constexpr const_reference	item (Integer i) const
	i-ème élément du tableau.

constexpr void	setItem (Integer i, const_reference v)
	Positionne le i-ème élément du tableau.

constexpr Integer	size () const noexcept
	Retourne la taille du tableau.

constexpr Integer	length () const noexcept
	Nombre d'éléments du tableau.

constexpr iterator	begin () noexcept
	Itérateur sur le premier élément du tableau.

constexpr iterator	end () noexcept
	Itérateur sur le premier élément après la fin du tableau.

constexpr const_iterator	begin () const noexcept
	Itérateur constant sur le premier élément du tableau.

constexpr const_iterator	end () const noexcept
	Itérateur constant sur le premier élément après la fin du tableau.

constexpr reverse_iterator	rbegin () noexcept
	Itérateur inverse sur le premier élément du tableau.

constexpr const_reverse_iterator	rbegin () const noexcept
	Itérateur inverse sur le premier élément du tableau.

constexpr reverse_iterator	rend () noexcept
	Itérateur inverse sur le premier élément après la fin du tableau.

constexpr const_reverse_iterator	rend () const noexcept
	Itérateur inverse sur le premier élément après la fin du tableau.

ArrayRange< pointer >	range ()
	Intervalle d'itération du premier au dernièr élément.

ArrayRange< const_pointer >	range () const
	Intervalle d'itération du premier au dernièr élément.

constexpr pointer	ptrAt (Integer index)
	Addresse du index-ème élément.

constexpr const_pointer	ptrAt (Integer index) const
	Addresse du index-ème élément.

constexpr const_reference	at (Integer i) const

void	setAt (Integer i, const_reference value)

void	fill (const T &o) noexcept
	Remplit le tableau avec la valeur o.

constexpr ConstArrayView< T >	constView () const noexcept
	Vue constante sur cette vue.

constexpr ArrayView< T >	subView (Integer abegin, Integer asize) noexcept
	Sous-vue à partir de l'élément abegin et contenant asize éléments.

constexpr ThatClass	subPart (Integer abegin, Integer asize) noexcept
	Sous-vue à partir de l'élément abegin et contenant asize éléments.

constexpr ConstArrayView< T >	subConstView (Integer abegin, Integer asize) const noexcept
	Sous-vue constante à partir de l'élément `abegin` et contenant `asize` éléments.

constexpr ArrayView< T >	subViewInterval (Integer index, Integer nb_interval)
	Sous-vue correspondant à l'interval index sur nb_interval.

constexpr ThatClass	subPartInterval (Integer index, Integer nb_interval)
	Sous-vue correspondant à l'interval index sur nb_interval.

template<class U>
void	copy (const U &copy_array)
	Recopie le tableau copy_array dans l'instance.

constexpr bool	empty () const noexcept
	Retourne true si le tableau est vide (dimension nulle)

bool	contains (const_reference v) const
	true si le tableau contient l'élément de valeur v

void	setArray (const ArrayView< T > &v) noexcept

constexpr pointer	unguardedBasePointer () noexcept
	Pointeur sur le début de la vue.

constexpr const_pointer	unguardedBasePointer () const noexcept
	Pointeur constant sur le début de la vue.

constexpr const_pointer	data () const noexcept
	Pointeur sur le début de la vue.

constexpr pointer	data () noexcept
	Pointeur constant sur le début de la vue.

Fonctions membres publiques statiques
static VariableTypeInfo	_internalVariableTypeInfo ()

static VariableInfo	_internalVariableInfo (const VariableBuildInfo &vbi)

static void	setTraceCreation (bool v)

static bool	hasTraceCreation ()

Fonctions membres publiques statiques hérités de Arcane::ArrayView< T >
static constexpr ThatClass	create (pointer ptr, Integer asize) noexcept
	Construit une vue sur une zone mémoire commencant par ptr et.

Membres hérités additionnels
Fonctions membres protégées hérités de Arcane::VariableRef
	VariableRef (const VariableBuildInfo &vbi)
	Construit une référence sur une variable avec les infos vbi.

	VariableRef (const VariableRef &from)
	Constructeur de copie.

	VariableRef (IVariable *var)
	Construit une référence sur une variable var.

VariableRef &	operator= (const VariableRef &from)
	Opérateur de recopie.

	VariableRef ()
	Constructeur vide.

void	_setComputeFunction (IVariableComputeFunction *v)

void	_internalInit (IVariable *)
	Initialisation interne de la variable.

IVariable *	_variable () const
	Variable référencée.

void	_executeUpdateFunctors ()

void	_internalAssignVariable (const VariableRef &var)

Fonctions membres protégées hérités de Arcane::ArrayView< T >
constexpr pointer	_ptr () noexcept
	Retourne un pointeur sur le tableau.

constexpr const_pointer	_ptr () const noexcept
	Retourne un pointeur sur le tableau.

void	_setArray (pointer v, Integer s) noexcept
	Modifie le pointeur et la taille du tableau.

void	_setPtr (pointer v) noexcept
	Modifie le pointeur du début du tableau.

void	_setSize (Integer s) noexcept
	Modifie la taille du tableau.

bool	m_has_trace = false

Description détaillée

template<typename T>
class Arcane::VariableRefArrayT< T >

Variable tableau.

Définition à la ligne 36 du fichier VariableRefArray.h.

Documentation des définitions de type membres

◆ ArrayBase

template<typename T>

typedef ArrayView<DataType> Arcane::VariableRefArrayT< T >::ArrayBase

Type du tableau permettant d'accéder à la variable.

Définition à la ligne 54 du fichier VariableRefArray.h.

◆ BaseClass

template<typename T>

typedef VariableRef Arcane::VariableRefArrayT< T >::BaseClass

Type de la classe de base.

Définition à la ligne 50 du fichier VariableRefArray.h.

◆ ConstReturnReferenceType

template<typename T>

typedef ArrayView<T>::const_reference Arcane::VariableRefArrayT< T >::ConstReturnReferenceType

Définition à la ligne 44 du fichier VariableRefArray.h.

◆ ContainerType

template<typename T>

typedef Array<DataType> Arcane::VariableRefArrayT< T >::ContainerType

Type de la classe gérant la valeur de la variable.

Définition à la ligne 52 du fichier VariableRefArray.h.

◆ DataType

template<typename T>

typedef T Arcane::VariableRefArrayT< T >::DataType

Définition à la ligne 42 du fichier VariableRefArray.h.

◆ ElementType

template<typename T>

typedef DataType Arcane::VariableRefArrayT< T >::ElementType

Type des éléments de la variable.

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

◆ LockType

template<typename T>

typedef VariableRefArrayLockT<DataType> Arcane::VariableRefArrayT< T >::LockType

Définition à la ligne 60 du fichier VariableRefArray.h.

◆ PrivatePartType

template<typename T>

typedef VariableArrayT<DataType> Arcane::VariableRefArrayT< T >::PrivatePartType

Définition à la ligne 56 du fichier VariableRefArray.h.

◆ ReturnReferenceType

template<typename T>

typedef ArrayView<T>::reference Arcane::VariableRefArrayT< T >::ReturnReferenceType

Définition à la ligne 45 du fichier VariableRefArray.h.

◆ ThatClass

template<typename T>

typedef VariableRefArrayT<DataType> Arcane::VariableRefArrayT< T >::ThatClass

Définition à la ligne 58 du fichier VariableRefArray.h.

◆ ValueType

template<typename T>

typedef Array<T> Arcane::VariableRefArrayT< T >::ValueType

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

Documentation des constructeurs et destructeur

◆ VariableRefArrayT() [1/3]

template<typename DataType>

Arcane::VariableRefArrayT< DataType >::VariableRefArrayT ( const VariableBuildInfo & vb )

explicit

Construit une référence à une variable tableau spécifiée dans vb.

Définition à la ligne 81 du fichier VariableRefArray.cc.

Référencé par refersTo(), et VariableRefArrayT().

◆ VariableRefArrayT() [2/3]

template<class DataType>

Arcane::VariableRefArrayT< DataType >::VariableRefArrayT ( const VariableRefArrayT< DataType > & rhs )

Construit une référence à partir de rhs.

Définition à la ligne 93 du fichier VariableRefArray.cc.

Références Arcane::ArrayView< T >::ArrayView(), updateFromInternal(), Arcane::VariableRef::VariableRef(), et VariableRefArrayT().

◆ VariableRefArrayT() [3/3]

template<class DataType>

Arcane::VariableRefArrayT< DataType >::VariableRefArrayT ( IVariable * var )

explicit

Construit une référence à partir de var.

Définition à la ligne 106 du fichier VariableRefArray.cc.

Références Arcane::VariableRef::VariableRef().

◆ ~VariableRefArrayT()

template<typename DataType>

Arcane::VariableRefArrayT< DataType >::~VariableRefArrayT ( )

override

Libère les ressources.

Libère la mémoire allouée.

Définition à la ligne 132 du fichier VariableRefArray.cc.

Documentation des fonctions membres

◆ _internalTrueData()

template<typename T>

IArrayDataInternalT< T > * Arcane::VariableRefArrayT< T >::_internalTrueData ( )

Définition à la ligne 194 du fichier VariableRefArray.cc.

◆ _internalVariableInfo()

template<typename DataType>

VariableInfo Arcane::VariableRefArrayT< DataType >::_internalVariableInfo ( const VariableBuildInfo & vbi )

static

Définition à la ligne 58 du fichier VariableRefArray.cc.

◆ _internalVariableTypeInfo()

template<typename DataType>

VariableTypeInfo Arcane::VariableRefArrayT< DataType >::_internalVariableTypeInfo ( )

static

Définition à la ligne 47 du fichier VariableRefArray.cc.

◆ arraySize()

template<typename T>

Integer Arcane::VariableRefArrayT< T >::arraySize ( ) const

inlineoverridevirtual

Si la variable est un tableau, retourne sa dimension, sinon retourne 0.

Réimplémentée à partir de Arcane::VariableRef.

Définition à la ligne 87 du fichier VariableRefArray.h.

◆ asArray() [1/2]

template<typename T>

ArrayView< DataType > Arcane::VariableRefArrayT< T >::asArray ( )

inline

Définition à la ligne 92 du fichier VariableRefArray.h.

◆ asArray() [2/2]

template<typename T>

ConstArrayView< DataType > Arcane::VariableRefArrayT< T >::asArray ( ) const

inline

Définition à la ligne 93 du fichier VariableRefArray.h.

◆ internalContainer()

template<typename T>

VariableRefArrayT< T >::ContainerType & Arcane::VariableRefArrayT< T >::internalContainer ( )

Retourne le conteneur des valeurs de cette variable.

L'appel à cette méthode n'est possible que pour les variables privées (propriété PPrivate). Pour les autres, une exception est levée (il faut utiliser lock()).

Définition à la ligne 184 du fichier VariableRefArray.cc.

◆ isArrayVariable()

template<typename T>

virtual bool Arcane::VariableRefArrayT< T >::isArrayVariable ( ) const

inlinevirtual

Définition à la ligne 86 du fichier VariableRefArray.h.

◆ lock()

template<typename DataType>

VariableRefArrayT< DataType >::LockType Arcane::VariableRefArrayT< DataType >::lock ( )

Définition à la ligne 173 du fichier VariableRefArray.cc.

◆ refersTo()

template<class DataType>

void Arcane::VariableRefArrayT< DataType >::refersTo ( const VariableRefArrayT< DataType > & rhs )

Positionne la référence de l'instance à la variable rhs.

Définition à la ligne 118 du fichier VariableRefArray.cc.

Références Arcane::VariableRef::operator=(), updateFromInternal(), et VariableRefArrayT().

◆ resize()

template<typename DataType>

void Arcane::VariableRefArrayT< DataType >::resize ( Integer new_size )

virtual

Redimensionne le tableau pour contenir new_size éléments.

Définition à la ligne 141 du fichier VariableRefArray.cc.

◆ resizeWithReserve()

template<typename DataType>

void Arcane::VariableRefArrayT< DataType >::resizeWithReserve	(	Integer	new_size,
		Integer	nb_additional )

virtual

Redimensionne le tableau pour contenir new_size éléments.

Définition à la ligne 151 du fichier VariableRefArray.cc.

◆ updateFromInternal()

template<typename DataType>

void Arcane::VariableRefArrayT< DataType >::updateFromInternal ( )

overridevirtual

Mise à jour à partir de la partie interne.

Réimplémentée à partir de Arcane::VariableRef.

Définition à la ligne 161 du fichier VariableRefArray.cc.

Références Arcane::VariableRef::updateFromInternal().

Référencé par refersTo(), et VariableRefArrayT().

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

Types publics

Fonctions membres publiques

Fonctions membres publiques statiques

Membres hérités additionnels

Description détaillée

Documentation des définitions de type membres

◆ ArrayBase

◆ BaseClass

◆ ConstReturnReferenceType

◆ ContainerType

◆ DataType

◆ ElementType

◆ LockType

◆ PrivatePartType

◆ ReturnReferenceType

◆ ThatClass

◆ ValueType

Documentation des constructeurs et destructeur

◆ VariableRefArrayT() [1/3]

◆ VariableRefArrayT() [2/3]

◆ VariableRefArrayT() [3/3]

◆ ~VariableRefArrayT()

Documentation des fonctions membres

◆ _internalTrueData()

◆ _internalVariableInfo()

◆ _internalVariableTypeInfo()

◆ arraySize()

◆ asArray() [1/2]

◆ asArray() [2/2]

◆ internalContainer()

◆ isArrayVariable()

◆ lock()

◆ refersTo()

◆ resize()

◆ resizeWithReserve()

◆ updateFromInternal()