Interface du gestionnaire de variables. Plus de détails...

#include <arcane/core/IVariableMng.h>

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

Graphe de collaboration de Arcane::IVariableMng:

Fonctions membres publiques
virtual	~IVariableMng ()=default
	Libère les ressources.

virtual ISubDomain *	subDomain ()=0
	Gestionnaire du sous-domaine.

virtual IParallelMng *	parallelMng () const =0
	Gestionnaire de parallélisme associé

virtual ITraceMng *	traceMng ()=0
	Gestionnaire de messages.

virtual IVariable *	checkVariable (const VariableInfo &infos)=0
	Vérifie une variable.

virtual String	generateTemporaryVariableName ()=0
	Génère un nom pour une variable temporaire.

virtual void	dumpList (std::ostream &, IModule *)=0
	Affiche la liste des variables du gestionnaire lié à un module.

virtual void	dumpList (std::ostream &)=0
	Affiche la liste de toutes les variables du gestionnaire.

virtual Real	exportSize (const VariableCollection &vars)=0
	Taille estimé pour exporter des variables.

virtual IObservable *	writeObservable ()=0
	Observable pour les variables en écriture.

virtual IObservable *	readObservable ()=0
	Observable pour les variables en lecture.

virtual void	writeVariables (IDataWriter writer, IVariableFilter filter=0)=0
	Ecrit les variables.

virtual void	writeVariables (IDataWriter *writer, const VariableCollection &vars)=0
	Exporte les variables.

virtual void	writeCheckpoint (ICheckpointWriter *writer)=0
	Ecrit les variables pour une protection.

virtual void	writePostProcessing (IPostProcessorWriter *writer)=0
	Ecrit les variables pour un post-traitement.

virtual void	readVariables (IDataReader reader, IVariableFilter filter=0)=0
	Relit toutes les variables.

virtual void	readCheckpoint (ICheckpointReader *reader)=0
	Relit toutes les variables d'une protection.

virtual void	readCheckpoint (const CheckpointReadInfo &infos)=0
	Relit toutes les variables d'une protection.

virtual void	variables (VariableRefCollection v, IModule *i)=0
	Donne l'ensemble des variables du module i.

virtual VariableCollection	variables ()=0
	Liste des variables.

virtual VariableCollection	usedVariables ()=0
	Liste des variables utilisées.

virtual void	notifyUsedVariableChanged ()=0
	Notifie au gestionnaire que l'état d'une variable a changé

virtual IVariable *	findVariable (const String &name)=0
	Retourne la variable de nom name ou 0 si aucune de se nom existe.

virtual IVariable *	findMeshVariable (IMesh *mesh, const String &name)=0
	Retourne la variable du maillage de nom name ou 0 si aucune de se nom existe.

virtual IVariable *	findVariableFullyQualified (const String &name)=0
	Retourne la variable de nom complet name ou 0 si aucune de se nom existe.

virtual void	dumpStats (std::ostream &ostr, bool is_verbose)=0
	Ecrit les statistiques sur les variables sur le flot ostr.

virtual void	dumpStatsJSON (JSONWriter &writer)=0
	Ecrit les statistiques avec l'écrivain writer.

virtual IVariableUtilities *	utilities () const =0
	Interface des fonctions utilitaires associées.

virtual IVariableSynchronizerMng *	synchronizerMng () const =0
	Interface du gestionnaire de synchronisation des variables.

Evènements
virtual EventObservable< const VariableStatusChangedEventArgs & > &	onVariableAdded ()=0
	Evènement envoyé lorsqu'une variable est créée.

virtual EventObservable< const VariableStatusChangedEventArgs & > &	onVariableRemoved ()=0
	Evènement envoyé lorsqu'une variable est détruite.

virtual void	build ()=0
	Construit les membres de l'instance.

virtual void	initialize ()=0
	Initialise l'instance. L'instance n'est pas utilisable tant que cette méthode n'a pas été appelée.

virtual void	removeAllVariables ()=0
	Supprime et détruit les variables gérées par ce gestionnaire.

