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>

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

Graphe de collaboration de Arcane::IPostProcessorWriter:

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. Ce répertoire doit exister.
virtual const 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 const String &	baseFileName ()=0
	Nom du fichier contenant les sorties.
virtual void	setMesh (IMesh *mesh)
	Positionne le maillage.
virtual void	setTimes (RealConstArrayView times)=0
	Positionne la liste des temps.
virtual RealConstArrayView	times ()=0
	Liste des temps sauvés.
virtual void	setVariables (VariableCollection variables)=0
	Positionne la liste des variables à sortir.
virtual VariableCollection	variables ()=0
	Liste des variables à sauver.
virtual void	setGroups (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 const String & Arcane::IPostProcessorWriter::baseDirectoryName ( )

pure virtual

Nom du répertoire de sortie des fichiers.

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

baseFileName()

virtual const String & Arcane::IPostProcessorWriter::baseFileName ( )

pure virtual

Nom du fichier contenant les sorties.

Implémenté dans Arcane::PostProcessorWriterBase.

build()

virtual void Arcane::IPostProcessorWriter::build ( )

pure virtual

Construit l'instance.

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

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, Arcane::Ensight7PostProcessorService, Arcane::Ensight7PostProcessorServiceV2, Arcane::UCDPostProcessorService, Arcane::KdiPostProcessor, Arcane::VtkHdfPostProcessor, et Arcane::VtkHdfV2PostProcessor.

dataWriter()

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

pure virtual

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

Implémenté dans Arcane::ManualHdf5VariableWriter, Arcane::Ensight7PostProcessorService, Arcane::Ensight7PostProcessorServiceV2, Arcane::UCDPostProcessorService, Arcane::KdiPostProcessor, Arcane::VtkHdfPostProcessor, et Arcane::VtkHdfV2PostProcessor.

groups()

virtual ItemGroupCollection Arcane::IPostProcessorWriter::groups ( )

pure virtual

Liste des groupes à sauver.

Implémenté dans Arcane::PostProcessorWriterBase.

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, Arcane::Ensight7PostProcessorService, Arcane::Ensight7PostProcessorServiceV2, Arcane::UCDPostProcessorService, Arcane::KdiPostProcessor, Arcane::VtkHdfPostProcessor, et Arcane::VtkHdfV2PostProcessor.

notifyEndWrite()

virtual void Arcane::IPostProcessorWriter::notifyEndWrite ( )

pure virtual

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

Implémenté dans Arcane::ManualHdf5VariableWriter, Arcane::Ensight7PostProcessorService, Arcane::Ensight7PostProcessorServiceV2, Arcane::UCDPostProcessorService, Arcane::KdiPostProcessor, Arcane::VtkHdfPostProcessor, et Arcane::VtkHdfV2PostProcessor.

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, et Arcane::Ensight7PostProcessorServiceV2.

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 ( ItemGroupCollection  groups )

pure virtual

Positionne la liste des groupes à sortir.

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

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.

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

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

Références ARCANE_FATAL.

setTimes()

virtual void Arcane::IPostProcessorWriter::setTimes ( RealConstArrayView  times )

pure virtual

Positionne la liste des temps.

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

setVariables()

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

pure virtual

Positionne la liste des variables à sortir.

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

times()

virtual RealConstArrayView Arcane::IPostProcessorWriter::times ( )

pure virtual

Liste des temps sauvés.

Implémenté dans Arcane::PostProcessorWriterBase.

variables()

virtual VariableCollection Arcane::IPostProcessorWriter::variables ( )

pure virtual

Liste des variables à sauver.

Implémenté dans Arcane::PostProcessorWriterBase.

---

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

• IPostProcessorWriter.h
• InterfaceImpl.cc