Interface representing a simple table output. More...

#include <arcane/core/ISimpleTableOutput.h>

Inheritance diagram for Arcane::ISimpleTableOutput:

Collaboration diagram for Arcane::ISimpleTableOutput:

Public Member Functions
virtual bool	init ()=0
	Method to initialize the table.
virtual bool	init (const String &table_name)=0
	Method to initialize the table.
virtual bool	init (const String &table_name, const String &directory_name)=0
	Method to initialize the table.
virtual void	clear ()=0
	Method to clear the tables.
virtual Integer	addRow (const String &row_name)=0
	Method to add a row.
virtual Integer	addRow (const String &row_name, ConstArrayView< Real > elements)=0
	Method to add a row.
virtual bool	addRows (StringConstArrayView rows_names)=0
	Method to add multiple rows.
virtual Integer	addColumn (const String &column_name)=0
	Method to add a column.
virtual Integer	addColumn (const String &column_name, ConstArrayView< Real > elements)=0
	Method to add a column.
virtual bool	addColumns (StringConstArrayView columns_names)=0
	Method to add multiple columns.
virtual bool	addElementInRow (Integer position, Real element)=0
	Method to add an element to a row.
virtual bool	addElementInRow (const String &row_name, Real element, bool create_if_not_exist=true)=0
	Method to add an element to a row.
virtual bool	addElementInSameRow (Real element)=0
	Method to add an element to the last manipulated row.
virtual bool	addElementsInRow (Integer position, ConstArrayView< Real > elements)=0
	Method to add multiple elements to a row.
virtual bool	addElementsInRow (const String &row_name, ConstArrayView< Real > elements, bool create_if_not_exist=true)=0
	Method to add multiple elements to a row.
virtual bool	addElementsInSameRow (ConstArrayView< Real > elements)=0
	Method to add multiple elements to the last manipulated row.
virtual bool	addElementInColumn (Integer position, Real element)=0
	Method to add an element to a column.
virtual bool	addElementInColumn (const String &column_name, Real element, bool create_if_not_exist=true)=0
	Method to add an element to a column.
virtual bool	addElementInSameColumn (Real element)=0
	Method to add an element to the last manipulated column.
virtual bool	addElementsInColumn (Integer position, ConstArrayView< Real > elements)=0
	Method to add multiple elements to a column.
virtual bool	addElementsInColumn (const String &column_name, ConstArrayView< Real > elements, bool create_if_not_exist=true)=0
	Method to add multiple elements to a column.
virtual bool	addElementsInSameColumn (ConstArrayView< Real > elements)=0
	Method to add multiple elements to the last manipulated column.
virtual bool	editElementUp (Real element, bool update_last_position=true)=0
	Method to edit an element above the last element manipulated (row above/same column).
virtual bool	editElementDown (Real element, bool update_last_position=true)=0
	Method to edit an element below the last element manipulated (row below/same column).
virtual bool	editElementLeft (Real element, bool update_last_position=true)=0
	Method to edit an element to the left of the last element manipulated (same row/column to the left).
virtual bool	editElementRight (Real element, bool update_last_position=true)=0
	Method to edit an element to the right of the last element manipulated (same row/column to the right).
virtual Real	elementUp (bool update_last_position=false)=0
	Method to retrieve an element above the last element manipulated (row above/same column).
virtual Real	elementDown (bool update_last_position=false)=0
	Method to retrieve an element below the last element manipulated (row below/same column).
virtual Real	elementLeft (bool update_last_position=false)=0
	Method to retrieve an element to the left of the last element manipulated (same row/column to the left).
virtual Real	elementRight (bool update_last_position=false)=0
	Method to retrieve an element to the right of the last element manipulated (same row/column to the right).
virtual bool	editElement (Real element)=0
	Method to modify an element in the table.
virtual bool	editElement (Integer position_x, Integer position_y, Real element)=0
	Method to modify an element in the table.
virtual bool	editElement (const String &column_name, const String &row_name, Real element)=0
	Method allowing modification of an element in the array.
virtual Real	element ()=0
	Method allowing retrieval of a copy of an element.
virtual Real	element (Integer position_x, Integer position_y, bool update_last_position=false)=0
	Method allowing retrieval of a copy of an element.
virtual Real	element (const String &column_name, const String &row_name, bool update_last_position=false)=0
	Method allowing retrieval of a copy of an element.