virtual void	detachMeshVariables (IMesh *mesh)=0
	Détache les variables associées au maillage mesh.

virtual void	addVariableRef (VariableRef *var)=0
	Ajoute une référence à une variable.

virtual void	removeVariableRef (VariableRef *var)=0
	Supprime une référence à une variable.

virtual void	addVariable (IVariable *var)=0
	Ajoute une variable.

virtual void	removeVariable (IVariable *var)=0
	Supprime une variable.

virtual void	initializeVariables (bool is_continue)=0
	Initialise les variables.

virtual ISubDomain *	_internalSubDomain () const =0

virtual IVariableMngInternal *	_internalApi ()=0
	API interne à Arcane.

Description détaillée

Interface du gestionnaire de variables.

Ce gestionnaire contient la liste des variables déclarées dans le sous-domaine associé subDomain(). Il maintient la liste des variables et permet de les lire ou de les écrire.

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

Documentation des fonctions membres

◆ _internalApi()

virtual IVariableMngInternal * Arcane::IVariableMng::_internalApi ( )

pure virtual

API interne à Arcane.

Implémenté dans Arcane::VariableMng.

◆ _internalSubDomain()

virtual ISubDomain * Arcane::IVariableMng::_internalSubDomain ( ) const

pure virtual

Fonction interne temporaire pour récupérer le sous-domaine.

Implémenté dans Arcane::VariableMng.

◆ addVariable()

virtual void Arcane::IVariableMng::addVariable ( IVariable * var )

pure virtual

Ajoute une variable.

Ajoute la variable var.

La validité de la variable n'est pas effectuée (void checkVariable()).

Précondition: var != 0; var ne doit pas déjà être référencée.

Renvoie: l'implémentation associée à var.

Implémenté dans Arcane::VariableMng.

◆ addVariableRef()

virtual void Arcane::IVariableMng::addVariableRef ( VariableRef * var )

pure virtual

Ajoute une référence à une variable.

Ajoute la référence var au gestionnaire.

Précondition: var != 0; var ne doit pas déjà être référencée.

Renvoie: l'implémentation associée à var.

Implémenté dans Arcane::VariableMng.

◆ build()

virtual void Arcane::IVariableMng::build ( )

pure virtual

Construit les membres de l'instance.

L'instance n'est pas utilisable tant que cette méthode n'a pas été appelée. Cette méthode doit être appelée avant initialize().

Avertissement: Cette méthode ne doit être appelée qu'une seule fois.

Implémenté dans Arcane::VariableMng.

◆ checkVariable()

virtual IVariable * Arcane::IVariableMng::checkVariable ( const VariableInfo & infos )

pure virtual

Vérifie une variable.

Vérifie que la variable de nom name caractérisée par infos est valide C'est le cas si et seulement si:

aucune variable de nom infos.name() n'existe déjà.
une variable de nom infos.name() existe et son type et son genre correspondent infos.

Si la variable n'est pas valide, une exception est lancée.

Cette opération est utilisée lorsqu'on souhaite créer une nouvelle référence à une variable et permet de s'assurer qu'elle sera valide.

Exceptions

ExBadVariableKindType si la variable de nom infos.name() existe et que son type et le genre ne correspondent pas à ceux de infos.

Renvoie: la variable de infos.name() si elle existe, 0 sinon

Implémenté dans Arcane::VariableMng.

◆ detachMeshVariables()

virtual void Arcane::IVariableMng::detachMeshVariables ( IMesh * mesh )

pure virtual

Détache les variables associées au maillage mesh.

Implémenté dans Arcane::VariableMng.

◆ dumpList() [1/2]

virtual void Arcane::IVariableMng::dumpList ( std::ostream & )

pure virtual

Affiche la liste de toutes les variables du gestionnaire.

Implémenté dans Arcane::VariableMng.

◆ dumpList() [2/2]

virtual void Arcane::IVariableMng::dumpList	(	std::ostream &	,
		IModule *
	)

pure virtual

Affiche la liste des variables du gestionnaire lié à un module.

Implémenté dans Arcane::VariableMng.

◆ dumpStats()

