Référence de la classe Arcane::ITimeHistoryMng

Classe gérant un historique de valeurs. Plus de détails...

#include <arcane/core/ITimeHistoryMng.h>

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

Graphe de collaboration de Arcane::ITimeHistoryMng:

Fonctions membres publiques
virtual	~ITimeHistoryMng ()=default
	Libère les ressources.
virtual void	addValue (const String &name, Real value, bool end_time=true, bool is_local=false)=0
	Ajoute la valeur value à l'historique name.
virtual void	addValue (const String &name, Int32 value, bool end_time=true, bool is_local=false)=0
	Ajoute la valeur value à l'historique name.
virtual void	addValue (const String &name, Int64 value, bool end_time=true, bool is_local=false)=0
virtual void	addValue (const String &name, RealConstArrayView value, bool end_time=true, bool is_local=false)=0
	Ajoute la valeur value à l'historique name.
virtual void	addValue (const String &name, Int32ConstArrayView value, bool end_time=true, bool is_local=false)=0
	Ajoute la valeur value à l'historique name.
virtual void	addValue (const String &name, Int64ConstArrayView value, bool end_time=true, bool is_local=false)=0
virtual void	timeHistoryBegin ()=0
virtual void	timeHistoryEnd ()=0
virtual void	timeHistoryInit ()=0
virtual void	timeHistoryStartInit ()=0
virtual void	timeHistoryContinueInit ()=0
virtual void	timeHistoryRestore ()=0
virtual ARCANE_DEPRECATED void	addCurveWriter (ITimeHistoryCurveWriter *writer)
	Ajoute un écrivain.
virtual ARCANE_DEPRECATED void	removeCurveWriter (ITimeHistoryCurveWriter *writer)
	Supprime un écrivain.
virtual void	addCurveWriter (ITimeHistoryCurveWriter2 *writer)=0
	Ajoute un écrivain.
virtual void	removeCurveWriter (ITimeHistoryCurveWriter2 *writer)=0
	Supprime un écrivain.
virtual void	removeCurveWriter (const String &name)=0
	Supprime l'écrivain de nom name.
virtual void	dumpHistory (bool is_verbose)=0
	Sauve l'historique.
virtual void	dumpCurves (ITimeHistoryCurveWriter2 *writer)=0
	Utilise l'écrivain writer pour sortir toutes les courbes.
virtual bool	active () const =0
	Indique l'état d'activation.
virtual void	setActive (bool is_active)=0
	Positionne l'état d'activation.
virtual void	applyTransformation (ITimeHistoryTransformer *v)=0
	Applique la transformation v à l'ensemble des courbes.
virtual bool	isDumpActive () const =0
	Indique l'état d'activation des sorties.
virtual void	setDumpActive (bool is_active)=0
	Positionne l'état d'activation des sorties.
virtual bool	isShrinkActive () const =0
	Retourne un booléen indiquant si l'historique est compressé
virtual void	setShrinkActive (bool is_active)=0
	Positionne le booléen indiquant si l'historique est compressé
virtual ITimeHistoryMngInternal *	_internalApi ()
	API interne à Arcane.

Description détaillée

Classe gérant un historique de valeurs.

Le gestionnaire d'historique gère l'historique d'un ensemble de valeur au cours du temps.

L'historique est basée par itération (VariablesCommon::globalIteration()). Pour chaque itération, il est possible de sauver une valeur par l'intermédiaire des méthodes addValue(). Il n'est pas obligatoire d'avoir une valeur pour chaque itération. Lorsqu'on effectue plusieurs addValue() pour le même historique à la même itération, seule la dernière valeur est prise en compte.

Chaque historique est associée à un nom qui est le nom du fichier dans lequel la liste des valeurs sera sauvegardée.

Seul l'instance associée au sous-domaine tel que parallelMng()->isMasterIO() est vrai enregistre les valeurs. Pour les autres, les appels à addValue() sont sans effet.

Les valeurs ne sont sauvées que si active() est vrai. Il est possible de modifier l'état d'activation en appelant isActive().

En mode debug, l'ensemble des historiques est sauvé à chaque pas de temps. En exécution normale, cet ensemble est sauvé toute les n itérations, n étant donné par l'option du jeu de donné <module-main/time-history-iteration-step>. Dans tous les cas, une sortie est effectuée à la fin de l'exécution.

Le format de ces fichiers dépend de l'implémentation.

Depuis

0.4.38

Définition à la ligne 132 du fichier ITimeHistoryMng.h.

Documentation des fonctions membres

_internalApi()

virtual ITimeHistoryMngInternal * Arcane::ITimeHistoryMng::_internalApi ( )

inlinevirtual

API interne à Arcane.

Réimplémentée dans Arcane::TimeHistoryMng2.