virtual RealUniqueArray	row (Integer position)=0
	Method allowing retrieval of a copy of a row.
virtual RealUniqueArray	row (const String &row_name)=0
	Method allowing retrieval of a copy of a row.
virtual RealUniqueArray	column (Integer position)=0
	Method allowing retrieval of a copy of a column.
virtual RealUniqueArray	column (const String &column_name)=0
	Method allowing retrieval of a copy of a column.
virtual Integer	rowSize (Integer position)=0
	Method allowing retrieval of the size of a row. Including hypothetical 'gaps' in the row.
virtual Integer	rowSize (const String &row_name)=0
	Method allowing retrieval of the size of a row. Including hypothetical 'gaps' in the row.
virtual Integer	columnSize (Integer position)=0
	Method allowing retrieval of the size of a column. Including hypothetical 'gaps' in the column.
virtual Integer	columnSize (const String &column_name)=0
	Method allowing retrieval of the size of a column. Including hypothetical 'gaps' in the column.
virtual Integer	rowPosition (const String &row_name)=0
	Method allowing retrieval of the position of a row.
virtual Integer	columnPosition (const String &column_name)=0
	Method allowing retrieval of the position of a column.
virtual Integer	numberOfRows ()=0
	Method allowing retrieval of the number of rows in the array. This is, in a way, the maximum number of elements a column can contain.
virtual Integer	numberOfColumns ()=0
	Method allowing retrieval of the number of columns in the array. This is, in a way, the maximum number of elements a row can contain.
virtual String	rowName (Integer position)=0
virtual String	columnName (Integer position)=0
virtual bool	editRowName (Integer position, const String &new_name)=0
	Method allowing changing the name of a row.
virtual bool	editRowName (const String &row_name, const String &new_name)=0
	Method allowing changing the name of a row.
virtual bool	editColumnName (Integer position, const String &new_name)=0
	Method allowing changing the name of a column.
virtual bool	editColumnName (const String &column_name, const String &new_name)=0
	Method allowing changing the name of a column.
virtual Integer	addAverageColumn (const String &column_name)=0
	Method allowing creation of a column containing the average of the elements of each row.
virtual void	print (Integer rank=0)=0
	Method allowing display of the array. Method performing collective operations.
virtual bool	writeFile (const Directory &root_directory, Integer rank)=0
virtual bool	writeFile (Integer rank=-1)=0
	Method allowing writing the array to a file. Method performing collective operations. If rank != -1, processes other than P0 return true.
virtual bool	writeFile (const String &directory, Integer rank=-1)=0
	Method allowing writing the array to a file. Method performing collective operations. If rank != -1, processes other than P0 return true.
virtual Integer	precision ()=0
	Method allowing retrieval of the precision currently used for writing values.
virtual void	setPrecision (Integer precision)=0
	Method allowing modification of the print precision.
virtual bool	isFixed ()=0
	Method allowing knowledge of whether the 'std::fixed' flag is active or not for writing values.
virtual void	setFixed (bool fixed)=0
	Method allowing setting the 'std::fixed' flag or not.
virtual bool	isForcedToUseScientificNotation ()=0
	Method allowing knowledge of whether the 'std::scientific' flag is active or not for writing values.
virtual void	setForcedToUseScientificNotation (bool use_scientific)=0
	Method allowing setting the 'std::scientific' flag or not.
virtual String	outputDirectory ()=0
	Accessor allowing retrieval of the name of the directory where the arrays will be placed.
virtual void	setOutputDirectory (const String &directory)=0
	Accessor allowing definition of the directory in which the arrays will be saved.
virtual String	tableName ()=0
	Accessor allowing retrieval of the name of the arrays.
virtual void	setTableName (const String &name)=0
	Accessor allowing definition of the array name.
virtual String	fileName ()=0
	Accessor allowing retrieval of the file name.
virtual Directory	outputPath ()=0
	Accessor allowing retrieval of the path where the arrays will be saved.
virtual Directory	rootPath ()=0
	Accessor allowing retrieval of the path where the implementation saves these arrays.
virtual bool	isOneFileByRanksPermited ()=0
	Method allowing knowledge of whether the parameters currently held by the implementation allow it to write one file per process.
virtual String	fileType ()=0
	Method allowing knowledge of the service's file type.
