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

Graphe de collaboration de Arcane::SimpleCsvReaderWriter:

Fonctions membres publiques
	SimpleCsvReaderWriter (const Ref< SimpleTableInternal > &simple_table_internal)

bool	writeTable (const Directory &dst, const String &file_name) override
	Méthode permettant d'écrire un tableau simple dans un fichier.

bool	readTable (const Directory &src, const String &file_name) override
	Méthode permettant de lire un fichier contenant un tableau simple.

void	clearInternal () override
	Méthode permettant d'effacer le contenu de l'objet SimpleTableInternal.

void	print () override
	Méthode permettant d'écrire le tableau dans la sortie standard.

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	fileType () override
	Méthode permettant de récupérer le type de fichier qui sera écrit par l'implémentation. ("csv" sera retourné pour l'implémentation csv).

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

void	setInternal (const Ref< SimpleTableInternal > &simple_table_internal) override
	Méthode permettant de définir une référence vers un SimpleTableInternal.

Fonctions membres protégées
bool	_openFile (std::ifstream &stream, Directory directory, const String &file)

void	_closeFile (std::ifstream &stream)

void	_print (std::ostream &stream)

Attributs protégés
Ref< SimpleTableInternal >	m_simple_table_internal

char	m_separator

Integer	m_precision_print

bool	m_is_fixed_print

bool	m_scientific_notation

const String	m_output_file_type = "csv"

Description détaillée

Définition à la ligne 34 du fichier SimpleCsvReaderWriter.h.

Documentation des constructeurs et destructeur

◆ SimpleCsvReaderWriter() [1/2]

Arcane::SimpleCsvReaderWriter::SimpleCsvReaderWriter ( const Ref< SimpleTableInternal > & simple_table_internal )

inline

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

◆ SimpleCsvReaderWriter() [2/2]

Arcane::SimpleCsvReaderWriter::SimpleCsvReaderWriter ( )

inline

Définition à la ligne 49 du fichier SimpleCsvReaderWriter.h.

Documentation des fonctions membres

◆ _closeFile()

void Arcane::SimpleCsvReaderWriter::_closeFile ( std::ifstream & stream )

protected

Définition à la ligne 229 du fichier SimpleCsvReaderWriter.cc.

◆ _openFile()

bool Arcane::SimpleCsvReaderWriter::_openFile	(	std::ifstream &	stream,
		Directory	directory,
		const String &	file
	)

protected

Définition à la ligne 222 du fichier SimpleCsvReaderWriter.cc.

◆ _print()

void Arcane::SimpleCsvReaderWriter::_print ( std::ostream & stream )

protected

Définition à la ligne 235 du fichier SimpleCsvReaderWriter.cc.

◆ clearInternal()

void Arcane::SimpleCsvReaderWriter::clearInternal ( )

overridevirtual

Méthode permettant d'effacer le contenu de l'objet SimpleTableInternal.

Implémente Arcane::ISimpleTableReaderWriter.

Définition à la ligne 146 du fichier SimpleCsvReaderWriter.cc.

Référencé par readTable().

◆ fileType()

String Arcane::SimpleCsvReaderWriter::fileType ( )

inlineoverridevirtual

Méthode permettant de récupérer le type de fichier qui sera écrit par l'implémentation. ("csv" sera retourné pour l'implémentation csv).

Renvoie: String Le type/l'extension du fichier utilisé.

Implémente Arcane::ISimpleTableReaderWriter.

Définition à la ligne 75 du fichier SimpleCsvReaderWriter.h.

Référencé par readTable(), et writeTable().

◆ internal()

Ref< SimpleTableInternal > Arcane::SimpleCsvReaderWriter::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::ISimpleTableReaderWriter.

Définition à la ligne 205 du fichier SimpleCsvReaderWriter.cc.

◆ isFixed()

bool Arcane::SimpleCsvReaderWriter::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::ISimpleTableReaderWriter.

Définition à la ligne 178 du fichier SimpleCsvReaderWriter.cc.

◆ isForcedToUseScientificNotation()

bool Arcane::SimpleCsvReaderWriter::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::ISimpleTableReaderWriter.

Définition à la ligne 190 du fichier SimpleCsvReaderWriter.cc.

◆ precision()

Integer Arcane::SimpleCsvReaderWriter::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::ISimpleTableReaderWriter.

Définition à la ligne 161 du fichier SimpleCsvReaderWriter.cc.

Référencé par setPrecision().

◆ print()

void Arcane::SimpleCsvReaderWriter::print ( )

overridevirtual

Méthode permettant d'écrire le tableau dans la sortie standard.

Le format d'écriture est libre (pour l'implémentation csv, l'écriture se fait pareil que dans un fichier csv).

Implémente Arcane::ISimpleTableReaderWriter.

Définition à la ligne 152 du fichier SimpleCsvReaderWriter.cc.

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

◆ readTable()

bool Arcane::SimpleCsvReaderWriter::readTable	(	const Directory &	src,
		const String &	file_name
	)

overridevirtual

Méthode permettant de lire un fichier contenant un tableau simple.

L'extension sera ajouté par l'implémentation.

Un appel à SimpleTableInternal::clear() devra être effectué avant la lecture.

