Interface représentant une sortie de tableau simple. Plus de détails...

#include <arcane/core/ISimpleTableOutput.h>

Graphe de collaboration de Arcane::ISimpleTableOutput:

Fonctions membres publiques
virtual bool	init ()=0
	Méthode permettant d'initialiser le tableau.

virtual bool	init (const String &table_name)=0
	Méthode permettant d'initialiser le tableau.

virtual bool	init (const String &table_name, const String &directory_name)=0
	Méthode permettant d'initialiser le tableau.

virtual void	clear ()=0
	Méthode permettant de remettre à zéro les tableaux.

virtual Integer	addRow (const String &row_name)=0
	Méthode permettant d'ajouter une ligne.

virtual Integer	addRow (const String &row_name, ConstArrayView< Real > elements)=0
	Méthode permettant d'ajouter une ligne.

virtual bool	addRows (StringConstArrayView rows_names)=0
	Méthode permettant d'ajouter plusieurs lignes.

virtual Integer	addColumn (const String &column_name)=0
	Méthode permettant d'ajouter une colonne.

virtual Integer	addColumn (const String &column_name, ConstArrayView< Real > elements)=0
	Méthode permettant d'ajouter une colonne.

virtual bool	addColumns (StringConstArrayView columns_names)=0
	Méthode permettant d'ajouter plusieurs colonnes.

virtual bool	addElementInRow (Integer position, Real element)=0
	Méthode permettant d'ajouter un élément à une ligne.

virtual bool	addElementInRow (const String &row_name, Real element, bool create_if_not_exist=true)=0
	Méthode permettant l'ajouter un élément sur une ligne.

virtual bool	addElementInSameRow (Real element)=0
	Méthode permettant d'ajouter un élément sur la ligne dernièrement manipulée.

virtual bool	addElementsInRow (Integer position, ConstArrayView< Real > elements)=0
	Méthode permettant d'ajouter plusieurs éléments sur une ligne.

virtual bool	addElementsInRow (const String &row_name, ConstArrayView< Real > elements, bool create_if_not_exist=true)=0
	Méthode permettant d'ajouter plusieurs éléments sur une ligne.

virtual bool	addElementsInSameRow (ConstArrayView< Real > elements)=0
	Méthode permettant d'ajouter plusieurs éléments sur la ligne dernièrement manipulée.

virtual bool	addElementInColumn (Integer position, Real element)=0
	Méthode permettant d'ajouter un élément à une colonne.

virtual bool	addElementInColumn (const String &column_name, Real element, bool create_if_not_exist=true)=0
	Méthode permettant l'ajouter un élément sur une colonne.

virtual bool	addElementInSameColumn (Real element)=0
	Méthode permettant d'ajouter un élément sur la colonne dernièrement manipulée.

virtual bool	addElementsInColumn (Integer position, ConstArrayView< Real > elements)=0
	Méthode permettant d'ajouter plusieurs éléments sur une colonne.

virtual bool	addElementsInColumn (const String &column_name, ConstArrayView< Real > elements, bool create_if_not_exist=true)=0
	Méthode permettant d'ajouter plusieurs éléments sur une colonne.

virtual bool	addElementsInSameColumn (ConstArrayView< Real > elements)=0
	Méthode permettant d'ajouter plusieurs éléments sur la colonne dernièrement manipulée.

virtual bool	editElementUp (Real element, bool update_last_position=true)=0
	Méthode permettant d'éditer un élément au-dessus du dernier élement dernièrement manipulé (ligne du dessus/même colonne).

virtual bool	editElementDown (Real element, bool update_last_position=true)=0
	Méthode permettant d'éditer un élément en-dessous du dernier élement dernièrement manipulé (ligne du dessous/même colonne).

virtual bool	editElementLeft (Real element, bool update_last_position=true)=0
	Méthode permettant d'éditer un élément à gauche du dernier élement dernièrement manipulé (même ligne/colonne à gauche).

virtual bool	editElementRight (Real element, bool update_last_position=true)=0
	Méthode permettant d'éditer un élément à droite du dernier élement dernièrement manipulé (même ligne/colonne à droite).

virtual Real	elementUp (bool update_last_position=false)=0
	Méthode permettant de récupérer un élément au-dessus du dernier élement dernièrement manipulé (ligne du dessus/même colonne).

virtual Real	elementDown (bool update_last_position=false)=0
	Méthode permettant de récupérer un élément en-dessous du dernier élement dernièrement manipulé (ligne du dessous/même colonne).

virtual Real	elementLeft (bool update_last_position=false)=0
	Méthode permettant de récupérer un élément à gauche du dernier élement dernièrement manipulé (même ligne/colonne à gauche).

virtual Real	elementRight (bool update_last_position=false)=0
	Méthode permettant de récupérer un élément à droite du dernier élement dernièrement manipulé (même ligne/colonne à droite).

virtual bool	editElement (Real element)=0
	Méthode permettant de modifier un élement dans le tableau.

virtual bool	editElement (Integer position_x, Integer position_y, Real element)=0
	Méthode permettant de modifier un élement dans le tableau.

virtual bool	editElement (const String &column_name, const String &row_name, Real element)=0
	Méthode permettant de modifier un élement dans le tableau.