virtual Ref< SimpleTableInternal >	internal ()=0
	Method allowing retrieval of a reference to the SimpleTableInternal object used.
virtual Ref< ISimpleTableReaderWriter >	readerWriter ()=0
	Method allowing retrieval of a reference to the ISimpleTableReaderWriter object used.

Detailed Description

Interface representing a simple table output.

Definition at line 33 of file ISimpleTableOutput.h.

Member Function Documentation

◆ addAverageColumn()

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

pure virtual

Method allowing creation of a column containing the average of the elements of each row.

Parameters

column_name The name of the new column.

Returns: Integer The position of the column.

Implemented in Arcane::SimpleCsvOutputService.

◆ addColumn() [1/2]

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

pure virtual

Method to add a column.

Parameters

column_name The name of the column.

Returns: Integer The position of the column in the table.

Implemented in Arcane::SimpleCsvOutputService.

◆ addColumn() [2/2]

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

pure virtual

Method to add a column.

If the number of elements in 'elements' is greater than the number of rows, the addition still takes place (but the extra elements will not be added).

Parameters

column_name	The name of the column.
elements	The elements to add to the column.

Returns: Integer The position of the column in the table.

Implemented in Arcane::SimpleCsvOutputService.

◆ addColumns()

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

pure virtual

Method to add multiple columns.

Parameters

rows_names The names of the columns.

Returns: true If all columns were created.; false If not all columns were created.

Implemented in Arcane::SimpleCsvOutputService.

◆ addElementInColumn() [1/2]

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

pure virtual

Method to add an element to a column.

Parameters

column_name	The name of the column.
element	The element to add.
create_if_not_exist	To determine whether the column should be created if it does not yet exist.

Returns: true If the element was successfully added.; false If the element could not be added.

Implemented in Arcane::SimpleCsvOutputService.

References element().

Here is the call graph for this function:

◆ addElementInColumn() [2/2]

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

pure virtual

Method to add an element to a column.

Parameters

position	The position of the column.
element	The element to add.

Returns: true If the element was successfully added.; false If the element could not be added.

Implemented in Arcane::SimpleCsvOutputService.

References element().

Here is the call graph for this function:

◆ addElementInRow() [1/2]

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

pure virtual

Method to add an element to a row.

Parameters

row_name	The name of the row.
element	The element to add.
create_if_not_exist	To determine whether the row should be created if it does not yet exist.

Returns: true If the element was successfully added.; false If the element could not be added.

Implemented in Arcane::SimpleCsvOutputService.

References element().

Here is the call graph for this function:

◆ addElementInRow() [2/2]

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

pure virtual

Method to add an element to a row.

Parameters

position	The position of the row.
element	The element to add.

Returns: true If the element was successfully added.; false If the element could not be added.

Implemented in Arcane::SimpleCsvOutputService.

References element().

Here is the call graph for this function:

◆ addElementInSameColumn()

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

pure virtual

Method to add an element to the last manipulated column.

This method differs from 'editElementDown()' because here, an element is added to the end of the column, not necessarily after the last added element.

Parameters

element The element to add.

Returns: true If the element was added.; false If the element could not be added.

Implemented in Arcane::SimpleCsvOutputService.

References element().

Here is the call graph for this function:

◆ addElementInSameRow()

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

pure virtual

Method to add an element to the last manipulated row.

This method differs from 'editElementRight()' because here, an element is added to the end of the row, not necessarily after the last added element.

Parameters

element The element to add.

Returns: true If the element was added.; false If the element could not be added.

Implemented in Arcane::SimpleCsvOutputService.

References element().

Here is the call graph for this function:

◆ addElementsInColumn() [1/2]

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

pure virtual

Method to add multiple elements to a column.

If the number of elements in 'elements' is greater than the number of available rows, the addition still takes place (but the extra elements will not be added) and a return false will be returned.

Parameters

column_name	The name of the column.
elements	The array of elements to add.
create_if_not_exist	To determine whether the column should be created if it does not yet exist.

