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

Graphe de collaboration de Arcane::SimpleTableWriterHelper:

Fonctions membres publiques
	SimpleTableWriterHelper (const Ref< ISimpleTableReaderWriter > &simple_table_reader_writer)

bool	init (const Directory &root_directory, const String &table_name, const String &directory_name) override
	Méthode permettant d'initialiser l'objet. Notamment le nom du tableau et le nom du répertoire qui contiendra les fichiers (le répertoire des tableaux/directory_name).

void	print (Integer rank) override
	Méthode permettant d'afficher le tableau.

bool	writeFile (Integer rank) override

bool	writeFile (const Directory &root_directory, Integer rank) override

Integer	precision () override
	Méthode permettant de récupérer la précision actuellement utilisée pour l'écriture des valeurs.

void	setPrecision (Integer precision) override
	Méthode permettant de modifier la précision du print.

bool	isFixed () override
	Méthode permettant de savoir si le frag 'std::fixed' est actif ou non pour l'écriture des valeurs.

void	setFixed (bool fixed) override
	Méthode permettant de définir le flag 'std::fixed' ou non.

bool	isForcedToUseScientificNotation () override
	Méthode permettant de savoir si le frag 'std::scientific' est actif ou non pour l'écriture des valeurs.

void	setForcedToUseScientificNotation (bool use_scientific) override
	Méthode permettant de définir le flag 'std::scientific' ou non.

String	outputDirectory () override
	Méthode permettant de récupérer le nom du répertoire où sera placé les tableaux.

String	outputDirectoryWithoutComputation () override
	Méthode permettant de récupérer le nom du répertoire tel qu'il a été donné précédement.

void	setOutputDirectory (const String &directory) override
	Méthode permettant de définir le répertoire dans lequel enregistrer les tableaux.

String	tableName () override
	Méthode permettant de récupérer le nom du tableau.

String	tableNameWithoutComputation () override
	Méthode permettant de récupérer le nom du tableau tel qu'il a été donné précédement.

void	setTableName (const String &name) override
	Méthode permettant de définir le nom du tableau.

String	fileName () override
	Méthode permettant de récupérer le nom du fichier.

Directory	outputPath () override
	Méthode permettant de récupérer le chemin où sera enregistrés les tableaux.

Directory	rootPath () override
	Méthode permettant de récupérer le chemin où l'implémentation enregistre ces tableaux.

String	fileType () override
	Méthode permettant de connaitre le type de fichier qui sera utilisé.

bool	isOneFileByRanksPermited () override
	Méthode permettant de savoir si les paramètres actuellement en possession de l'implémentation lui permet d'écrire un fichier par processus, notamment grâce aux symboles de noms.

Ref< SimpleTableInternal >	internal () override
	Méthode permettant de récupérer une référence vers l'objet SimpleTableInternal utilisé.

Ref< ISimpleTableReaderWriter >	readerWriter () override
	Méthode permettant de récupérer une référence vers l'objet ISimpleTableReaderWriter utilisé.

void	setReaderWriter (const Ref< ISimpleTableReaderWriter > &simple_table_reader_writer) override
	Méthode permettant de définir une référence vers un ISimpleTableReaderWriter.

Fonctions membres protégées
void	_computeTableName ()

void	_computeOutputDirectory ()

String	_computeName (String name, bool &one_file_by_ranks_permited)
	Méthode permettant de remplacer les symboles de nom par leur valeur.

Description détaillée

Définition à la ligne 38 du fichier SimpleTableWriterHelper.h.

Documentation des constructeurs et destructeur

◆ SimpleTableWriterHelper() [1/2]

Arcane::SimpleTableWriterHelper::SimpleTableWriterHelper ( const Ref< ISimpleTableReaderWriter > & simple_table_reader_writer )

inline

Définition à la ligne 43 du fichier SimpleTableWriterHelper.h.

◆ SimpleTableWriterHelper() [2/2]

Arcane::SimpleTableWriterHelper::SimpleTableWriterHelper ( )

inline

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

Documentation des fonctions membres

◆ _computeName()

String Arcane::SimpleTableWriterHelper::_computeName	(	String	name,
		bool &	one_file_by_ranks_permited
	)

protected

Méthode permettant de remplacer les symboles de nom par leur valeur.

Paramètres

name	[IN] Le nom à modifier.
one_file_by_ranks_permited	[OUT] True si le nom contient le symbole '@proc_id@' permettant de différencier les fichiers écrits par differents processus.

Renvoie: String Le nom avec les symboles remplacés.

Définition à la ligne 281 du fichier SimpleTableWriterHelper.cc.

