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

Interface de la partie interne d'un gestionnaire d'historique de valeur. Plus de détails...

#include <arcane/core/internal/ITimeHistoryMngInternal.h>

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

Graphe de collaboration de Arcane::ITimeHistoryMngInternal:

Fonctions membres publiques
virtual	~ITimeHistoryMngInternal ()=default
	Libère les ressources.
virtual void	addValue (const TimeHistoryAddValueArgInternal &thpi, Real value)=0
	Méthode permettant d'ajouter une valeur à un historique.
virtual void	addValue (const TimeHistoryAddValueArgInternal &thpi, Int32 value)=0
	Méthode permettant d'ajouter une valeur à un historique.
virtual void	addValue (const TimeHistoryAddValueArgInternal &thpi, Int64 value)=0
	Méthode permettant d'ajouter une valeur à un historique.
virtual void	addValue (const TimeHistoryAddValueArgInternal &thpi, RealConstArrayView values)=0
	Méthode permettant d'ajouter des valeurs à un historique.
virtual void	addValue (const TimeHistoryAddValueArgInternal &thpi, Int32ConstArrayView values)=0
	Méthode permettant d'ajouter des valeurs à un historique.
virtual void	addValue (const TimeHistoryAddValueArgInternal &thpi, Int64ConstArrayView values)=0
	Méthode permettant d'ajouter des valeurs à un historique.
virtual void	addNowInGlobalTime ()=0
	Méthode permettant d'ajouter le GlobalTime actuel au tableau des GlobalTimes.
virtual void	updateGlobalTimeCurve ()=0
	Méthode permettant de copier le tableau de GlobalTime dans la variable globale GlobalTime.
virtual void	resizeArrayAfterRestore ()=0
	Méthode permettant de redimensionner les tableaux de valeurs après une reprise.
virtual void	dumpCurves (ITimeHistoryCurveWriter2 *writer)=0
	Méthode permettant d"écrire les courbes à l'aide du writer fourni.
virtual void	dumpHistory ()=0
	Méthode permettant d'écrire toutes les courbes à l'aide de tous les writers enregistrés.
virtual void	updateMetaData ()=0
	Méthode permettant de mettre à jour les méta-données des courbes.
virtual void	readVariables (IMeshMng *mesh_mng, IMesh *default_mesh)=0
	Méthode permettant de récupérer les courbes précédemment écrites lors d'une reprise.
virtual void	addCurveWriter (Ref< ITimeHistoryCurveWriter2 > writer)=0
	Méthode permettant d'ajouter un écrivain pour la sortie des courbes.
virtual void	removeCurveWriter (const String &name)=0
	Méthode permettant de retirer un écrivain.
virtual void	applyTransformation (ITimeHistoryTransformer *v)=0
	Applique la transformation v à l'ensemble des courbes.
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 bool	active () const =0
	Indique l'état d'activation.
virtual void	setActive (bool is_active)=0
	Positionne l'état d'activation.
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	isMasterIO ()=0
	Méthode permettant de savoir si notre processus est l'écrivain.
virtual bool	isMasterIOOfSubDomain ()=0
	Méthode permettant de savoir si notre processus est l'écrivain pour notre sous-domaine. Dans le cas où la réplication est activée, un seul processus parmi les réplicats peut écrire (et uniquement dans le cas où isNonIOMasterCurvesEnabled() == true).
virtual bool	isNonIOMasterCurvesEnabled ()=0
	Méthode permettant de savoir si tous les processus peuvent avoir un historique de valeurs.
virtual bool	isIOMasterWriteOnly ()=0
	Méthode permettant de savoir s'il n'y a que le processus maitre qui appelle les écrivains.
virtual void	setIOMasterWriteOnly (bool is_active)=0
	Méthode permettant de définir si seul le processus maitre appelle les écrivains.
virtual void	addObservers (IPropertyMng *prop_mng)=0
	Méthode permettant de rajouter les observers sauvegardant l'historique avant une protection.
virtual void	editOutputPath (const Directory &directory)=0
	Méthode permettant de changer le répertoire de sortie des courbes.
virtual void	iterationsAndValues (const TimeHistoryAddValueArgInternal &thpi, UniqueArray< Int32 > &iterations, UniqueArray< Real > &values)=0
	Méthode permettant de sortir les itérations et les valeurs d'un historique.

Description détaillée

Interface de la partie interne d'un gestionnaire d'historique de valeur.

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

Documentation des fonctions membres

active()

virtual bool Arcane::ITimeHistoryMngInternal::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::TimeHistoryMngInternal.

addCurveWriter()

virtual void Arcane::ITimeHistoryMngInternal::addCurveWriter ( Ref< ITimeHistoryCurveWriter2 > writer )

pure virtual