virtual Real	element ()=0
	Méthode permettant d'obtenir une copie d'un élement.

virtual Real	element (Integer position_x, Integer position_y, bool update_last_position=false)=0
	Méthode permettant d'obtenir une copie d'un élement.

virtual Real	element (const String &column_name, const String &row_name, bool update_last_position=false)=0
	Méthode permettant d'obtenir une copie d'un élement.

virtual RealUniqueArray	row (Integer position)=0
	Méthode permettant d'obtenir une copie d'une ligne.

virtual RealUniqueArray	row (const String &row_name)=0
	Méthode permettant d'obtenir une copie d'une ligne.

virtual RealUniqueArray	column (Integer position)=0
	Méthode permettant d'obtenir une copie d'une colonne.

virtual RealUniqueArray	column (const String &column_name)=0
	Méthode permettant d'obtenir une copie d'une colonne.

virtual Integer	rowSize (Integer position)=0
	Méthode permettant d'obtenir la taille d'une ligne. Incluant les hypothétiques 'trous' dans la ligne.

virtual Integer	rowSize (const String &row_name)=0
	Méthode permettant d'obtenir la taille d'une ligne. Incluant les hypotétiques 'trous' dans la ligne.

virtual Integer	columnSize (Integer position)=0
	Méthode permettant d'obtenir la taille d'une colonne. Incluant les hypotétiques 'trous' dans la colonne.

virtual Integer	columnSize (const String &column_name)=0
	Méthode permettant d'obtenir la taille d'une colonne. Incluant les hypotétiques 'trous' dans la colonne.

virtual Integer	rowPosition (const String &row_name)=0
	Méthode permettant de récupérer la position d'une ligne.

virtual Integer	columnPosition (const String &column_name)=0
	Méthode permettant de récupérer la position d'une colonne.

virtual Integer	numberOfRows ()=0
	Méthode permettant de récupérer le nombre de lignes dans le tableau. C'est, en quelque sorte, le nombre max d'élements que peut contenir une colonne.

virtual Integer	numberOfColumns ()=0
	Méthode permettant de récupérer le nombre de colonnes dans le tableau. C'est, en quelque sorte, le nombre max d'élements que peut contenir une ligne.

virtual String	rowName (Integer position)=0

virtual String	columnName (Integer position)=0

virtual bool	editRowName (Integer position, const String &new_name)=0
	Méthode permettant de changer le nom d'une ligne.

virtual bool	editRowName (const String &row_name, const String &new_name)=0
	Méthode permettant de changer le nom d'une ligne.

virtual bool	editColumnName (Integer position, const String &new_name)=0
	Méthode permettant de changer le nom d'une colonne.

virtual bool	editColumnName (const String &column_name, const String &new_name)=0
	Méthode permettant de changer le nom d'une colonne.

virtual Integer	addAverageColumn (const String &column_name)=0
	Méthode permettant de créer une colonne contenant la moyenne des éléments de chaque ligne.

virtual void	print (Integer rank=0)=0
	Méthode permettant d'afficher le tableau. Méthode effectuant des opérations collectives.

virtual bool	writeFile (const Directory &root_directory, Integer rank)=0

virtual bool	writeFile (Integer rank=-1)=0
	Méthode permettant d'écrire le tableau dans un fichier. Méthode effectuant des opérations collectives. Si rank != -1, les processus autres que P0 retournent true.

virtual bool	writeFile (const String &directory, Integer rank=-1)=0
	Méthode permettant d'écrire le tableau dans un fichier. Méthode effectuant des opérations collectives. Si rank != -1, les processus autres que P0 retournent true.

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

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

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

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

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

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

virtual String	outputDirectory ()=0
	Accesseur permettant de récupérer le nom du répertoire où sera placé les tableaux.

virtual void	setOutputDirectory (const String &directory)=0
	Accesseur permettant de définir le répertoire dans lequel enregistrer les tableaux.

virtual String	tableName ()=0
	Accesseur permettant de récupérer le nom des tableaux.

virtual void	setTableName (const String &name)=0
	Accesseur permettant de définir le nom du tableau.

virtual String	fileName ()=0
	Accesseur permettant de récupérer le nom des fichiers.

virtual Directory	outputPath ()=0
	Accesseur permettant de récupérer le chemin où sera enregistrés les tableaux.

virtual Directory	rootPath ()=0
	Accesseur permettant de récupérer le chemin où l'implémentation enregistre ces tableaux.

virtual bool	isOneFileByRanksPermited ()=0
	Méthode permettant de savoir si les paramètres actuellement en possession de l'implémentation lui permet d'écrire un fichier par processus.

virtual String	fileType ()=0
	Méthode permettant de connaitre le type de fichier du service.

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

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

Description détaillée

Interface représentant une sortie de tableau simple.

Définition à la ligne 36 du fichier ISimpleTableOutput.h.

Documentation des fonctions membres

◆ addAverageColumn()

virtual Integer Arcane::ISimpleTableOutput::addAverageColumn ( const String & column_name )

pure virtual

Méthode permettant de créer une colonne contenant la moyenne des éléments de chaque ligne.

Paramètres

column_name Le nom de la nouvelle colonne.

Renvoie: Integer La position de la colonne.

◆ addColumn() [1/2]

