Classe de base d'un historique de valeurs. Plus de détails...

#include <arcane/impl/internal/TimeHistoryMngInternal.h>

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

Graphe de collaboration de Arcane::TimeHistoryValue:

Fonctions membres publiques
	TimeHistoryValue (const TimeHistoryAddValueArgInternal &thpi, eDataType dt, Integer index, Integer sub_size)

virtual	~TimeHistoryValue ()=default
	Libére les ressources.

virtual void	fromOldToNewVariables (IVariableMng vm, IMesh default_mesh)=0
	Méthode permettant de convertir les variables d'anciennes sauvegardes vers le nouveau format.

virtual void	dumpValues (ITraceMng msg, ITimeHistoryCurveWriter2 writer, const TimeHistoryCurveWriterInfo &infos) const =0
	Imprime les valeurs de l'historique avec l'écrivain writer.

virtual void	arrayToWrite (UniqueArray< Int32 > &iterations, UniqueArray< Real > &values, const TimeHistoryCurveWriterInfo &infos) const =0
	Méthode permettant de récupérer les itérations et les valeurs d'un historique de valeur.

virtual void	applyTransformation (ITraceMng msg, ITimeHistoryTransformer v)=0
	Méthode permettant d'appliquer une transformation sur les valeurs de l'historique de valeur.

virtual Integer	size () const =0
	Méthode permettant de récupérer le nombre de valeurs enregistrées.

virtual void	removeAfterIteration (Integer last_iteration)=0
	Méthode permettant de retirer toutes les valeurs après une certaine itération.

const String &	name () const
	Nom de l'historique.

eDataType	dataType () const
	Type de données de l'historique.

Integer	index () const
	Index de l'historique dans la liste.

Integer	subSize () const

const MeshHandle &	meshHandle () const
	Méthode permettant de récupérer le MeshHandle enregistré.

bool	isLocal () const
	Méthode permettant de savoir si c'est un historique global ou local à un sous-domaine.

Integer	localProcId () const
	Méthode permettant de récupérer l'id du sous-domaine à qui appartient cet historique.

Attributs privés
eDataType	m_data_type
	Type de la donnée.

Integer	m_index
	Index de l'historique dans la liste.

Integer	m_sub_size

TimeHistoryAddValueArgInternal	m_thpi

Description détaillée

Classe de base d'un historique de valeurs.

Un historique contient un ensemble de valeurs pour certaines itérations. Il est caractérisé par un nom.

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

Documentation des constructeurs et destructeur

◆ TimeHistoryValue()

Arcane::TimeHistoryValue::TimeHistoryValue	(	const TimeHistoryAddValueArgInternal &	thpi,
		eDataType	dt,
		Integer	index,
		Integer	sub_size
	)

inline

Définition à la ligne 62 du fichier TimeHistoryMngInternal.h.

Documentation des fonctions membres

◆ applyTransformation()

virtual void Arcane::TimeHistoryValue::applyTransformation	(	ITraceMng *	msg,
		ITimeHistoryTransformer *	v
	)

pure virtual

Méthode permettant d'appliquer une transformation sur les valeurs de l'historique de valeur.

Paramètres

msg	Le traceMng où écrire les messages.
v	Le transformer.

Implémenté dans Arcane::TimeHistoryValueT< DataType >.

◆ arrayToWrite()

virtual void Arcane::TimeHistoryValue::arrayToWrite	(	UniqueArray< Int32 > &	iterations,
		UniqueArray< Real > &	values,
		const TimeHistoryCurveWriterInfo &	infos
	)		const

pure virtual

Méthode permettant de récupérer les itérations et les valeurs d'un historique de valeur.

Paramètres

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

Implémenté dans Arcane::TimeHistoryValueT< DataType >.

◆ dataType()

eDataType Arcane::TimeHistoryValue::dataType ( ) const

inline

Type de données de l'historique.

Définition à la ligne 126 du fichier TimeHistoryMngInternal.h.

Références m_data_type.

◆ dumpValues()

virtual void Arcane::TimeHistoryValue::dumpValues	(	ITraceMng *	msg,
		ITimeHistoryCurveWriter2 *	writer,
		const TimeHistoryCurveWriterInfo &	infos
	)		const

pure virtual

Imprime les valeurs de l'historique avec l'écrivain writer.

Implémenté dans Arcane::TimeHistoryValueT< DataType >.

◆ fromOldToNewVariables()