Méthode permettant d'ajouter un écrivain pour la sortie des courbes.

Paramètres

writer

Une ref vers l'écrivain.

Implémenté dans Arcane::TimeHistoryMngInternal.

addNowInGlobalTime()

virtual void Arcane::ITimeHistoryMngInternal::addNowInGlobalTime ( )

pure virtual

Méthode permettant d'ajouter le GlobalTime actuel au tableau des GlobalTimes.

Implémenté dans Arcane::TimeHistoryMngInternal.

addObservers()

virtual void Arcane::ITimeHistoryMngInternal::addObservers ( IPropertyMng * prop_mng )

pure virtual

Méthode permettant de rajouter les observers sauvegardant l'historique avant une protection.

Paramètres

prop_mng

Un pointeur vers un IPropertyMng.

Implémenté dans Arcane::TimeHistoryMngInternal.

addValue() [1/6]

virtual void Arcane::ITimeHistoryMngInternal::addValue ( const TimeHistoryAddValueArgInternal & thpi, Int32 value )

pure virtual

Méthode permettant d'ajouter une valeur à un historique.

Paramètres

thpi	Les paramètres de historique.
value	La valeur à ajouter.

Implémenté dans Arcane::TimeHistoryMngInternal.

addValue() [2/6]

virtual void Arcane::ITimeHistoryMngInternal::addValue ( const TimeHistoryAddValueArgInternal & thpi, Int32ConstArrayView values )

pure virtual

Méthode permettant d'ajouter des valeurs à un historique.

Paramètres

thpi	Les paramètres de historique.
value	Les valeurs à ajouter.

Implémenté dans Arcane::TimeHistoryMngInternal.

addValue() [3/6]

virtual void Arcane::ITimeHistoryMngInternal::addValue ( const TimeHistoryAddValueArgInternal & thpi, Int64 value )

pure virtual

Méthode permettant d'ajouter une valeur à un historique.

Paramètres

thpi	Les paramètres de historique.
value	La valeur à ajouter.

Implémenté dans Arcane::TimeHistoryMngInternal.

addValue() [4/6]

virtual void Arcane::ITimeHistoryMngInternal::addValue ( const TimeHistoryAddValueArgInternal & thpi, Int64ConstArrayView values )

pure virtual

Méthode permettant d'ajouter des valeurs à un historique.

Paramètres

thpi	Les paramètres de historique.
value	Les valeurs à ajouter.

Implémenté dans Arcane::TimeHistoryMngInternal.

addValue() [5/6]

virtual void Arcane::ITimeHistoryMngInternal::addValue ( const TimeHistoryAddValueArgInternal & thpi, Real value )

pure virtual

Méthode permettant d'ajouter une valeur à un historique.

Paramètres

thpi	Les paramètres de historique.
value	La valeur à ajouter.

Implémenté dans Arcane::TimeHistoryMngInternal.

addValue() [6/6]

virtual void Arcane::ITimeHistoryMngInternal::addValue ( const TimeHistoryAddValueArgInternal & thpi, RealConstArrayView values )

pure virtual

Méthode permettant d'ajouter des valeurs à un historique.

Paramètres

thpi	Les paramètres de historique.
value	Les valeurs à ajouter.

Implémenté dans Arcane::TimeHistoryMngInternal.

applyTransformation()

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

pure virtual

Applique la transformation v à l'ensemble des courbes.

Paramètres

v	La transformation à appliquer.

Implémenté dans Arcane::TimeHistoryMngInternal.

dumpCurves()

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

pure virtual

Méthode permettant d"écrire les courbes à l'aide du writer fourni.

Paramètres

writer	Le writer avec lequel les courbes doivent être écrites.
master_only	Si tous les historiques doivent être transférés sur le masterIO avant la copie.

Implémenté dans Arcane::TimeHistoryMngInternal.

dumpHistory()

virtual void Arcane::ITimeHistoryMngInternal::dumpHistory ( )

pure virtual

Méthode permettant d'écrire toutes les courbes à l'aide de tous les writers enregistrés.

Implémenté dans Arcane::TimeHistoryMngInternal.

editOutputPath()

virtual void Arcane::ITimeHistoryMngInternal::editOutputPath ( const Directory & directory )

pure virtual

Méthode permettant de changer le répertoire de sortie des courbes.

À noter que le répertoire sera créé s'il n'existe pas.

Paramètres

directory

Le nouveau répertoire de sortie.

Implémenté dans Arcane::TimeHistoryMngInternal.

isDumpActive()

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

pure virtual

Indique l'état d'activation des sorties.

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

Implémenté dans Arcane::TimeHistoryMngInternal.

isIOMasterWriteOnly()

virtual bool Arcane::ITimeHistoryMngInternal::isIOMasterWriteOnly ( )

pure virtual