Les élements qui doivent impérativement être récupérés sont :

les noms des lignes (m_row_names),
les noms des colonnes (m_column_names),
le nom du tableau (m_table_name),
les valeurs du tableau (m_values).

Les élements qui doivent être déduit si non récupérés sont :

les tailles des lignes (m_row_sizes),
les tailles des colonnes (m_column_sizes).

Déduction par défaut pour m_row_sizes :

len(m_row_sizes) = len(m_row_names)
m_row_sizes[*] = m_values.dim2Size()

Déduction par défaut pour m_column_sizes :

len(m_column_sizes) = len(m_column_names)
m_column_sizes[*] = m_values.dim1Size()

Paramètres

src	Le répertoire source.
file_name	Le nom du fichier (sans extension).

Renvoie: true Si le fichier a bien été lu.; false Si le fichier n'a pas pu être lu.

Implémente Arcane::ISimpleTableReaderWriter.

Définition à la ligne 41 du fichier SimpleCsvReaderWriter.cc.

Références clearInternal(), et fileType().

Référencé par Arcane::SimpleCsvComparatorService::readReferenceFile().

◆ setFixed()

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

overridevirtual

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

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

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::ISimpleTableReaderWriter.

Définition à la ligne 184 du fichier SimpleCsvReaderWriter.cc.

◆ setForcedToUseScientificNotation()

void Arcane::SimpleCsvReaderWriter::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::ISimpleTableReaderWriter.

Définition à la ligne 196 du fichier SimpleCsvReaderWriter.cc.

◆ setInternal()

void Arcane::SimpleCsvReaderWriter::setInternal ( const Ref< SimpleTableInternal > & simple_table_internal )

overridevirtual

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

Paramètres

simple_table_internal La référence vers un SimpleTableInternal.

Implémente Arcane::ISimpleTableReaderWriter.

Définition à la ligne 211 du fichier SimpleCsvReaderWriter.cc.

Références ARCANE_FATAL.

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

◆ setPrecision()

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

overridevirtual

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

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

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::ISimpleTableReaderWriter.

Définition à la ligne 167 du fichier SimpleCsvReaderWriter.cc.

Références precision().

◆ writeTable()

bool Arcane::SimpleCsvReaderWriter::writeTable	(	const Directory &	dst,
		const String &	file_name
	)

overridevirtual

Méthode permettant d'écrire un tableau simple dans un fichier.

L'extension sera ajouté par l'implémentation.

Le répertoire de destination sera créé par l'implémentation s'il n'existe pas.

Les élements de SimpleTableInternal qui doivent impérativement être écrits sont :

les noms des lignes (m_row_names),
les noms des colonnes (m_column_names),
le nom du tableau (m_table_name),
les valeurs du tableau (m_values).

Les autres élements de SimpleTableInternal ne sont pas obligatoire.

Paramètres

dst	Le répertoire de destination.
file_name	Le nom du fichier (sans extension).

Renvoie: true Si le fichier a bien été écrit.; false Si le fichier n'a pas pu être écrit.

Implémente Arcane::ISimpleTableReaderWriter.

Définition à la ligne 28 du fichier SimpleCsvReaderWriter.cc.

Références fileType().

Documentation des données membres

◆ m_is_fixed_print

bool Arcane::SimpleCsvReaderWriter::m_is_fixed_print

protected

Définition à la ligne 91 du fichier SimpleCsvReaderWriter.h.

◆ m_output_file_type

const String Arcane::SimpleCsvReaderWriter::m_output_file_type = "csv"

protected

Définition à la ligne 94 du fichier SimpleCsvReaderWriter.h.

◆ m_precision_print

Integer Arcane::SimpleCsvReaderWriter::m_precision_print

protected

Définition à la ligne 90 du fichier SimpleCsvReaderWriter.h.

◆ m_scientific_notation

bool Arcane::SimpleCsvReaderWriter::m_scientific_notation

protected

Définition à la ligne 92 du fichier SimpleCsvReaderWriter.h.

◆ m_separator

char Arcane::SimpleCsvReaderWriter::m_separator

protected

Définition à la ligne 88 du fichier SimpleCsvReaderWriter.h.

◆ m_simple_table_internal

Ref<SimpleTableInternal> Arcane::SimpleCsvReaderWriter::m_simple_table_internal

protected

Définition à la ligne 86 du fichier SimpleCsvReaderWriter.h.

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

Fonctions membres publiques

Fonctions membres protégées

Attributs protégés

Description détaillée

Documentation des constructeurs et destructeur

◆ SimpleCsvReaderWriter() [1/2]

◆ SimpleCsvReaderWriter() [2/2]

Documentation des fonctions membres

◆ _closeFile()

◆ _openFile()

◆ _print()

◆ clearInternal()

◆ fileType()

◆ internal()

◆ isFixed()

◆ isForcedToUseScientificNotation()

◆ precision()

◆ print()

◆ readTable()

◆ setFixed()

◆ setForcedToUseScientificNotation()

◆ setInternal()

◆ setPrecision()

◆ writeTable()

Documentation des données membres

◆ m_is_fixed_print

◆ m_output_file_type

◆ m_precision_print

◆ m_scientific_notation

◆ m_separator

◆ m_simple_table_internal