virtual Integer Arcane::ISimpleTableOutput::addColumn ( const String & column_name )

pure virtual

Méthode permettant d'ajouter une colonne.

Paramètres

column_name Le nom de la colonne.

Renvoie: Integer La position de la colonne dans le tableau.

◆ addColumn() [2/2]

virtual Integer Arcane::ISimpleTableOutput::addColumn	(	const String &	column_name,
		ConstArrayView< Real >	elements
	)

pure virtual

Méthode permettant d'ajouter une colonne.

Si le nombre d'élements dans 'elements' est plus grand que le nombre de lignes, l'ajout s'effectue quand même (mais les éléments en trop ne seront pas ajoutés).

Paramètres

column_name	Le nom de la colonne.
elements	Les éléments à ajouter sur la colonne.

Renvoie: Integer La position de la colonne dans le tableau.

◆ addColumns()

virtual bool Arcane::ISimpleTableOutput::addColumns ( StringConstArrayView columns_names )

pure virtual

Méthode permettant d'ajouter plusieurs colonnes.

Paramètres

rows_names Les noms des colonnes.

Renvoie: true Si toutes les colonnes ont été créées.; false Si toutes les colonnes n'ont pas été créées.

◆ addElementInColumn() [1/2]

virtual bool Arcane::ISimpleTableOutput::addElementInColumn	(	const String &	column_name,
		Real	element,
		bool	create_if_not_exist = `true`
	)

pure virtual

Méthode permettant l'ajouter un élément sur une colonne.

Paramètres

column_name	Le nom de la colonne.
element	L'élément à ajouter.
create_if_not_exist	Pour savoir si l'on doit créer la colonne si elle n'existe pas encore.

Renvoie: true Si l'élément a pu être ajouté.; false Si l'élément n'a pas pu être ajouté.

◆ addElementInColumn() [2/2]

virtual bool Arcane::ISimpleTableOutput::addElementInColumn	(	Integer	position,
		Real	element
	)

pure virtual

Méthode permettant d'ajouter un élément à une colonne.

Paramètres

position	La position de la colonne.
element	L'élément à ajouter.

Renvoie: true Si l'élément a pu être ajouté.; false Si l'élément n'a pas pu être ajouté.

◆ addElementInRow() [1/2]

virtual bool Arcane::ISimpleTableOutput::addElementInRow	(	const String &	row_name,
		Real	element,
		bool	create_if_not_exist = `true`
	)

pure virtual

Méthode permettant l'ajouter un élément sur une ligne.

Paramètres

row_name	Le nom de la ligne.
element	L'élément à ajouter.
create_if_not_exist	Pour savoir si l'on doit créer la ligne si elle n'existe pas encore.

Renvoie: true Si l'élément a pu être ajouté.; false Si l'élément n'a pas pu être ajouté.

◆ addElementInRow() [2/2]

virtual bool Arcane::ISimpleTableOutput::addElementInRow	(	Integer	position,
		Real	element
	)

pure virtual

Méthode permettant d'ajouter un élément à une ligne.

Paramètres

position	La position de la ligne.
element	L'élément à ajouter.

Renvoie: true Si l'élément a pu être ajouté.; false Si l'élément n'a pas pu être ajouté.

◆ addElementInSameColumn()

virtual bool Arcane::ISimpleTableOutput::addElementInSameColumn ( Real element )

pure virtual

Méthode permettant d'ajouter un élément sur la colonne dernièrement manipulée.

Cette méthode diffère de 'editElementDown()' car ici, on ajoute un élément à la fin de la colonne, pas forcement après le dernier élement ajouté.

Paramètres

element L'élément à ajouter.

Renvoie: true Si l'élément a été ajouté.; false Si l'élément n'a pas pu être ajouté.

◆ addElementInSameRow()

virtual bool Arcane::ISimpleTableOutput::addElementInSameRow ( Real element )

pure virtual

Méthode permettant d'ajouter un élément sur la ligne dernièrement manipulée.

Cette méthode diffère de 'editElementRight()' car ici, on ajoute un élément à la fin de la ligne, pas forcement après le dernier élement ajouté.

Paramètres

element L'élément à ajouter.

Renvoie: true Si l'élément a été ajouté.; false Si l'élément n'a pas pu être ajouté.

◆ addElementsInColumn() [1/2]

virtual bool Arcane::ISimpleTableOutput::addElementsInColumn	(	const String &	column_name,
		ConstArrayView< Real >	elements,
		bool	create_if_not_exist = `true`
	)

pure virtual

Méthode permettant d'ajouter plusieurs éléments sur une colonne.

Si le nombre d'élements dans 'elements' est plus grand que le nombre de lignes disponibles, l'ajout s'effectue quand même (mais les éléments en trop ne seront pas ajoutés) et on aura un return false.

Paramètres

column_name	Le nom de la colonne.
elements	Le tableau d'élement à ajouter.
create_if_not_exist	Pour savoir si l'on doit créer la colonne si elle n'existe pas encore.