Returns: true If all elements were added.; false If [0;len(elements)[ elements were added.

Implemented in Arcane::SimpleCsvOutputService.

◆ addElementsInColumn() [2/2]

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

pure virtual

Method to add multiple elements to a column.

If the number of elements in 'elements' is greater than the number of available rows, the addition still takes place (but the extra elements will not be added) and a return false will be returned.

Parameters

position	The position of the column.
elements	The array of elements to add.

Returns: true If all elements were added.; false If [0;len(elements)[ elements were added.

Implemented in Arcane::SimpleCsvOutputService.

◆ addElementsInRow() [1/2]

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

pure virtual

Method to add multiple elements to a row.

If the number of elements in 'elements' is greater than the number of available columns, the addition still takes place (but the extra elements will not be added) and a return false will be returned.

Parameters

row_name	The name of the row.
elements	The array of elements to add.
create_if_not_exist	To determine whether the row should be created if it does not yet exist.

Returns: true If all elements were added.; false If [0;len(elements)[ elements were added.

Implemented in Arcane::SimpleCsvOutputService.

◆ addElementsInRow() [2/2]

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

pure virtual

Method to add multiple elements to a row.

If the number of elements in 'elements' is greater than the number of available columns, the addition still takes place (but the extra elements will not be added) and a return false will be returned.

Parameters

position	The position of the row.
elements	The array of elements to add.

Returns: true If all elements were added.; false If [0;len(elements)[ elements were added.

Implemented in Arcane::SimpleCsvOutputService.

◆ addElementsInSameColumn()

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

pure virtual

Method to add multiple elements to the last manipulated column.

If the number of elements in 'elements' is greater than the number of available rows, the addition still takes place (but the extra elements will not be added) and a return false will be returned.

Aside from the fact that we are manipulating an array here, this method differs from 'editElementDown()' because here, elements are added to the end of the column, not necessarily after the last added element.

Parameters

elements The array of elements to add.

Returns: true If all elements were added.; false If [0;len(elements)[ elements were added.

Implemented in Arcane::SimpleCsvOutputService.

◆ addElementsInSameRow()

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

pure virtual

Method to add multiple elements to the last manipulated row.

If the number of elements in 'elements' is greater than the number of available columns, the addition still takes place (but the extra elements will not be added) and a return false will be returned.

Aside from the fact that we are manipulating an array here, this method differs from 'editElementRight()' because here, elements are added to the end of the row, not necessarily after the last added element.

Parameters

elements The array of elements to add.

Returns: true If all elements were added.; false If [0;len(elements)[ elements were added.

Implemented in Arcane::SimpleCsvOutputService.

◆ addRow() [1/2]

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

pure virtual

Method to add a row.

Parameters

row_name The name of the row.

Returns: Integer The position of the row in the table.

Implemented in Arcane::SimpleCsvOutputService.

◆ addRow() [2/2]

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

pure virtual

Method to add a row.

If the number of elements in 'elements' is greater than the number of columns, the addition still takes place (but the extra elements will not be added).

Parameters

row_name	The name of the row.
elements	The elements to insert into the row.

Returns: Integer The position of the row in the table.

Implemented in Arcane::SimpleCsvOutputService.

◆ addRows()

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

pure virtual

Method to add multiple rows.

Parameters

rows_names The names of the rows.

Returns: true If all rows were created.; false If not all rows were created.

Implemented in Arcane::SimpleCsvOutputService.

◆ clear()

virtual void Arcane::ISimpleTableOutput::clear ( )

pure virtual

Method to clear the tables.

Implemented in Arcane::SimpleCsvOutputService.

◆ column() [1/2]

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

pure virtual

Method allowing retrieval of a copy of a column.

Parameters

column_name The name of the column.

Returns: RealUniqueArray The copy of the column (empty array if not found).

Implemented in Arcane::SimpleCsvOutputService.

◆ column() [2/2]

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

pure virtual

Method allowing retrieval of a copy of a column.

Parameters

position The position of the column.

Returns: RealUniqueArray The copy of the column (empty array if not found).

Implemented in Arcane::SimpleCsvOutputService.

◆ columnPosition()

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

pure virtual

Method allowing retrieval of the position of a column.

Parameters

row_name The name of the column.

Returns: Integer The position of the column (-1 if not found).

Implemented in Arcane::SimpleCsvOutputService.

◆ columnSize() [1/2]

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

pure virtual

Method allowing retrieval of the size of a column. Including hypothetical 'gaps' in the column.

Parameters

position The name of the column.

Returns: Integer The size of the column (0 if not found).

Implemented in Arcane::SimpleCsvOutputService.

◆ columnSize() [2/2]

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

pure virtual

Method allowing retrieval of the size of a column. Including hypothetical 'gaps' in the column.

Parameters

position The position of the column.

Returns: Integer The size of the column (0 if not found).

Implemented in Arcane::SimpleCsvOutputService.

◆ editColumnName() [1/2]

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

pure virtual

Method allowing changing the name of a column.

Parameters

column_name	The current name of the column.
new_name	The new name of the column.

Returns: true If the change occurred.; false If the change did not occur.

Implemented in Arcane::SimpleCsvOutputService.

◆ editColumnName() [2/2]

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

pure virtual

Method allowing changing the name of a column.

Parameters

position	The position of the column.
new_name	The new name of the column.

Returns: true If the change occurred.; false If the change did not occur.

Implemented in Arcane::SimpleCsvOutputService.

◆ editElement() [1/3]

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

pure virtual

Method allowing modification of an element in the array.

Parameters

column_name	The name of the column where the element is located.
row_name	The name of the row where the element is located.
element	The replacement element.

Returns: true If the element was successfully replaced.; false If the element could not be replaced.

Implemented in Arcane::SimpleCsvOutputService.

References element().

Here is the call graph for this function:

◆ editElement() [2/3]

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

pure virtual

Method to modify an element in the table.

Parameters

position_x	The position of the column to modify.
position_y	The position of the row to modify.
element	The replacement element.

Returns: true If the element was successfully replaced.; false If the element was not replaced.

Implemented in Arcane::SimpleCsvOutputService.

References element().

Here is the call graph for this function:

◆ editElement() [3/3]

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

pure virtual

Method to modify an element in the table.

The x and y positions correspond to the location of the last manipulated element.

This method is useful after using 'elemUDLR(true)' for example.

Parameters

element The replacement element.

Returns: true If the element was successfully replaced.; false If the element was not replaced.

Implemented in Arcane::SimpleCsvOutputService.

References element().

Here is the call graph for this function:

◆ editElementDown()

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

pure virtual

Method to edit an element below the last element manipulated (row below/same column).

The element being modified thus becomes the last modified element at the end of this method (if update_last_position = true).

This method differs from 'addElementInSameColumn()' because here, an element is added (or modified) below the last manipulated element, which is not necessarily at the end of the column.

Parameters

element	The element to modify.
update_last_position	Should the "last modified element" cursor be moved?

Returns: true If the element was modified.; false If the element could not be modified.

Implemented in Arcane::SimpleCsvOutputService.

References element().

Here is the call graph for this function:

◆ editElementLeft()

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

pure virtual

Method to edit an element to the left of the last element manipulated (same row/column to the left).

The element being modified thus becomes the last modified element at the end of this method (if update_last_position = true).

Parameters

element	The element to modify.
update_last_position	Should the "last modified element" cursor be moved?

Returns: true If the element was modified.; false If the element could not be modified.

Implemented in Arcane::SimpleCsvOutputService.

References element().

Here is the call graph for this function:

◆ editElementRight()

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

pure virtual

Method to edit an element to the right of the last element manipulated (same row/column to the right).

The element being modified thus becomes the last modified element at the end of this method (if update_last_position = true).

This method differs from 'addElementInSameRow()' because here, an element is added (or modified) to the right of the last manipulated element, which is not necessarily at the end of the column.

Parameters

element	The element to modify.
update_last_position	Should the "last modified element" cursor be moved?

Returns: true If the element was modified.; false If the element could not be modified.

Implemented in Arcane::SimpleCsvOutputService.

References element().

Here is the call graph for this function:

◆ editElementUp()

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

pure virtual

Method to edit an element above the last element manipulated (row above/same column).

The element being modified thus becomes the last modified element at the end of this method (if update_last_position = true).

Parameters

element	The element to modify.
update_last_position	Should the "last modified element" cursor be moved?

Returns: true If the element was modified.; false If the element could not be modified.

Implemented in Arcane::SimpleCsvOutputService.

References element().

Here is the call graph for this function:

◆ editRowName() [1/2]

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

pure virtual

Method allowing changing the name of a row.

Parameters

row_name	The current name of the row.
new_name	The new name of the row.

Returns: true If the change occurred.; false If the change did not occur.

Implemented in Arcane::SimpleCsvOutputService.

◆ editRowName() [2/2]

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

pure virtual

Method allowing changing the name of a row.

Parameters

position	The position of the row.
new_name	The new name of the row.

Returns: true If the change occurred.; false If the change did not occur.

Implemented in Arcane::SimpleCsvOutputService.

◆ element() [1/3]

virtual Real Arcane::ISimpleTableOutput::element ( )

pure virtual

Method allowing retrieval of a copy of an element.

The x and y positions correspond to the location of the last manipulated element.

Returns: Real The found element (0 if not found).

Implemented in Arcane::SimpleCsvOutputService.

Referenced by addElementInColumn(), addElementInColumn(), addElementInRow(), addElementInRow(), addElementInSameColumn(), addElementInSameRow(), editElement(), editElement(), editElement(), editElementDown(), editElementLeft(), editElementRight(), and editElementUp().

Here is the caller graph for this function:

◆ element() [2/3]

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

pure virtual

Method allowing retrieval of a copy of an element.

Parameters

column_name	The name of the column where the element is located.
row_name	The name of the row where the element is located.
update_last_position	Should the "last modified element" cursor be moved?

Returns: Real The found element (0 if not found).

Implemented in Arcane::SimpleCsvOutputService.

◆ element() [3/3]

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

pure virtual

Method allowing retrieval of a copy of an element.

Parameters

position_x	The position of the column where the element is located.
position_y	The position of the row where the element is located.
update_last_position	Should the "last modified element" cursor be moved?

Returns: Real The found element (0 if not found).

Implemented in Arcane::SimpleCsvOutputService.

◆ elementDown()

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

pure virtual

Method to retrieve an element below the last element manipulated (row below/same column).

The element retrieved thus becomes the last "modified" element at the end of this method (if update_last_position = true).

Parameters

update_last_position Should the "last modified element" cursor be moved?

Returns: Real The found element (0 if not found).

Implemented in Arcane::SimpleCsvOutputService.

◆ elementLeft()

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

pure virtual

Method to retrieve an element to the left of the last element manipulated (same row/column to the left).

The element retrieved thus becomes the last "modified" element at the end of this method (if update_last_position = true).

Parameters

update_last_position Should the "last modified element" cursor be moved?

Returns: Real The found element (0 if not found).

Implemented in Arcane::SimpleCsvOutputService.

◆ elementRight()

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

pure virtual

Method to retrieve an element to the right of the last element manipulated (same row/column to the right).

The element retrieved thus becomes the last "modified" element at the end of this method (if update_last_position = true).

Parameters

update_last_position Should the "last modified element" cursor be moved?

Returns: Real The found element (0 if not found).

Implemented in Arcane::SimpleCsvOutputService.

◆ elementUp()

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

pure virtual

Method to retrieve an element above the last element manipulated (row above/same column).

The element retrieved thus becomes the last "modified" element at the end of this method (if update_last_position = true).

Parameters

update_last_position Should the "last modified element" cursor be moved?

Returns: Real The found element (0 if not found).

Implemented in Arcane::SimpleCsvOutputService.

◆ fileName()

virtual String Arcane::ISimpleTableOutput::fileName ( )

pure virtual

Accessor allowing retrieval of the file name.

May be different for each process (depending on the implementation).

Returns: String The name.

Implemented in Arcane::SimpleCsvOutputService.

◆ fileType()

virtual String Arcane::ISimpleTableOutput::fileType ( )

pure virtual

Method allowing knowledge of the service's file type.

Returns: String The file type.

Implemented in Arcane::SimpleCsvOutputService.

◆ init() [1/3]

virtual bool Arcane::ISimpleTableOutput::init ( )

pure virtual

Method to initialize the table.

Implemented in Arcane::SimpleCsvOutputService.

◆ init() [2/3]

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

pure virtual

Method to initialize the table.

Parameters

table_name The name of the table (and the output file).

Implemented in Arcane::SimpleCsvOutputService.

◆ init() [3/3]

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

pure virtual

Method to initialize the table.

Parameters

table_name	The name of the table (and the output file).
directory_name	The name of the directory where the tables should be saved.

Implemented in Arcane::SimpleCsvOutputService.

◆ internal()

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

pure virtual

Method allowing retrieval of a reference to the SimpleTableInternal object used.

Returns: Ref<SimpleTableInternal> A copy of the reference.

Implemented in Arcane::SimpleCsvOutputService.

Referenced by Arcane::SimpleCsvComparatorService::init().

Here is the caller graph for this function:

◆ isFixed()

virtual bool Arcane::ISimpleTableOutput::isFixed ( )

pure virtual

Method allowing knowledge of whether the 'std::fixed' flag is active or not for writing values.

Returns: true If yes.; false If no.

Implemented in Arcane::SimpleCsvOutputService.

◆ isForcedToUseScientificNotation()

virtual bool Arcane::ISimpleTableOutput::isForcedToUseScientificNotation ( )

pure virtual

Method allowing knowledge of whether the 'std::scientific' flag is active or not for writing values.

Returns: true If yes.; false If no.

Implemented in Arcane::SimpleCsvOutputService.

◆ isOneFileByRanksPermited()

virtual bool Arcane::ISimpleTableOutput::isOneFileByRanksPermited ( )

pure virtual

Method allowing knowledge of whether the parameters currently held by the implementation allow it to write one file per process.

Returns: true If yes, the implementation can write one file per process.; false Otherwise, only one file can be written.

Implemented in Arcane::SimpleCsvOutputService.

◆ numberOfColumns()

virtual Integer Arcane::ISimpleTableOutput::numberOfColumns ( )

pure virtual

Method allowing retrieval of the number of columns in the array. This is, in a way, the maximum number of elements a row can contain.

Returns: Integer The number of columns in the array.

Implemented in Arcane::SimpleCsvOutputService.

◆ numberOfRows()

virtual Integer Arcane::ISimpleTableOutput::numberOfRows ( )

pure virtual

Method allowing retrieval of the number of rows in the array. This is, in a way, the maximum number of elements a column can contain.

Returns: Integer The number of rows in the array.

Implemented in Arcane::SimpleCsvOutputService.

◆ outputDirectory()

virtual String Arcane::ISimpleTableOutput::outputDirectory ( )

pure virtual

Accessor allowing retrieval of the name of the directory where the arrays will be placed.

May be different for each process (depending on the implementation).

Returns: String The directory.

Implemented in Arcane::SimpleCsvOutputService.

◆ outputPath()

virtual Directory Arcane::ISimpleTableOutput::outputPath ( )

pure virtual

Accessor allowing retrieval of the path where the arrays will be saved.

Compared to rootPathOutput(), the return value may differ depending on the "directory" and the "name".

Returns: String The path.

Implemented in Arcane::SimpleCsvOutputService.

◆ precision()

virtual Integer Arcane::ISimpleTableOutput::precision ( )

pure virtual

Method allowing retrieval of the precision currently used for writing values.

Returns: Integer The precision.

Implemented in Arcane::SimpleCsvOutputService.

Referenced by setPrecision().

Here is the caller graph for this function:

◆ print()

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

pure virtual

Method allowing display of the array. Method performing collective operations.

Parameters

rank	The ID of the process that should display the array (-1 to signify "all processes").

Implemented in Arcane::SimpleCsvOutputService.

◆ readerWriter()

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

pure virtual

Method allowing retrieval of a reference to the ISimpleTableReaderWriter object used.

Returns: Ref<ISimpleTableReaderWriter> A copy of the reference.

Implemented in Arcane::SimpleCsvOutputService.

◆ rootPath()

virtual Directory Arcane::ISimpleTableOutput::rootPath ( )

pure virtual

Accessor allowing retrieval of the path where the implementation saves these arrays.

Compared to pathOutput(), the return value does not depend on "directory" or "name".

Returns: String The path.

Implemented in Arcane::SimpleCsvOutputService.

◆ row() [1/2]

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

pure virtual

Method allowing retrieval of a copy of a row.

Parameters

row_name The name of the row.

Returns: RealUniqueArray The copy of the row (empty array if not found).

Implemented in Arcane::SimpleCsvOutputService.

◆ row() [2/2]

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

pure virtual

Method allowing retrieval of a copy of a row.

Parameters

position The position of the row.

Returns: RealUniqueArray The copy of the row (empty array if not found).

Implemented in Arcane::SimpleCsvOutputService.

◆ rowPosition()

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

pure virtual

Method allowing retrieval of the position of a row.

Parameters

row_name The name of the row.

Returns: Integer The position of the row (-1 if not found).

Implemented in Arcane::SimpleCsvOutputService.

◆ rowSize() [1/2]

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

pure virtual

Method allowing retrieval of the size of a row. Including hypothetical 'gaps' in the row.

Parameters

position The name of the row.

Returns: Integer The size of the row (0 if not found).

Implemented in Arcane::SimpleCsvOutputService.

◆ rowSize() [2/2]

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

pure virtual

Method allowing retrieval of the size of a row. Including hypothetical 'gaps' in the row.

Parameters

position The position of the row.

Returns: Integer The size of the row (0 if not found).

Implemented in Arcane::SimpleCsvOutputService.

◆ setFixed()

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

pure virtual

Method allowing setting the 'std::fixed' flag or not.

For both the 'print()' method and the 'writetable()' method.

This flag allows 'forcing' the number of digits after the comma to the desired precision. For example, if 'setPrecision(4)' is called, and 'setFixed(true)' is called, the print of '6.1' will yield '6.1000'.

Warning: The "std::fixed" flag modifies the behavior of "setPrecision()". If the "std::fixed" flag is disabled, precision defines the total number of digits (before and after the comma); if the "std::fixed" flag is enabled, precision defines the number of digits after the comma. Therefore, be careful when using "std::numeric_limits<Real>::max_digits10" (for writing) or "std::numeric_limits<Real>::digits10" (for reading), which should be used without the "std::fixed" flag.

Parameters

fixed Whether the 'std::fixed' flag should be set or not.

Implemented in Arcane::SimpleCsvOutputService.

◆ setForcedToUseScientificNotation()

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

pure virtual

Method allowing setting the 'std::scientific' flag or not.

For both the 'print()' method and the 'writetable()' method.

This flag allows 'forcing' the display of values in scientific notation.

Parameters

use_scientific Whether the 'std::scientific' flag should be set or not.

Implemented in Arcane::SimpleCsvOutputService.

◆ setOutputDirectory()

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

pure virtual

Accessor allowing definition of the directory in which the arrays will be saved.

May be different for each process (depending on the implementation).

Parameters

directory The directory.

Implemented in Arcane::SimpleCsvOutputService.

◆ setPrecision()

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

pure virtual

Method allowing modification of the print precision.

For both the 'print()' method and the 'writeFile()' methods.

Warning: The "std::fixed" flag modifies the behavior of "setPrecision()". If the "std::fixed" flag is disabled, precision defines the total number of digits (before and after the comma); if the "std::fixed" flag is enabled, precision defines the number of digits after the comma. Therefore, be careful when using "std::numeric_limits<Real>::max_digits10" (for writing) or "std::numeric_limits<Real>::digits10" (for reading), which should be used without the "std::fixed" flag.

Parameters

precision The new precision.

Implemented in Arcane::SimpleCsvOutputService.

References precision().

Here is the call graph for this function:

◆ setTableName()

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

pure virtual

Accessor allowing definition of the array name.

May be different for each process (depending on the implementation).

Parameters

name The name.

Implemented in Arcane::SimpleCsvOutputService.

◆ tableName()

virtual String Arcane::ISimpleTableOutput::tableName ( )

pure virtual

Accessor allowing retrieval of the name of the arrays.

May be different for each process (depending on the implementation).

Returns: String The name.

Implemented in Arcane::SimpleCsvOutputService.

◆ writeFile() [1/2]

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

pure virtual

Method allowing writing the array to a file. Method performing collective operations. If rank != -1, processes other than P0 return true.

Parameters

directory	The directory where the file will be written. The final path will be "./[output_dir]/csv/[directory]/".
rank	The ID of the process that should write the array to a file (-1 to signify "all processes").

Returns: true If the file was written correctly.; false If the file was not written correctly.

Deprecated: Use setOutputDirectory() then writeFile() instead.

Implemented in Arcane::SimpleCsvOutputService.

◆ writeFile() [2/2]

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

pure virtual

Method allowing writing the array to a file. Method performing collective operations. If rank != -1, processes other than P0 return true.

Parameters

rank	The ID of the process that should write the array to a file (-1 to signify "all processes").

Returns: true If the file was written correctly.; false If the file was not written correctly.

Implemented in Arcane::SimpleCsvOutputService.

The documentation for this class was generated from the following file:

ISimpleTableOutput.h

Public Member Functions

Detailed Description

Member Function Documentation

◆ 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()

◆ clear()

◆ 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/3]

◆ init() [2/3]

◆ init() [3/3]

◆ 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]