◆ _computeOutputDirectory()

void Arcane::SimpleTableWriterHelper::_computeOutputDirectory ( )

protected

Définition à la ligne 263 du fichier SimpleTableWriterHelper.cc.

◆ _computeTableName()

void Arcane::SimpleTableWriterHelper::_computeTableName ( )

protected

Définition à la ligne 254 du fichier SimpleTableWriterHelper.cc.

◆ fileName()

String Arcane::SimpleTableWriterHelper::fileName ( )

overridevirtual

Méthode permettant de récupérer le nom du fichier.

Peut-être différent pour chaque processus (dépendant de l'implémentation).

Ici, les symboles de noms ont été résolus et l'extension est ajoutée.

Renvoie: String Le nom.

Implémente Arcane::ISimpleTableWriterHelper.

Définition à la ligne 192 du fichier SimpleTableWriterHelper.cc.

Référencé par Arcane::SimpleCsvOutputService::fileName().

◆ fileType()

String Arcane::SimpleTableWriterHelper::fileType ( )

overridevirtual

Méthode permettant de connaitre le type de fichier qui sera utilisé.

Renvoie: String Le type de fichier de sortie (= l'extension).

Implémente Arcane::ISimpleTableWriterHelper.

Définition à la ligne 221 du fichier SimpleTableWriterHelper.cc.

Référencé par Arcane::SimpleCsvOutputService::fileType().

◆ init()

bool Arcane::SimpleTableWriterHelper::init	(	const Directory &	root_directory,
		const String &	table_name,
		const String &	directory_name
	)

overridevirtual

Méthode permettant d'initialiser l'objet. Notamment le nom du tableau et le nom du répertoire qui contiendra les fichiers (le répertoire des tableaux/directory_name).

Paramètres

table_name	Le nom du tableau (et du fichier de sortie).
directory_name	Le nom du dossier dans lequel enregistrer les tableaux.

Implémente Arcane::ISimpleTableWriterHelper.

Définition à la ligne 33 du fichier SimpleTableWriterHelper.cc.

Références setOutputDirectory(), et setTableName().

Référencé par Arcane::SimpleCsvOutputService::init().

◆ internal()

Ref< SimpleTableInternal > Arcane::SimpleTableWriterHelper::internal ( )

overridevirtual

Méthode permettant de récupérer une référence vers l'objet SimpleTableInternal utilisé.

Renvoie: Ref<SimpleTableInternal> Une copie de la référence.

Implémente Arcane::ISimpleTableWriterHelper.

Définition à la ligne 230 du fichier SimpleTableWriterHelper.cc.

◆ isFixed()

bool Arcane::SimpleTableWriterHelper::isFixed ( )

overridevirtual

Méthode permettant de savoir si le frag 'std::fixed' est actif ou non pour l'écriture des valeurs.

Renvoie: true Si oui.; false Si non.

Implémente Arcane::ISimpleTableWriterHelper.

Définition à la ligne 117 du fichier SimpleTableWriterHelper.cc.

Référencé par Arcane::SimpleCsvOutputService::isFixed().

◆ isForcedToUseScientificNotation()

bool Arcane::SimpleTableWriterHelper::isForcedToUseScientificNotation ( )

overridevirtual

Méthode permettant de savoir si le frag 'std::scientific' est actif ou non pour l'écriture des valeurs.

Renvoie: true Si oui.; false Si non.

Implémente Arcane::ISimpleTableWriterHelper.

Définition à la ligne 129 du fichier SimpleTableWriterHelper.cc.

Référencé par Arcane::SimpleCsvOutputService::isForcedToUseScientificNotation().

◆ isOneFileByRanksPermited()

bool Arcane::SimpleTableWriterHelper::isOneFileByRanksPermited ( )

overridevirtual

Méthode permettant de savoir si les paramètres actuellement en possession de l'implémentation lui permet d'écrire un fichier par processus, notamment grâce aux symboles de noms.

Renvoie: true Si oui, l'implémentation peut écrire un fichier par processus.; false Sinon, il n'y a qu'un seul fichier qui peut être écrit.

Implémente Arcane::ISimpleTableWriterHelper.

Définition à la ligne 212 du fichier SimpleTableWriterHelper.cc.

Référencé par Arcane::SimpleCsvOutputService::isOneFileByRanksPermited(), et writeFile().

◆ outputDirectory()

String Arcane::SimpleTableWriterHelper::outputDirectory ( )

overridevirtual

Méthode permettant de récupérer le nom du répertoire où sera placé les tableaux.

Peut-être différent pour chaque processus (dépendant de l'implémentation).

Ici, les symboles de noms ont été résolus.

Renvoie: String Le répertoire.

Implémente Arcane::ISimpleTableWriterHelper.

Définition à la ligne 144 du fichier SimpleTableWriterHelper.cc.

Référencé par Arcane::SimpleCsvOutputService::outputDirectory().

◆ outputDirectoryWithoutComputation()

String Arcane::SimpleTableWriterHelper::outputDirectoryWithoutComputation ( )

overridevirtual

Méthode permettant de récupérer le nom du répertoire tel qu'il a été donné précédement.

Ici, les symboles de noms sont toujours présent.

Renvoie: String Le répertoire.

Implémente Arcane::ISimpleTableWriterHelper.

Définition à la ligne 151 du fichier SimpleTableWriterHelper.cc.

◆ outputPath()

Directory Arcane::SimpleTableWriterHelper::outputPath ( )

overridevirtual

Méthode permettant de récupérer le chemin où sera enregistrés les tableaux.

Exemple (relatif) : ./output/csv/[directory_name]/

Renvoie: String Le chemin.

Implémente Arcane::ISimpleTableWriterHelper.

Définition à la ligne 199 du fichier SimpleTableWriterHelper.cc.

Référencé par Arcane::SimpleCsvOutputService::outputPath().

◆ precision()

Integer Arcane::SimpleTableWriterHelper::precision ( )

overridevirtual

Méthode permettant de récupérer la précision actuellement utilisée pour l'écriture des valeurs.

Renvoie: Integer La précision.

Implémente Arcane::ISimpleTableWriterHelper.

Définition à la ligne 105 du fichier SimpleTableWriterHelper.cc.

Référencé par Arcane::SimpleCsvOutputService::precision(), et setPrecision().

◆ print()

void Arcane::SimpleTableWriterHelper::print ( Integer rank )

overridevirtual

Méthode permettant d'afficher le tableau.

Paramètres

rank	L'id du processus devant afficher le tableau (-1 pour signifier "tous les processus").

Implémente Arcane::ISimpleTableWriterHelper.

Définition à la ligne 49 du fichier SimpleTableWriterHelper.cc.

Référencé par Arcane::SimpleCsvOutputService::print().

◆ readerWriter()

Ref< ISimpleTableReaderWriter > Arcane::SimpleTableWriterHelper::readerWriter ( )

overridevirtual

Méthode permettant de récupérer une référence vers l'objet ISimpleTableReaderWriter utilisé.

Renvoie: Ref<ISimpleTableReaderWriter> Une copie de la référence.

Implémente Arcane::ISimpleTableWriterHelper.

Définition à la ligne 236 du fichier SimpleTableWriterHelper.cc.

◆ rootPath()

Directory Arcane::SimpleTableWriterHelper::rootPath ( )

overridevirtual

Méthode permettant de récupérer le chemin où l'implémentation enregistre ces tableaux.

Exemple (relatif) : ./output/csv/

Renvoie: String Le chemin.

Implémente Arcane::ISimpleTableWriterHelper.

Définition à la ligne 206 du fichier SimpleTableWriterHelper.cc.

Référencé par Arcane::SimpleCsvOutputService::rootPath().

◆ setFixed()

void Arcane::SimpleTableWriterHelper::setFixed ( bool fixed )

overridevirtual

Méthode permettant de définir le flag 'std::fixed' ou non.

Aussi bien pour la méthode 'print()' que les méthodes 'writeFile()'.

Ce flag permet de 'forcer' le nombre de chiffre après la virgule à la précision voulu. Par exemple, si l'on a appelé 'setPrecision(4)', et que l'on appelle 'setFixed(true)', le print de '6.1' donnera '6.1000'.

Avertissement: Le flag "std::fixed" modifie le comportement de "setPrecision()", si le flag "std::fixed" est désactivé, la précision définira le nombre de chiffres total (avant et après la virgule) ; si le flag "std::fixed" est activé, la précision définira le nombre de chiffres après la virgule. Attention donc lors de l'utilisation de "std::numeric_limits<Real>::max_digits10" (pour l'écriture) ou de "std::numeric_limits<Real>::digits10" (pour la lecture) qui sont à utiliser sans le flag "std::fixed".

Paramètres

fixed Si le flag 'std::fixed' doit être défini ou non.

Implémente Arcane::ISimpleTableWriterHelper.

Définition à la ligne 123 du fichier SimpleTableWriterHelper.cc.

Référencé par Arcane::SimpleCsvOutputService::setFixed().

◆ setForcedToUseScientificNotation()

void Arcane::SimpleTableWriterHelper::setForcedToUseScientificNotation ( bool use_scientific )

overridevirtual

Méthode permettant de définir le flag 'std::scientific' ou non.

Aussi bien pour la méthode 'print()' que la méthode 'writetable()'.

Ce flag permet de 'forcer' l'affichage des valeurs en écriture scientifique.

Paramètres

use_scientific Si le flag 'std::scientific' doit être défini ou non.

Implémente Arcane::ISimpleTableWriterHelper.

Définition à la ligne 135 du fichier SimpleTableWriterHelper.cc.

Référencé par Arcane::SimpleCsvOutputService::setForcedToUseScientificNotation().

◆ setOutputDirectory()

void Arcane::SimpleTableWriterHelper::setOutputDirectory ( const String & directory )

overridevirtual

Méthode permettant de définir le répertoire dans lequel enregistrer les tableaux.

Peut-être différent pour chaque processus (dépendant de l'implémentation).

Paramètres

directory Le répertoire.

Implémente Arcane::ISimpleTableWriterHelper.

Définition à la ligne 157 du fichier SimpleTableWriterHelper.cc.

Référencé par init(), Arcane::SimpleCsvOutputService::setOutputDirectory(), et Arcane::SimpleCsvOutputService::writeFile().

◆ setPrecision()

void Arcane::SimpleTableWriterHelper::setPrecision ( Integer precision )

overridevirtual

Méthode permettant de modifier la précision du print.

Aussi bien pour la méthode 'print()' que les méthodes 'writeFile()'.

Avertissement: Le flag "std::fixed" modifie le comportement de "setPrecision()", si le flag "std::fixed" est désactivé, la précision définira le nombre de chiffres total (avant et après la virgule) ; si le flag "std::fixed" est activé, la précision définira le nombre de chiffres après la virgule. Attention donc lors de l'utilisation de "std::numeric_limits<Real>::max_digits10" (pour l'écriture) ou de "std::numeric_limits<Real>::digits10" (pour la lecture) qui sont à utiliser sans le flag "std::fixed".

Paramètres

precision La nouvelle précision.

Implémente Arcane::ISimpleTableWriterHelper.

Définition à la ligne 111 du fichier SimpleTableWriterHelper.cc.

Références precision().

Référencé par Arcane::SimpleCsvOutputService::setPrecision().

◆ setReaderWriter()

void Arcane::SimpleTableWriterHelper::setReaderWriter ( const Ref< ISimpleTableReaderWriter > & simple_table_reader_writer )

overridevirtual

Méthode permettant de définir une référence vers un ISimpleTableReaderWriter.

Paramètres

simple_table_reader_writer La référence vers un ISimpleTableReaderWriter.

Implémente Arcane::ISimpleTableWriterHelper.

Définition à la ligne 242 du fichier SimpleTableWriterHelper.cc.

Références ARCANE_FATAL.

Référencé par Arcane::SimpleCsvOutputService::init().

◆ setTableName()

void Arcane::SimpleTableWriterHelper::setTableName ( const String & name )

overridevirtual

Méthode permettant de définir le nom du tableau.

Paramètres

name Le nom.

Implémente Arcane::ISimpleTableWriterHelper.

Définition à la ligne 181 du fichier SimpleTableWriterHelper.cc.

Référencé par init(), et Arcane::SimpleCsvOutputService::setTableName().

◆ tableName()

String Arcane::SimpleTableWriterHelper::tableName ( )

overridevirtual

Méthode permettant de récupérer le nom du tableau.

Peut-être différent pour chaque processus (dépendant de l'implémentation).

Ici, les symboles de noms ont été résolus.

Renvoie: String Le nom.

Implémente Arcane::ISimpleTableWriterHelper.

Définition à la ligne 168 du fichier SimpleTableWriterHelper.cc.

Référencé par Arcane::SimpleCsvOutputService::tableName().

◆ tableNameWithoutComputation()

String Arcane::SimpleTableWriterHelper::tableNameWithoutComputation ( )

overridevirtual

Méthode permettant de récupérer le nom du tableau tel qu'il a été donné précédement.

Ici, les symboles de noms sont toujours présent.

Renvoie: String Le nom.

Implémente Arcane::ISimpleTableWriterHelper.

Définition à la ligne 175 du fichier SimpleTableWriterHelper.cc.

◆ writeFile() [1/2]

bool Arcane::SimpleTableWriterHelper::writeFile	(	const Directory &	root_directory,
		Integer	rank
	)

overridevirtual

Méthode effectuant des opérations collectives.

Implémente Arcane::ISimpleTableWriterHelper.

Définition à la ligne 60 du fichier SimpleTableWriterHelper.cc.

Références Arcane::SimpleTableReaderWriterUtils::createDirectoryOnlyProcess0(), et isOneFileByRanksPermited().

◆ writeFile() [2/2]

bool Arcane::SimpleTableWriterHelper::writeFile ( Integer rank )

overridevirtual

Méthode effectuant des opérations collectives.

Implémente Arcane::ISimpleTableWriterHelper.

Définition à la ligne 96 du fichier SimpleTableWriterHelper.cc.

Références writeFile().

Référencé par Arcane::SimpleCsvOutputService::writeFile(), Arcane::SimpleCsvOutputService::writeFile(), et writeFile().

Documentation des données membres

◆ m_name_output_directory

String Arcane::SimpleTableWriterHelper::m_name_output_directory

protected

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

◆ m_name_output_directory_computed

bool Arcane::SimpleTableWriterHelper::m_name_output_directory_computed

protected

Définition à la ligne 130 du fichier SimpleTableWriterHelper.h.

◆ m_name_output_directory_one_file_by_ranks_permited

bool Arcane::SimpleTableWriterHelper::m_name_output_directory_one_file_by_ranks_permited

protected

Définition à la ligne 136 du fichier SimpleTableWriterHelper.h.

◆ m_name_output_directory_without_computation

String Arcane::SimpleTableWriterHelper::m_name_output_directory_without_computation

protected

Définition à la ligne 124 du fichier SimpleTableWriterHelper.h.

◆ m_name_table_computed

bool Arcane::SimpleTableWriterHelper::m_name_table_computed

protected

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

◆ m_name_table_one_file_by_ranks_permited

bool Arcane::SimpleTableWriterHelper::m_name_table_one_file_by_ranks_permited

protected

Définition à la ligne 135 du fichier SimpleTableWriterHelper.h.

◆ m_name_table_without_computation

String Arcane::SimpleTableWriterHelper::m_name_table_without_computation

protected

Définition à la ligne 125 du fichier SimpleTableWriterHelper.h.

◆ m_root

Directory Arcane::SimpleTableWriterHelper::m_root

protected

Définition à la ligne 127 du fichier SimpleTableWriterHelper.h.

◆ m_simple_table_internal

Ref<SimpleTableInternal> Arcane::SimpleTableWriterHelper::m_simple_table_internal

protected

Définition à la ligne 120 du fichier SimpleTableWriterHelper.h.

◆ m_simple_table_reader_writer

Ref<ISimpleTableReaderWriter> Arcane::SimpleTableWriterHelper::m_simple_table_reader_writer

protected

Définition à la ligne 121 du fichier SimpleTableWriterHelper.h.

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

Attributs protégés
Ref< SimpleTableInternal >	m_simple_table_internal

Ref< ISimpleTableReaderWriter >	m_simple_table_reader_writer

String	m_name_output_directory

String	m_name_output_directory_without_computation

String	m_name_table_without_computation

Directory	m_root

bool	m_name_table_computed

bool	m_name_output_directory_computed

bool	m_name_table_one_file_by_ranks_permited

bool	m_name_output_directory_one_file_by_ranks_permited

Fonctions membres publiques

Fonctions membres protégées

Attributs protégés

Description détaillée

Documentation des constructeurs et destructeur

◆ SimpleTableWriterHelper() [1/2]

◆ SimpleTableWriterHelper() [2/2]

Documentation des fonctions membres

◆ _computeName()

◆ _computeOutputDirectory()

◆ _computeTableName()

◆ fileName()

◆ fileType()

◆ init()

◆ internal()

◆ isFixed()

◆ isForcedToUseScientificNotation()

◆ isOneFileByRanksPermited()

◆ outputDirectory()

◆ outputDirectoryWithoutComputation()

◆ outputPath()

◆ precision()

◆ print()

◆ readerWriter()

◆ rootPath()

◆ setFixed()

◆ setForcedToUseScientificNotation()

◆ setOutputDirectory()

◆ setPrecision()

◆ setReaderWriter()

◆ setTableName()

◆ tableName()

◆ tableNameWithoutComputation()

◆ writeFile() [1/2]

◆ writeFile() [2/2]

Documentation des données membres

◆ m_name_output_directory

◆ m_name_output_directory_computed

◆ m_name_output_directory_one_file_by_ranks_permited

◆ m_name_output_directory_without_computation

◆ m_name_table_computed

◆ m_name_table_one_file_by_ranks_permited

◆ m_name_table_without_computation

◆ m_root

◆ m_simple_table_internal

◆ m_simple_table_reader_writer