virtual void Arcane::TimeHistoryValue::fromOldToNewVariables	(	IVariableMng *	vm,
		IMesh *	default_mesh
	)

pure virtual

Méthode permettant de convertir les variables d'anciennes sauvegardes vers le nouveau format.

Paramètres

vm	Le VariableMng.
default_mesh	Le maillage par défaut.

Implémenté dans Arcane::TimeHistoryValueT< DataType >.

◆ index()

Integer Arcane::TimeHistoryValue::index ( ) const

inline

Index de l'historique dans la liste.

Définition à la ligne 129 du fichier TimeHistoryMngInternal.h.

Références m_index.

Référencé par Arcane::TimeHistoryValueT< DataType >::fromOldToNewVariables().

◆ isLocal()

bool Arcane::TimeHistoryValue::isLocal ( ) const

inline

Méthode permettant de savoir si c'est un historique global ou local à un sous-domaine.

Voir également: localProcId()

Renvoie: true si c'est un historique local.

Définition à la ligne 148 du fichier TimeHistoryMngInternal.h.

◆ localProcId()

Integer Arcane::TimeHistoryValue::localProcId ( ) const

inline

Méthode permettant de récupérer l'id du sous-domaine à qui appartient cet historique.

Renvoie: L'in du sous-domaine.

Définition à la ligne 155 du fichier TimeHistoryMngInternal.h.

Référencé par Arcane::TimeHistoryValueT< DataType >::dumpValues().

◆ meshHandle()

const MeshHandle & Arcane::TimeHistoryValue::meshHandle ( ) const

inline

Méthode permettant de récupérer le MeshHandle enregistré.

Attention, pour les historiques globaux, ce MeshHandle est null !

Renvoie: Le MeshHandle.

Définition à la ligne 140 du fichier TimeHistoryMngInternal.h.

Référencé par Arcane::TimeHistoryValueT< DataType >::dumpValues().

◆ name()

const String & Arcane::TimeHistoryValue::name ( ) const

inline

Nom de l'historique.

Définition à la ligne 123 du fichier TimeHistoryMngInternal.h.

Référencé par Arcane::TimeHistoryValueT< DataType >::applyTransformation(), et Arcane::TimeHistoryValueT< DataType >::dumpValues().

◆ removeAfterIteration()

virtual void Arcane::TimeHistoryValue::removeAfterIteration ( Integer last_iteration )

pure virtual

Méthode permettant de retirer toutes les valeurs après une certaine itération.

Paramètres

last_iteration La dernière itération voulu.

Implémenté dans Arcane::TimeHistoryValueT< DataType >.

◆ size()

virtual Integer Arcane::TimeHistoryValue::size ( ) const

pure virtual

Méthode permettant de récupérer le nombre de valeurs enregistrées.

Renvoie: Le nombre de valeurs enregistrées.

Implémenté dans Arcane::TimeHistoryValueT< DataType >.

◆ subSize()

Integer Arcane::TimeHistoryValue::subSize ( ) const

inline

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

Documentation des données membres

◆ m_data_type

eDataType Arcane::TimeHistoryValue::m_data_type

private

Type de la donnée.

Définition à la ligne 159 du fichier TimeHistoryMngInternal.h.

Référencé par dataType().

◆ m_index

Integer Arcane::TimeHistoryValue::m_index

private

Index de l'historique dans la liste.

Définition à la ligne 160 du fichier TimeHistoryMngInternal.h.

Référencé par index().

◆ m_sub_size

Integer Arcane::TimeHistoryValue::m_sub_size

private

Définition à la ligne 161 du fichier TimeHistoryMngInternal.h.

◆ m_thpi

TimeHistoryAddValueArgInternal Arcane::TimeHistoryValue::m_thpi

private

Définition à la ligne 162 du fichier TimeHistoryMngInternal.h.

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

TimeHistoryMngInternal.h

Fonctions membres publiques

Attributs privés

Description détaillée

Documentation des constructeurs et destructeur

◆ TimeHistoryValue()

Documentation des fonctions membres

◆ applyTransformation()

◆ arrayToWrite()

◆ dataType()

◆ dumpValues()

◆ fromOldToNewVariables()

◆ index()

◆ isLocal()

◆ localProcId()

◆ meshHandle()

◆ name()

◆ removeAfterIteration()

◆ size()

◆ subSize()

Documentation des données membres

◆ m_data_type

◆ m_index

◆ m_sub_size

◆ m_thpi