virtual void Arcane::IVariableMng::dumpStats	(	std::ostream &	ostr,
		bool	is_verbose
	)

pure virtual

Ecrit les statistiques sur les variables sur le flot ostr.

Implémenté dans Arcane::VariableMng.

◆ dumpStatsJSON()

virtual void Arcane::IVariableMng::dumpStatsJSON ( JSONWriter & writer )

pure virtual

Ecrit les statistiques avec l'écrivain writer.

Implémenté dans Arcane::VariableMng.

◆ exportSize()

virtual Real Arcane::IVariableMng::exportSize ( const VariableCollection & vars )

pure virtual

Taille estimé pour exporter des variables.

Cette opération estime le nombre de méga octets que va générer l'exportation des variables vars. Si vars est vide, l'estimation porte sur toutes les variables référencées.

L'estimation tient compte uniquement de la quantité mémoire utilisée par les variables et pas de l'écrivain utilisé.

L'estimation est locale au sous-domaine. Pour obtenir la taille totale d'une exportation, il faut effectuer déterminer la taille par sous-domaine et faire la somme.

Cette méthode est collective

A faire:: utiliser des entiers 8 octets voir plus...

Implémenté dans Arcane::VariableMng.

◆ findMeshVariable()

virtual IVariable * Arcane::IVariableMng::findMeshVariable	(	IMesh *	mesh,
		const String &	name
	)

pure virtual

Retourne la variable du maillage de nom name ou 0 si aucune de se nom existe.

Implémenté dans Arcane::VariableMng.

Référencé par Arcane::TimeHistoryMngInternal::_fromLegacyFormat().

◆ findVariable()

virtual IVariable * Arcane::IVariableMng::findVariable ( const String & name )

pure virtual

Retourne la variable de nom name ou 0 si aucune de se nom existe.

Implémenté dans Arcane::VariableMng.

◆ findVariableFullyQualified()

virtual IVariable * Arcane::IVariableMng::findVariableFullyQualified ( const String & name )

pure virtual

Retourne la variable de nom complet name ou 0 si aucune de se nom existe.

Implémenté dans Arcane::VariableMng.

◆ generateTemporaryVariableName()

virtual String Arcane::IVariableMng::generateTemporaryVariableName ( )

pure virtual

Génère un nom pour une variable temporaire.

Pour assurer la cohérence de ce nom, il faut que tous les sous-domaines appellent cette fonction.

Implémenté dans Arcane::VariableMng.

◆ initialize()

virtual void Arcane::IVariableMng::initialize ( )

pure virtual

Initialise l'instance. L'instance n'est pas utilisable tant que cette méthode n'a pas été appelée.

Avertissement: Cette méthode ne doit être appelée qu'une seule fois.

Implémenté dans Arcane::VariableMng.

◆ initializeVariables()

virtual void Arcane::IVariableMng::initializeVariables ( bool is_continue )

pure virtual

Initialise les variables.

Parcours la liste des variables et les initialisent. Seules les variables d'un module utilisé sont initialisées.

Paramètres

is_continue true vrai si on est en reprise.

Implémenté dans Arcane::VariableMng.

◆ notifyUsedVariableChanged()

virtual void Arcane::IVariableMng::notifyUsedVariableChanged ( )

pure virtual

Notifie au gestionnaire que l'état d'une variable a changé

Implémenté dans Arcane::VariableMng.

◆ onVariableAdded()

virtual EventObservable< const VariableStatusChangedEventArgs & > & Arcane::IVariableMng::onVariableAdded ( )

pure virtual

Evènement envoyé lorsqu'une variable est créée.

Implémenté dans Arcane::VariableMng.

◆ onVariableRemoved()

virtual EventObservable< const VariableStatusChangedEventArgs & > & Arcane::IVariableMng::onVariableRemoved ( )

pure virtual

Evènement envoyé lorsqu'une variable est détruite.

Implémenté dans Arcane::VariableMng.

◆ parallelMng()

virtual IParallelMng * Arcane::IVariableMng::parallelMng ( ) const

pure virtual