Renvoie: true Si tous les éléments ont été ajoutés.; false Si [0;len(elements)[ éléments ont été ajoutés.

◆ addElementsInColumn() [2/2]

virtual bool Arcane::ISimpleTableOutput::addElementsInColumn	(	Integer	position,
		ConstArrayView< Real >	elements
	)

pure virtual

Méthode permettant d'ajouter plusieurs éléments sur une colonne.

Si le nombre d'élements dans 'elements' est plus grand que le nombre de lignes disponibles, l'ajout s'effectue quand même (mais les éléments en trop ne seront pas ajoutés) et on aura un return false.

Paramètres

position	La position de la colonne.
elements	Le tableau d'élement à ajouter.

Renvoie: true Si tous les éléments ont été ajoutés.; false Si [0;len(elements)[ éléments ont été ajoutés.

◆ addElementsInRow() [1/2]

virtual bool Arcane::ISimpleTableOutput::addElementsInRow	(	const String &	row_name,
		ConstArrayView< Real >	elements,
		bool	create_if_not_exist = `true`
	)

pure virtual

Méthode permettant d'ajouter plusieurs éléments sur une ligne.

Si le nombre d'élements dans 'elements' est plus grand que le nombre de colonnes disponibles, l'ajout s'effectue quand même (mais les éléments en trop ne seront pas ajoutés) et on aura un return false.

Paramètres

row_name	Le nom de la ligne.
elements	Le tableau d'élement à ajouter.
create_if_not_exist	Pour savoir si l'on doit créer la ligne si elle n'existe pas encore.

Renvoie: true Si tous les éléments ont été ajoutés.; false Si [0;len(elements)[ éléments ont été ajoutés.

◆ addElementsInRow() [2/2]

virtual bool Arcane::ISimpleTableOutput::addElementsInRow	(	Integer	position,
		ConstArrayView< Real >	elements
	)

pure virtual

Méthode permettant d'ajouter plusieurs éléments sur une ligne.

Si le nombre d'élements dans 'elements' est plus grand que le nombre de colonnes disponibles, l'ajout s'effectue quand même (mais les éléments en trop ne seront pas ajoutés) et on aura un return false.

Paramètres

position	La position de la ligne.
elements	Le tableau d'élement à ajouter.

Renvoie: true Si tous les éléments ont été ajoutés.; false Si [0;len(elements)[ éléments ont été ajoutés.

◆ addElementsInSameColumn()

virtual bool Arcane::ISimpleTableOutput::addElementsInSameColumn ( ConstArrayView< Real > elements )

pure virtual

Méthode permettant d'ajouter plusieurs éléments sur la colonne dernièrement manipulée.

Si le nombre d'élements dans 'elements' est plus grand que le nombre de lignes disponibles, l'ajout s'effectue quand même (mais les éléments en trop ne seront pas ajoutés) et on aura un return false.

Mis à part le fait qu'ici, on manipule un tableau, cette méthode diffère de 'editElementDown()' car ici, on ajoute des éléments à la fin de la colonne, pas forcement après le dernier élement ajouté.

Paramètres

elements Le tableau d'élement à ajouter.

Renvoie: true Si tous les éléments ont été ajoutés.; false Si [0;len(elements)[ éléments ont été ajoutés.

◆ addElementsInSameRow()

virtual bool Arcane::ISimpleTableOutput::addElementsInSameRow ( ConstArrayView< Real > elements )

pure virtual

Méthode permettant d'ajouter plusieurs éléments sur la ligne dernièrement manipulée.

Si le nombre d'élements dans 'elements' est plus grand que le nombre de colonnes disponibles, l'ajout s'effectue quand même (mais les éléments en trop ne seront pas ajoutés) et on aura un return false.

Mis à part le fait qu'ici, on manipule un tableau, cette méthode diffère de 'editElementRight()' car ici, on ajoute des éléments à la fin de la ligne, pas forcement après le dernier élement ajouté.

Paramètres

elements Le tableau d'élement à ajouter.

Renvoie: true Si tous les éléments ont été ajoutés.; false Si [0;len(elements)[ éléments ont été ajoutés.

◆ addRow() [1/2]

virtual Integer Arcane::ISimpleTableOutput::addRow ( const String & row_name )

pure virtual

Méthode permettant d'ajouter une ligne.

Paramètres

row_name Le nom de la ligne.

Renvoie: Integer La position de la ligne dans le tableau.

◆ addRow() [2/2]

virtual Integer Arcane::ISimpleTableOutput::addRow	(	const String &	row_name,
		ConstArrayView< Real >	elements
	)

pure virtual

Méthode permettant d'ajouter une ligne.

Si le nombre d'élements dans 'elements' est plus grand que le nombre de colonnes, l'ajout s'effectue quand même (mais les éléments en trop ne seront pas ajoutés).

Paramètres

row_name	Le nom de la ligne.
elements	Les éléments à insérer sur la ligne.

Renvoie: Integer La position de la ligne dans le tableau.

◆ addRows()

virtual bool Arcane::ISimpleTableOutput::addRows ( StringConstArrayView rows_names )

pure virtual

Méthode permettant d'ajouter plusieurs lignes.

Paramètres

rows_names Les noms des lignes.

Renvoie: true Si toutes les lignes ont été créées.; false Si toutes les lignes n'ont pas été créées.

◆ column() [1/2]

virtual RealUniqueArray Arcane::ISimpleTableOutput::column ( const String & column_name )

pure virtual

Méthode permettant d'obtenir une copie d'une colonne.

Paramètres

column_name Le nom de la colonne.

Renvoie: RealUniqueArray La copie de la colonne (tableau vide si non trouvée).

◆ column() [2/2]

virtual RealUniqueArray Arcane::ISimpleTableOutput::column ( Integer position )

pure virtual

Méthode permettant d'obtenir une copie d'une colonne.

Paramètres

position La position de la colonne.

Renvoie: RealUniqueArray La copie de la colonne (tableau vide si non trouvée).

◆ columnPosition()

virtual Integer Arcane::ISimpleTableOutput::columnPosition ( const String & column_name )

pure virtual

Méthode permettant de récupérer la position d'une colonne.

Paramètres

row_name Le nom de la colonne.

Renvoie: Integer La position de la colonne (-1 si non trouvée).

◆ columnSize() [1/2]

virtual Integer Arcane::ISimpleTableOutput::columnSize ( const String & column_name )

pure virtual

Méthode permettant d'obtenir la taille d'une colonne. Incluant les hypotétiques 'trous' dans la colonne.

Paramètres

position Le nom de la colonne.

Renvoie: Integer La taille de la colonne (0 si non trouvée).

◆ columnSize() [2/2]

virtual Integer Arcane::ISimpleTableOutput::columnSize ( Integer position )

pure virtual

Méthode permettant d'obtenir la taille d'une colonne. Incluant les hypotétiques 'trous' dans la colonne.

Paramètres

position La position de la colonne.

Renvoie: Integer La taille de la colonne (0 si non trouvée).

◆ editColumnName() [1/2]

virtual bool Arcane::ISimpleTableOutput::editColumnName	(	const String &	column_name,
		const String &	new_name
	)

pure virtual

Méthode permettant de changer le nom d'une colonne.

Paramètres

column_name	Le nom actuel de la colonne.
new_name	Le nouveau nom de la colonne.

Renvoie: true Si le changement a eu lieu.; false Si le changement n'a pas eu lieu.

◆ editColumnName() [2/2]

virtual bool Arcane::ISimpleTableOutput::editColumnName	(	Integer	position,
		const String &	new_name
	)

pure virtual

Méthode permettant de changer le nom d'une colonne.

Paramètres

position	La position de la colonne.
new_name	Le nouveau nom de la colonne.

Renvoie: true Si le changement a eu lieu.; false Si le changement n'a pas eu lieu.

◆ editElement() [1/3]

virtual bool Arcane::ISimpleTableOutput::editElement	(	const String &	column_name,
		const String &	row_name,
		Real	element
	)

pure virtual

Méthode permettant de modifier un élement dans le tableau.

Paramètres

column_name	Le nom de la colonne où se trouve l'élement.
row_name	Le nom de la ligne où se trouve l'élement.
element	L'élement remplaçant.

Renvoie: true Si l'élement a bien été remplacé.; false Si l'élement n'a pas pu être remplacé.

◆ editElement() [2/3]

virtual bool Arcane::ISimpleTableOutput::editElement	(	Integer	position_x,
		Integer	position_y,
		Real	element
	)

pure virtual

Méthode permettant de modifier un élement dans le tableau.

Paramètres

position_x	La position de la colonne à modifier.
position_y	La position de la ligne à modifier.
element	L'élement remplaçant.

Renvoie: true Si l'élement a bien été remplacé.; false Si l'élement n'a pas été remplacé.

◆ editElement() [3/3]

virtual bool Arcane::ISimpleTableOutput::editElement ( Real element )

pure virtual

Méthode permettant de modifier un élement dans le tableau.

Les positions x et y correspondent à l'emplacement du dernier élement manipulé.

Cette méthode a de l'intéret après l'utilisation de 'elemUDLR(true)' par exemple.

Paramètres

element L'élement remplaçant.

Renvoie: true Si l'élement a bien été remplacé.; false Si l'élement n'a pas été remplacé.

◆ editElementDown()

virtual bool Arcane::ISimpleTableOutput::editElementDown	(	Real	element,
		bool	update_last_position = `true`
	)

pure virtual

Méthode permettant d'éditer un élément en-dessous du dernier élement dernièrement manipulé (ligne du dessous/même colonne).

L'élement que l'on modifie devient donc le dernier élement modifié à la fin de cette méthode (si update_last_position = true).

Cette méthode diffère de 'addElementInSameColumn()' car ici, on ajoute (ou modifie) un élement sous le dernier élement manipulé, qui n'est pas forcement à la fin de la colonne.

Paramètres

element	L'élement à modifier.
update_last_position	Doit-on déplacer le curseur "dernier élement modifié" ?

Renvoie: true Si l'élément a été modifié.; false Si l'élément n'a pas pu être modifié.

◆ editElementLeft()

virtual bool Arcane::ISimpleTableOutput::editElementLeft	(	Real	element,
		bool	update_last_position = `true`
	)

pure virtual

Méthode permettant d'éditer un élément à gauche du dernier élement dernièrement manipulé (même ligne/colonne à gauche).

L'élement que l'on modifie devient donc le dernier élement modifié à la fin de cette méthode (si update_last_position = true).

Paramètres

element	L'élement à modifier.
update_last_position	Doit-on déplacer le curseur "dernier élement modifié" ?

Renvoie: true Si l'élément a été modifié.; false Si l'élément n'a pas pu être modifié.

◆ editElementRight()

virtual bool Arcane::ISimpleTableOutput::editElementRight	(	Real	element,
		bool	update_last_position = `true`
	)

pure virtual

Méthode permettant d'éditer un élément à droite du dernier élement dernièrement manipulé (même ligne/colonne à droite).

L'élement que l'on modifie devient donc le dernier élement modifié à la fin de cette méthode (si update_last_position = true).

Cette méthode diffère de 'addElementInSameRow()' car ici, on ajoute (ou modifie) un élement à la droite du dernier élement manipulé, qui n'est pas forcement à la fin de la colonne.

Paramètres

element	L'élement à modifier.
update_last_position	Doit-on déplacer le curseur "dernier élement modifié" ?

Renvoie: true Si l'élément a été modifié.; false Si l'élément n'a pas pu être modifié.

◆ editElementUp()

virtual bool Arcane::ISimpleTableOutput::editElementUp	(	Real	element,
		bool	update_last_position = `true`
	)

pure virtual

Méthode permettant d'éditer un élément au-dessus du dernier élement dernièrement manipulé (ligne du dessus/même colonne).

L'élement que l'on modifie devient donc le dernier élement modifié à la fin de cette méthode (si update_last_position = true).

Paramètres

element	L'élement à modifier.
update_last_position	Doit-on déplacer le curseur "dernier élement modifié" ?

Renvoie: true Si l'élément a été modifié.; false Si l'élément n'a pas pu être modifié.

◆ editRowName() [1/2]

virtual bool Arcane::ISimpleTableOutput::editRowName	(	const String &	row_name,
		const String &	new_name
	)

pure virtual

Méthode permettant de changer le nom d'une ligne.

Paramètres

row_name	Le nom actuel de la ligne.
new_name	Le nouveau nom de la ligne.

Renvoie: true Si le changement a eu lieu.; false Si le changement n'a pas eu lieu.

◆ editRowName() [2/2]

virtual bool Arcane::ISimpleTableOutput::editRowName	(	Integer	position,
		const String &	new_name
	)

pure virtual

Méthode permettant de changer le nom d'une ligne.

Paramètres

position	La position de la ligne.
new_name	Le nouveau nom de la ligne.

Renvoie: true Si le changement a eu lieu.; false Si le changement n'a pas eu lieu.

◆ element() [1/3]

virtual Real Arcane::ISimpleTableOutput::element ( )

pure virtual

Méthode permettant d'obtenir une copie d'un élement.

Les positions x et y correspondent à l'emplacement du dernier élement manipulé.

Renvoie: Real L'élement trouvé (0 si non trouvé).

◆ element() [2/3]

virtual Real Arcane::ISimpleTableOutput::element	(	const String &	column_name,
		const String &	row_name,
		bool	update_last_position = `false`
	)

pure virtual

Méthode permettant d'obtenir une copie d'un élement.

Paramètres

column_name	Le nom de la colonne où se trouve l'élement.
row_name	Le nom de la ligne où se trouve l'élement.
update_last_position	Doit-on déplacer le curseur "dernier élement modifié" ?

Renvoie: Real L'élement trouvé (0 si non trouvé).

◆ element() [3/3]

virtual Real Arcane::ISimpleTableOutput::element	(	Integer	position_x,
		Integer	position_y,
		bool	update_last_position = `false`
	)

pure virtual

Méthode permettant d'obtenir une copie d'un élement.

Paramètres

position_x	La position de la colonne où se trouve l'élement.
position_y	La position de la ligne où se trouve l'élement.
update_last_position	Doit-on déplacer le curseur "dernier élement modifié" ?

Renvoie: Real L'élement trouvé (0 si non trouvé).

◆ elementDown()

virtual Real Arcane::ISimpleTableOutput::elementDown ( bool update_last_position = false )

pure virtual

Méthode permettant de récupérer un élément en-dessous du dernier élement dernièrement manipulé (ligne du dessous/même colonne).

L'élement que l'on récupère devient donc le dernier élement "modifié" à la fin de cette méthode (si update_last_position = true).

Paramètres

update_last_position Doit-on déplacer le curseur "dernier élement modifié" ?

Renvoie: Real L'élement trouvé (0 si non trouvé).

◆ elementLeft()

virtual Real Arcane::ISimpleTableOutput::elementLeft ( bool update_last_position = false )

pure virtual

Méthode permettant de récupérer un élément à gauche du dernier élement dernièrement manipulé (même ligne/colonne à gauche).

L'élement que l'on récupère devient donc le dernier élement "modifié" à la fin de cette méthode (si update_last_position = true).

Paramètres

update_last_position Doit-on déplacer le curseur "dernier élement modifié" ?

Renvoie: Real L'élement trouvé (0 si non trouvé).

◆ elementRight()

virtual Real Arcane::ISimpleTableOutput::elementRight ( bool update_last_position = false )

pure virtual

Méthode permettant de récupérer un élément à droite du dernier élement dernièrement manipulé (même ligne/colonne à droite).

L'élement que l'on récupère devient donc le dernier élement "modifié" à la fin de cette méthode (si update_last_position = true).

Paramètres

update_last_position Doit-on déplacer le curseur "dernier élement modifié" ?

Renvoie: Real L'élement trouvé (0 si non trouvé).

◆ elementUp()

virtual Real Arcane::ISimpleTableOutput::elementUp ( bool update_last_position = false )

pure virtual

Méthode permettant de récupérer un élément au-dessus du dernier élement dernièrement manipulé (ligne du dessus/même colonne).

L'élement que l'on récupère devient donc le dernier élement "modifié" à la fin de cette méthode (si update_last_position = true).

Paramètres

update_last_position Doit-on déplacer le curseur "dernier élement modifié" ?

Renvoie: Real L'élement trouvé (0 si non trouvé).

◆ fileName()

virtual String Arcane::ISimpleTableOutput::fileName ( )

pure virtual

Accesseur permettant de récupérer le nom des fichiers.

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

Renvoie: String Le nom.

◆ fileType()

virtual String Arcane::ISimpleTableOutput::fileType ( )

pure virtual

Méthode permettant de connaitre le type de fichier du service.

Renvoie: String Le type de fichier.

◆ init() [1/2]

virtual bool Arcane::ISimpleTableOutput::init ( const String & table_name )

pure virtual

Méthode permettant d'initialiser le tableau.

Paramètres

table_name Le nom du tableau (et du fichier de sortie).

◆ init() [2/2]

virtual bool Arcane::ISimpleTableOutput::init	(	const String &	table_name,
		const String &	directory_name
	)

pure virtual

Méthode permettant d'initialiser le tableau.

Paramètres

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

◆ internal()

virtual Ref< SimpleTableInternal > Arcane::ISimpleTableOutput::internal ( )

pure virtual

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.

◆ isFixed()

virtual bool Arcane::ISimpleTableOutput::isFixed ( )

pure virtual

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.

◆ isForcedToUseScientificNotation()

virtual bool Arcane::ISimpleTableOutput::isForcedToUseScientificNotation ( )

pure virtual

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.

◆ isOneFileByRanksPermited()

virtual bool Arcane::ISimpleTableOutput::isOneFileByRanksPermited ( )

pure virtual

Méthode permettant de savoir si les paramètres actuellement en possession de l'implémentation lui permet d'écrire un fichier par processus.

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.

◆ numberOfColumns()

virtual Integer Arcane::ISimpleTableOutput::numberOfColumns ( )

pure virtual

Méthode permettant de récupérer le nombre de colonnes dans le tableau. C'est, en quelque sorte, le nombre max d'élements que peut contenir une ligne.

Renvoie: Integer Le nombre de colonnes du tableau.

◆ numberOfRows()

virtual Integer Arcane::ISimpleTableOutput::numberOfRows ( )

pure virtual

Méthode permettant de récupérer le nombre de lignes dans le tableau. C'est, en quelque sorte, le nombre max d'élements que peut contenir une colonne.

Renvoie: Integer Le nombre de lignes du tableau.

◆ outputDirectory()

virtual String Arcane::ISimpleTableOutput::outputDirectory ( )

pure virtual

Accesseur 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).

Renvoie: String Le répertoire.

◆ outputPath()

virtual Directory Arcane::ISimpleTableOutput::outputPath ( )

pure virtual

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

En comparaison avec rootPathOutput(), le retour peut être different selon le "directory" et le "name".

Renvoie: String Le chemin.

◆ precision()

virtual Integer Arcane::ISimpleTableOutput::precision ( )

pure virtual

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

Renvoie: Integer La précision.

◆ print()

virtual void Arcane::ISimpleTableOutput::print ( Integer rank = 0 )

pure virtual

Méthode permettant d'afficher le tableau. Méthode effectuant des opérations collectives.

Paramètres

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

◆ readerWriter()

virtual Ref< ISimpleTableReaderWriter > Arcane::ISimpleTableOutput::readerWriter ( )

pure virtual

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.

◆ rootPath()

virtual Directory Arcane::ISimpleTableOutput::rootPath ( )

pure virtual

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

En comparaison avec pathOutput(), le retour ne dépend pas de "directory" ou de "name".

Renvoie: String Le chemin.

◆ row() [1/2]

virtual RealUniqueArray Arcane::ISimpleTableOutput::row ( const String & row_name )

pure virtual

Méthode permettant d'obtenir une copie d'une ligne.

Paramètres

row_name Le nom de la ligne.

Renvoie: RealUniqueArray La copie de la ligne (tableau vide si non trouvée).

◆ row() [2/2]

virtual RealUniqueArray Arcane::ISimpleTableOutput::row ( Integer position )

pure virtual

Méthode permettant d'obtenir une copie d'une ligne.

Paramètres

position La position de la ligne.

Renvoie: RealUniqueArray La copie de la ligne (tableau vide si non trouvée).

◆ rowPosition()

virtual Integer Arcane::ISimpleTableOutput::rowPosition ( const String & row_name )

pure virtual

Méthode permettant de récupérer la position d'une ligne.

Paramètres

row_name Le nom de la ligne.

Renvoie: Integer La position de la ligne (-1 si non trouvée).

◆ rowSize() [1/2]

virtual Integer Arcane::ISimpleTableOutput::rowSize ( const String & row_name )

pure virtual

Méthode permettant d'obtenir la taille d'une ligne. Incluant les hypotétiques 'trous' dans la ligne.

Paramètres

position Le nom de la ligne.

Renvoie: Integer La taille de la ligne (0 si non trouvée).

◆ rowSize() [2/2]

virtual Integer Arcane::ISimpleTableOutput::rowSize ( Integer position )

pure virtual

Méthode permettant d'obtenir la taille d'une ligne. Incluant les hypothétiques 'trous' dans la ligne.

Paramètres

position La position de la ligne.

Renvoie: Integer La taille de la ligne (0 si non trouvée).

◆ setFixed()

virtual void Arcane::ISimpleTableOutput::setFixed ( bool fixed )

pure virtual

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.

◆ setForcedToUseScientificNotation()

virtual void Arcane::ISimpleTableOutput::setForcedToUseScientificNotation ( bool use_scientific )

pure virtual

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.

◆ setOutputDirectory()

virtual void Arcane::ISimpleTableOutput::setOutputDirectory ( const String & directory )

pure virtual

Accesseur 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.

◆ setPrecision()

virtual void Arcane::ISimpleTableOutput::setPrecision ( Integer precision )

pure virtual

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.

◆ setTableName()

virtual void Arcane::ISimpleTableOutput::setTableName ( const String & name )

pure virtual

Accesseur permettant de définir le nom du tableau.

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

Paramètres

name Le nom.

◆ tableName()

virtual String Arcane::ISimpleTableOutput::tableName ( )

pure virtual

Accesseur permettant de récupérer le nom des tableaux.

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

Renvoie: String Le nom.

◆ writeFile() [1/2]

virtual bool Arcane::ISimpleTableOutput::writeFile	(	const String &	directory,
		Integer	rank = `-1`
	)

pure virtual

Méthode permettant d'écrire le tableau dans un fichier. Méthode effectuant des opérations collectives. Si rank != -1, les processus autres que P0 retournent true.

Paramètres

directory	Le répertoire où sera écrit le fichier . Le chemin final sera "./[output_dir]/csv/[directory]/"
rank	L'id du processus devant écrire dans un fichier le tableau (-1 pour signifier "tous les processus").

Renvoie: true Si le fichier a été correctement écrit.; false Si le fichier n'a pas été correctement écrit.

Obsolète:: Utiliser setOutputDirectory() puis writeFile() à la place.

◆ writeFile() [2/2]

virtual bool Arcane::ISimpleTableOutput::writeFile ( Integer rank = -1 )

pure virtual

Méthode permettant d'écrire le tableau dans un fichier. Méthode effectuant des opérations collectives. Si rank != -1, les processus autres que P0 retournent true.

Paramètres

rank	L'id du processus devant écrire dans un fichier le tableau (-1 pour signifier "tous les processus").

Renvoie: true Si le fichier a été correctement écrit.; false Si le fichier n'a pas été correctement écrit.

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

ISimpleTableOutput.h

Fonctions membres publiques

Description détaillée

Documentation des fonctions membres

◆ addAverageColumn()

◆ addColumn() [1/2]

◆ addColumn() [2/2]

◆ addColumns()

◆ addElementInColumn() [1/2]

◆ addElementInColumn() [2/2]

◆ addElementInRow() [1/2]

◆ addElementInRow() [2/2]

◆ addElementInSameColumn()

◆ addElementInSameRow()

◆ addElementsInColumn() [1/2]

◆ addElementsInColumn() [2/2]

◆ addElementsInRow() [1/2]

◆ addElementsInRow() [2/2]

◆ addElementsInSameColumn()

◆ addElementsInSameRow()

◆ addRow() [1/2]

◆ addRow() [2/2]

◆ addRows()

◆ column() [1/2]

◆ column() [2/2]

◆ columnPosition()

◆ columnSize() [1/2]

◆ columnSize() [2/2]

◆ editColumnName() [1/2]

◆ editColumnName() [2/2]

◆ editElement() [1/3]

◆ editElement() [2/3]

◆ editElement() [3/3]

◆ editElementDown()

◆ editElementLeft()

◆ editElementRight()

◆ editElementUp()

◆ editRowName() [1/2]

◆ editRowName() [2/2]

◆ element() [1/3]

◆ element() [2/3]

◆ element() [3/3]

◆ elementDown()

◆ elementLeft()

◆ elementRight()

◆ elementUp()

◆ fileName()

◆ fileType()

◆ init() [1/2]

◆ init() [2/2]

◆ internal()

◆ isFixed()

◆ isForcedToUseScientificNotation()

◆ isOneFileByRanksPermited()

◆ numberOfColumns()

◆ numberOfRows()

◆ outputDirectory()

◆ outputPath()

◆ precision()

◆ print()

◆ readerWriter()

◆ rootPath()

◆ row() [1/2]

◆ row() [2/2]

◆ rowPosition()

◆ rowSize() [1/2]

◆ rowSize() [2/2]

◆ setFixed()

◆ setForcedToUseScientificNotation()

◆ setOutputDirectory()

◆ setPrecision()

◆ setTableName()

◆ tableName()

◆ writeFile() [1/2]

◆ writeFile() [2/2]