Définition à la ligne 302 du fichier ITimeHistoryMng.h.

Références ARCANE_FATAL.

Référencé par Arcane::GlobalTimeHistoryAdder::addValue(), Arcane::MeshTimeHistoryAdder::addValue(), Arcane::GlobalTimeHistoryAdder::addValue(), Arcane::MeshTimeHistoryAdder::addValue(), Arcane::GlobalTimeHistoryAdder::addValue(), Arcane::MeshTimeHistoryAdder::addValue(), Arcane::GlobalTimeHistoryAdder::addValue(), Arcane::MeshTimeHistoryAdder::addValue(), Arcane::GlobalTimeHistoryAdder::addValue(), Arcane::MeshTimeHistoryAdder::addValue(), Arcane::GlobalTimeHistoryAdder::addValue(), Arcane::MeshTimeHistoryAdder::addValue(), Arcane::GlobalTimeHistoryAdder::GlobalTimeHistoryAdder(), et Arcane::MeshTimeHistoryAdder::MeshTimeHistoryAdder().

active()

virtual bool Arcane::ITimeHistoryMng::active ( ) const

pure virtual

Indique l'état d'activation.

Les fonctions addValue() ne sont prises en compte que si l'instance est active. Dans le cas contraire, les appels à addValue() sont ignorés.

Implémenté dans Arcane::TimeHistoryMng2.

addCurveWriter() [1/2]

virtual ARCANE_DEPRECATED void Arcane::ITimeHistoryMng::addCurveWriter ( ITimeHistoryCurveWriter *  writer )

inlinevirtual

Ajoute un écrivain.

Définition à la ligne 217 du fichier ITimeHistoryMng.h.

Références ARCANE_FATAL.

addCurveWriter() [2/2]

virtual void Arcane::ITimeHistoryMng::addCurveWriter ( ITimeHistoryCurveWriter2 *  writer )

pure virtual

Ajoute un écrivain.

Implémenté dans Arcane::TimeHistoryMng2.

addValue() [1/6]

virtual void Arcane::ITimeHistoryMng::addValue ( const String &  name, Int32  value, bool  end_time = true, bool  is_local = false  )

pure virtual

Ajoute la valeur value à l'historique name.

Obsolète:

Cette méthode est dépréciée et est remplacée par l'utilisation de l'objet GlobalTimeHistoryAdder.

La valeur est celle au temps de fin de l'itération si end_time est vrai, au début sinon. le booleen is_local indique si la courbe est propre au process ou pas pour pouvoir écrire des courbes meme par des procs non io_master quand la varariable ARCANE_ENABLE_NON_IO_MASTER_CURVES

Implémenté dans Arcane::TimeHistoryMng2.

addValue() [2/6]

virtual void Arcane::ITimeHistoryMng::addValue ( const String &  name, Int32ConstArrayView  value, bool  end_time = true, bool  is_local = false  )

pure virtual

Ajoute la valeur value à l'historique name.

Obsolète:

Cette méthode est dépréciée et est remplacée par l'utilisation de l'objet GlobalTimeHistoryAdder.

Le nombre d'éléments de value doit être constant au cours du temps. La valeur est celle au temps de fin de l'itération si end_time est vrai, au début sinon. le booleen is_local indique si la courbe est propre au process ou pas pour pouvoir écrire des courbes meme par des procs non io_master quand la varariable ARCANE_ENABLE_NON_IO_MASTER_CURVES

Implémenté dans Arcane::TimeHistoryMng2.

addValue() [3/6]

virtual void Arcane::ITimeHistoryMng::addValue ( const String &  name, Int64  value, bool  end_time = true, bool  is_local = false  )

pure virtual

Ajoute la valeur value à l'historique name.

Obsolète:

Cette méthode est dépréciée et est remplacée par l'utilisation de l'objet GlobalTimeHistoryAdder.

La valeur est celle au temps de fin de l'itération si end_time est vrai, au début sinon. le booleen is_local indique si la courbe est propre au process ou pas pour pouvoir écrire des courbes meme par des procs non io_master quand la varariable ARCANE_ENABLE_NON_IO_MASTER_CURVES

Implémenté dans Arcane::TimeHistoryMng2.

addValue() [4/6]

virtual void Arcane::ITimeHistoryMng::addValue ( const String &  name, Int64ConstArrayView  value, bool  end_time = true, bool  is_local = false  )

pure virtual

Ajoute la valeur value à l'historique name.

Obsolète:

Cette méthode est dépréciée et est remplacée par l'utilisation de l'objet GlobalTimeHistoryAdder.

Le nombre d'éléments de value doit être constant au cours du temps. La valeur est celle au temps de fin de l'itération si end_time est vrai, au début sinon. le booleen is_local indique si la courbe est propre au process ou pas pour pouvoir écrire des courbes meme par des procs non io_master quand la varariable ARCANE_ENABLE_NON_IO_MASTER_CURVES