Méthode permettant de savoir s'il n'y a que le processus maitre qui appelle les écrivains.

Renvoie

true si oui

Implémenté dans Arcane::TimeHistoryMngInternal.

isMasterIO()

virtual bool Arcane::ITimeHistoryMngInternal::isMasterIO ( )

pure virtual

Méthode permettant de savoir si notre processus est l'écrivain.

Renvoie

True si nous sommes l'écrivain.

Implémenté dans Arcane::TimeHistoryMngInternal.

isMasterIOOfSubDomain()

virtual bool Arcane::ITimeHistoryMngInternal::isMasterIOOfSubDomain ( )

pure virtual

Méthode permettant de savoir si notre processus est l'écrivain pour notre sous-domaine. Dans le cas où la réplication est activée, un seul processus parmi les réplicats peut écrire (et uniquement dans le cas où isNonIOMasterCurvesEnabled() == true).

La variable d'environnement ARCANE_ENABLE_ALL_REPLICATS_WRITE_CURVES permet de bypasser cette protection et permet à tous les processus d'écrire.

Renvoie

True si nous sommes l'écrivain pour notre sous-domaine.

Implémenté dans Arcane::TimeHistoryMngInternal.

isNonIOMasterCurvesEnabled()

virtual bool Arcane::ITimeHistoryMngInternal::isNonIOMasterCurvesEnabled ( )

pure virtual

Méthode permettant de savoir si tous les processus peuvent avoir un historique de valeurs.

Implémenté dans Arcane::TimeHistoryMngInternal.

isShrinkActive()

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

pure virtual

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

Implémenté dans Arcane::TimeHistoryMngInternal.

iterationsAndValues()

virtual void Arcane::ITimeHistoryMngInternal::iterationsAndValues ( const TimeHistoryAddValueArgInternal & thpi, UniqueArray< Int32 > & iterations, UniqueArray< Real > & values )

pure virtual

Méthode permettant de sortir les itérations et les valeurs d'un historique.

Méthode utile pour du debug/test. Attention en mode réplication de domaine : il n'y a que les masterRank des sous-domaines qui possèdent les valeurs.

Paramètres

thpi	Les informations nécessaire à la récupération de l'historique.
iterations	[OUT] Les itérations où ont été récupéré chaque valeur.
values	[OUT] Les valeurs récupérées.

Implémenté dans Arcane::TimeHistoryMngInternal.

readVariables()

virtual void Arcane::ITimeHistoryMngInternal::readVariables ( IMeshMng * mesh_mng, IMesh * default_mesh )

pure virtual

Méthode permettant de récupérer les courbes précédemment écrites lors d'une reprise.

Paramètres

mesh_mng	Un pointeur vers un meshMng.
default_mesh	Un pointeur vers le maillage par défaut (nécessaire uniquement pour la récupération d'anciens checkpoints).

Implémenté dans Arcane::TimeHistoryMngInternal.

removeCurveWriter()

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

pure virtual

Méthode permettant de retirer un écrivain.

Paramètres

writer

Le nom de l'écrivain.

Implémenté dans Arcane::TimeHistoryMngInternal.

resizeArrayAfterRestore()

virtual void Arcane::ITimeHistoryMngInternal::resizeArrayAfterRestore ( )

pure virtual

Méthode permettant de redimensionner les tableaux de valeurs après une reprise.

Implémenté dans Arcane::TimeHistoryMngInternal.

setActive()

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

pure virtual

Positionne l'état d'activation.

Voir également

active().

Implémenté dans Arcane::TimeHistoryMngInternal.

setDumpActive()

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

pure virtual

Positionne l'état d'activation des sorties.

Implémenté dans Arcane::TimeHistoryMngInternal.

setIOMasterWriteOnly()

virtual void Arcane::ITimeHistoryMngInternal::setIOMasterWriteOnly ( bool is_active )

pure virtual

Méthode permettant de définir si seul le processus maitre appelle les écrivains.

Paramètres

is_active

true si oui

Implémenté dans Arcane::TimeHistoryMngInternal.

setShrinkActive()

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

pure virtual

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

Implémenté dans Arcane::TimeHistoryMngInternal.

updateGlobalTimeCurve()

virtual void Arcane::ITimeHistoryMngInternal::updateGlobalTimeCurve ( )

pure virtual

Méthode permettant de copier le tableau de GlobalTime dans la variable globale GlobalTime.

Implémenté dans Arcane::TimeHistoryMngInternal.

updateMetaData()

virtual void Arcane::ITimeHistoryMngInternal::updateMetaData ( )

pure virtual

Méthode permettant de mettre à jour les méta-données des courbes.

Implémenté dans Arcane::TimeHistoryMngInternal.

---

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

• ITimeHistoryMngInternal.h