Gestionnaire de parallélisme associé

Implémenté dans Arcane::VariableMng.

◆ readCheckpoint() [1/2]

virtual void Arcane::IVariableMng::readCheckpoint ( const CheckpointReadInfo & infos )

pure virtual

Relit toutes les variables d'une protection.

Lit une protection avec les informations contenues dans infos.

Cette méthode est collective.

Cette méthode est interne à Arcane. En générel, la lecture d'une protection se fait via une instance de ICheckpointMng, accessible via ISubDomain::checkpointMng().

Implémenté dans Arcane::VariableMng.

◆ readCheckpoint() [2/2]

virtual void Arcane::IVariableMng::readCheckpoint ( ICheckpointReader * reader )

pure virtual

Relit toutes les variables d'une protection.

Lit une protection avec le service reader sur l'ensemble des variables.

Cette méthode est collective.

Cette méthode est interne à Arcane. En générel, la lecture d'une protection se fait via une instance de ICheckpointMng, accessible via ISubDomain::checkpointMng().

Implémenté dans Arcane::VariableMng.

◆ readObservable()

virtual IObservable * Arcane::IVariableMng::readObservable ( )

pure virtual

Observable pour les variables en lecture.

Les observateurs enregistrés dans cet observable sont appelés après avoir lu les variables (opération readVariables() ou readCheckpoint()).

Implémenté dans Arcane::VariableMng.

◆ readVariables()

virtual void Arcane::IVariableMng::readVariables	(	IDataReader *	reader,
		IVariableFilter *	filter = `0`
	)

pure virtual

Relit toutes les variables.

Parcours l'ensemble des variables du gestionnaire et leur applique le lecteur reader. Si filter est non nul, il est appliqué à chaque variable et une variable n'est lue que si le filtre est vrai pour cette variable. Les variables qui ne sont pas lues ne sont pas modifiées par cette opération.

Obsolète:: Utiliser readVariable(IDataReader*)

Cette méthode est collective.

Implémenté dans Arcane::VariableMng.

◆ removeAllVariables()

virtual void Arcane::IVariableMng::removeAllVariables ( )

pure virtual

Supprime et détruit les variables gérées par ce gestionnaire.

Implémenté dans Arcane::VariableMng.

◆ removeVariable()

virtual void Arcane::IVariableMng::removeVariable ( IVariable * var )

pure virtual

Supprime une variable.

Supprime la variable var.

Après appel à cette méthode, la variable ne doit plus être utilisée.

Précondition: var != 0; var doit avoir une seule référence.

Implémenté dans Arcane::VariableMng.

◆ removeVariableRef()

virtual void Arcane::IVariableMng::removeVariableRef ( VariableRef * var )

pure virtual

Supprime une référence à une variable.

Supprime la référence var du gestionnaire.

Si var n'est pas référencée par le gestionnaire, rien n'est effectué.

Précondition: var != 0

Implémenté dans Arcane::VariableMng.

◆ subDomain()

virtual ISubDomain * Arcane::IVariableMng::subDomain ( )

pure virtual

Gestionnaire du sous-domaine.

Implémenté dans Arcane::VariableMng.

◆ synchronizerMng()

virtual IVariableSynchronizerMng * Arcane::IVariableMng::synchronizerMng ( ) const

pure virtual

Interface du gestionnaire de synchronisation des variables.

Implémenté dans Arcane::VariableMng.

◆ traceMng()

virtual ITraceMng * Arcane::IVariableMng::traceMng ( )

pure virtual

Gestionnaire de messages.

Implémenté dans Arcane::VariableMng.

◆ usedVariables()

virtual VariableCollection Arcane::IVariableMng::usedVariables ( )

pure virtual

Liste des variables utilisées.

Implémenté dans Arcane::VariableMng.

◆ utilities()

virtual IVariableUtilities * Arcane::IVariableMng::utilities ( ) const

pure virtual

Interface des fonctions utilitaires associées.

Implémenté dans Arcane::VariableMng.

◆ variables() [1/2]

virtual VariableCollection Arcane::IVariableMng::variables ( )