Implémenté dans Arcane::TimeHistoryMng2.

addValue() [5/6]

virtual void Arcane::ITimeHistoryMng::addValue ( const String &  name, Real  value, bool  end_time = true, bool  is_local = false  )

pure virtual

Ajoute la valeur value à l'historique name.

Obsolète:

Cette méthode est dépréciée et est remplacée par l'utilisation de l'objet GlobalTimeHistoryAdder.

La valeur est celle au temps de fin de l'itération si end_time est vrai, au début sinon. le booleen is_local indique si la courbe est propre au process ou pas pour pouvoir écrire des courbes meme par des procs non io_master quand la varariable ARCANE_ENABLE_NON_IO_MASTER_CURVES

Implémenté dans Arcane::TimeHistoryMng2.

addValue() [6/6]

virtual void Arcane::ITimeHistoryMng::addValue ( const String &  name, RealConstArrayView  value, bool  end_time = true, bool  is_local = false  )

pure virtual

Ajoute la valeur value à l'historique name.

Obsolète:

Cette méthode est dépréciée et est remplacée par l'utilisation de l'objet GlobalTimeHistoryAdder.

Le nombre d'éléments de value doit être constant au cours du temps. La valeur est celle au temps de fin de l'itération si end_time est vrai, au début sinon. le booleen is_local indique si la courbe est propre au process ou pas pour pouvoir écrire des courbes meme par des procs non io_master quand la varariable ARCANE_ENABLE_NON_IO_MASTER_CURVES

Implémenté dans Arcane::TimeHistoryMng2.

applyTransformation()

virtual void Arcane::ITimeHistoryMng::applyTransformation ( ITimeHistoryTransformer *  v )

pure virtual

Applique la transformation v à l'ensemble des courbes.

Implémenté dans Arcane::TimeHistoryMng2.

dumpCurves()

virtual void Arcane::ITimeHistoryMng::dumpCurves ( ITimeHistoryCurveWriter2 *  writer )

pure virtual

Utilise l'écrivain writer pour sortir toutes les courbes.

Le chemin de sortie est le répertoire courant.

Implémenté dans Arcane::TimeHistoryMng2.

dumpHistory()

virtual void Arcane::ITimeHistoryMng::dumpHistory ( bool  is_verbose )

pure virtual

Sauve l'historique.

Cela consiste à appelé dumpCurves() pour chaque écrivain enregistré.

Implémenté dans Arcane::TimeHistoryMng2.

isDumpActive()

virtual bool Arcane::ITimeHistoryMng::isDumpActive ( ) const

pure virtual

Indique l'état d'activation des sorties.

La fonction dumpHistory() est inactives si isDumpActive() est faux.

Implémenté dans Arcane::TimeHistoryMng2.

isShrinkActive()

virtual bool Arcane::ITimeHistoryMng::isShrinkActive ( ) const

pure virtual

Retourne un booléen indiquant si l'historique est compressé

Implémenté dans Arcane::TimeHistoryMng2.

removeCurveWriter() [1/3]

virtual void Arcane::ITimeHistoryMng::removeCurveWriter ( const String &  name )

pure virtual

Supprime l'écrivain de nom name.

Implémenté dans Arcane::TimeHistoryMng2.

removeCurveWriter() [2/3]

virtual ARCANE_DEPRECATED void Arcane::ITimeHistoryMng::removeCurveWriter ( ITimeHistoryCurveWriter *  writer )

inlinevirtual

Supprime un écrivain.

Définition à la ligne 224 du fichier ITimeHistoryMng.h.

Références ARCANE_FATAL.

removeCurveWriter() [3/3]

virtual void Arcane::ITimeHistoryMng::removeCurveWriter ( ITimeHistoryCurveWriter2 *  writer )

pure virtual

Supprime un écrivain.

Implémenté dans Arcane::TimeHistoryMng2.

setActive()

virtual void Arcane::ITimeHistoryMng::setActive ( bool  is_active )

pure virtual

Positionne l'état d'activation.

Voir également

active().

Implémenté dans Arcane::TimeHistoryMng2.

setDumpActive()

virtual void Arcane::ITimeHistoryMng::setDumpActive ( bool  is_active )

pure virtual

Positionne l'état d'activation des sorties.

Implémenté dans Arcane::TimeHistoryMng2.

setShrinkActive()

virtual void Arcane::ITimeHistoryMng::setShrinkActive ( bool  is_active )

pure virtual

Positionne le booléen indiquant si l'historique est compressé

Implémenté dans Arcane::TimeHistoryMng2.

---

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

• ITimeHistoryMng.h