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

Interface d'un écrivain pour les informations de post-traitement. Plus de détails...

#include <arcane/core/IPostProcessorWriter.h>

Fonctions membres publiques
virtual	~IPostProcessorWriter ()=default
	Libère les ressources.
virtual void	build ()=0
	Construit l'instance.
virtual IDataWriter *	dataWriter ()=0
	Retourne l'écrivain associé à ce post-processeur.
virtual void	setBaseDirectoryName (const String &dirname)=0
	Positionne le nom du répertoire de sortie des fichiers.
virtual String	baseDirectoryName ()=0
	Nom du répertoire de sortie des fichiers.
virtual void	setBaseFileName (const String &filename)=0
	Positionne le nom du fichier contenant les sorties.
virtual String	baseFileName ()=0
	Nom du fichier contenant les sorties.
virtual void	setMesh (IMesh *mesh)
	Positionne le maillage.
virtual void	setTimes (ConstArrayView< Real > times)=0
	Positionne la liste des temps.
virtual ConstArrayView< Real >	times ()=0
	Liste des temps sauvés.
virtual void	setVariables (const VariableCollection &variables)=0
	Positionne la liste des variables à sortir.
virtual VariableCollection	variables ()=0
	Liste des variables à sauver.
virtual void	setGroups (const ItemGroupCollection &groups)=0
	Positionne la liste des groupes à sortir.
virtual ItemGroupCollection	groups ()=0
	Liste des groupes à sauver.
virtual void	notifyBeginWrite ()=0
	Notifie qu'une sortie va être effectuée avec les paramètres courants.
virtual void	notifyEndWrite ()=0
	Notifie qu'une sortie vient d'être effectuée.
virtual void	close ()=0
	Ferme l'écrivain. Après fermeture, il ne peut plus être utilisé

Description détaillée

Interface d'un écrivain pour les informations de post-traitement.

L'instance doit retourner un IDataWriter (via dataWriter()) pour gérer l'écriture.

L'appelant doit positionner les champs de l'instant et lancer L'écriture via l'appel IVariableMng::writePostProcessing(). Par exemple

IPostProcessorWriter* pp = ...;
pp->setBaseDirectoryName(...);
pp->setTimes(...);
pp->setVariables(...);
pp->setGroups(...);
IVariableMng* vm = ...;
vm->writerPostProcessing(pp);

Avant d'écrire les variables, l'instance IVariableMng va appeler notifyBeginWrite(). Après l'écriture, elle appelle notifyEndWrite().

Définition à la ligne 57 du fichier IPostProcessorWriter.h.

Documentation des fonctions membres

baseDirectoryName()

virtual String Arcane::IPostProcessorWriter::baseDirectoryName ( )

pure virtual

Nom du répertoire de sortie des fichiers.

Implémenté dans Arcane::PostProcessorWriterBase.

baseFileName()

virtual String Arcane::IPostProcessorWriter::baseFileName ( )

pure virtual

Nom du fichier contenant les sorties.

Implémenté dans Arcane::PostProcessorWriterBase.

Références setMesh().

build()

virtual void Arcane::IPostProcessorWriter::build ( )

pure virtual

Construit l'instance.

Implémenté dans Arcane::ManualHdf5VariableWriter, et Arcane::PostProcessorWriterBase.

close()

virtual void Arcane::IPostProcessorWriter::close ( )

pure virtual

Ferme l'écrivain. Après fermeture, il ne peut plus être utilisé

Implémenté dans Arcane::ManualHdf5VariableWriter.

Références close().

Référencé par close().

dataWriter()

virtual IDataWriter * Arcane::IPostProcessorWriter::dataWriter ( )

pure virtual

Retourne l'écrivain associé à ce post-processeur.

Le pointeur retourné n'est valide qu'entre appels à notifyBeginWrite() et notifyEndWrite().

Implémenté dans Arcane::ManualHdf5VariableWriter.

groups()

virtual ItemGroupCollection Arcane::IPostProcessorWriter::groups ( )

pure virtual

Liste des groupes à sauver.

Implémenté dans Arcane::PostProcessorWriterBase.

Références groups().

Référencé par groups(), et setGroups().

notifyBeginWrite()

virtual void Arcane::IPostProcessorWriter::notifyBeginWrite ( )

pure virtual

Notifie qu'une sortie va être effectuée avec les paramètres courants.

Implémenté dans Arcane::ManualHdf5VariableWriter.

Références notifyBeginWrite().

Référencé par notifyBeginWrite().

notifyEndWrite()

virtual void Arcane::IPostProcessorWriter::notifyEndWrite ( )

pure virtual

Notifie qu'une sortie vient d'être effectuée.

Implémenté dans Arcane::ManualHdf5VariableWriter.

Références notifyEndWrite().

Référencé par notifyEndWrite().

setBaseDirectoryName()

virtual void Arcane::IPostProcessorWriter::setBaseDirectoryName ( const String & dirname )

pure virtual

Positionne le nom du répertoire de sortie des fichiers.

Ce répertoire doit exister.

Implémenté dans Arcane::PostProcessorWriterBase.

setBaseFileName()

virtual void Arcane::IPostProcessorWriter::setBaseFileName ( const String & filename )

pure virtual

Positionne le nom du fichier contenant les sorties.

Tous les écrivains ne supportent pas de changer le nom de fichier.

Implémenté dans Arcane::PostProcessorWriterBase.

setGroups()

virtual void Arcane::IPostProcessorWriter::setGroups ( const ItemGroupCollection & groups )

pure virtual

Positionne la liste des groupes à sortir.

La collection passée en argument est clonée.

Implémenté dans Arcane::PostProcessorWriterBase.

Références groups(), et setGroups().

Référencé par setGroups().

setMesh()

void Arcane::IPostProcessorWriter::setMesh ( IMesh * mesh )

virtual

Positionne le maillage.

Si non surchargée, cette méthode ne fait rien.

Obsolète

Cette méthode est obsolète. Il n'est plus possible de changer le maillage d'un service implémentant cette interface. Le choix du maillage se fait lors de la création du service via ServiceBuilder en passant le maillage souhaité en argument.

Définition à la ligne 273 du fichier InterfaceImpl.cc.

Références ARCANE_FATAL, et Arcane::platform::getEnvironmentVariable().

Référencé par baseFileName().

setTimes()

virtual void Arcane::IPostProcessorWriter::setTimes ( ConstArrayView< Real > times )

pure virtual

Positionne la liste des temps.

Implémenté dans Arcane::PostProcessorWriterBase.

Références setTimes(), et times().

Référencé par setTimes().

setVariables()

virtual void Arcane::IPostProcessorWriter::setVariables ( const VariableCollection & variables )

pure virtual

Positionne la liste des variables à sortir.

Implémenté dans Arcane::PostProcessorWriterBase.

Références setVariables(), et variables().

Référencé par setVariables().

times()

virtual ConstArrayView< Real > Arcane::IPostProcessorWriter::times ( )

pure virtual

Liste des temps sauvés.

Implémenté dans Arcane::PostProcessorWriterBase.

Références times().

Référencé par setTimes(), et times().

variables()

virtual VariableCollection Arcane::IPostProcessorWriter::variables ( )

pure virtual

Liste des variables à sauver.

Implémenté dans Arcane::PostProcessorWriterBase.

Références variables().

Référencé par setVariables(), et variables().

---

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

• IPostProcessorWriter.h
• InterfaceImpl.cc