pure virtual

Liste des variables.

Implémenté dans Arcane::VariableMng.

◆ variables() [2/2]

virtual void Arcane::IVariableMng::variables	(	VariableRefCollection	v,
		IModule *	i
	)

pure virtual

Donne l'ensemble des variables du module i.

Implémenté dans Arcane::VariableMng.

Référencé par Arcane::SubDomain::dumpInternalInfos().

◆ writeCheckpoint()

virtual void Arcane::IVariableMng::writeCheckpoint ( ICheckpointWriter * writer )

pure virtual

Ecrit les variables pour une protection.

Utilise le service de protection writer pour écrire les variables.

Cette méthode est collective.

Cette méthode est interne à Arcane. En générel, l'écriture d'une protection se fait via une instance de ICheckpointMng, accessible via ISubDomain::checkpointMng().

Implémenté dans Arcane::VariableMng.

◆ writeObservable()

virtual IObservable * Arcane::IVariableMng::writeObservable ( )

pure virtual

Observable pour les variables en écriture.

Les observateurs enregistrés dans cet observable sont appelés avant d'écrire les variables (opération writeCheckpoint(), writeVariables() ou writePostProcessing()).

Implémenté dans Arcane::VariableMng.

Référencé par Arcane::TimeHistoryMngInternal::addObservers().

◆ writePostProcessing()

virtual void Arcane::IVariableMng::writePostProcessing ( IPostProcessorWriter * writer )

pure virtual

Ecrit les variables pour un post-traitement.

Utilise le service de post-traitement writer pour écrire les variables. L'appelant doit avoir positionner les champs de writer avant cet appel, notamment la liste des variables à post-traiter. Cette méthode appelle IPostProcessorWriter::notifyBeginWrite() avant l'écriture et IPostProcessorWriter::notifyEndWriter() en fin.

Cette méthode est collective.

Implémenté dans Arcane::VariableMng.

◆ writeVariables() [1/2]

virtual void Arcane::IVariableMng::writeVariables	(	IDataWriter *	writer,
		const VariableCollection &	vars
	)

pure virtual

Exporte les variables.

Exporte les variables de la liste vars. Si vars est vide, exporte toutes les variables de la base qui sont utilisées.

Implémenté dans Arcane::VariableMng.

◆ writeVariables() [2/2]

virtual void Arcane::IVariableMng::writeVariables	(	IDataWriter *	writer,
		IVariableFilter *	filter = `0`
	)

pure virtual

Ecrit les variables.

Parcours l'ensemble des variables du gestionnaire et leur applique l'écrivain writer. Si filter est non nul, il est appliqué à chaque variable et une variable n'est écrite que si le filtre est vrai pour cette variable.

Cette méthode est collective

Implémenté dans Arcane::VariableMng.

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

IVariableMng.h

Fonctions membres publiques

Description détaillée

Documentation des fonctions membres

◆ _internalApi()

◆ _internalSubDomain()

◆ addVariable()

◆ addVariableRef()

◆ build()

◆ checkVariable()

◆ detachMeshVariables()

◆ dumpList() [1/2]

◆ dumpList() [2/2]

◆ dumpStats()

◆ dumpStatsJSON()

◆ exportSize()

◆ findMeshVariable()

◆ findVariable()

◆ findVariableFullyQualified()

◆ generateTemporaryVariableName()

◆ initialize()

◆ initializeVariables()

◆ notifyUsedVariableChanged()

◆ onVariableAdded()

◆ onVariableRemoved()

◆ parallelMng()

◆ readCheckpoint() [1/2]

◆ readCheckpoint() [2/2]

◆ readObservable()

◆ readVariables()

◆ removeAllVariables()

◆ removeVariable()

◆ removeVariableRef()

◆ subDomain()

◆ synchronizerMng()

◆ traceMng()

◆ usedVariables()

◆ utilities()

◆ variables() [1/2]

◆ variables() [2/2]

◆ writeCheckpoint()

◆ writeObservable()

◆ writePostProcessing()

◆ writeVariables() [1/2]

◆ writeVariables() [2/2]