Arcane  4.1.12.0
Developer documentation
Loading...
Searching...
No Matches
Arcane::SimpleTableInternalMng Class Reference
Inheritance diagram for Arcane::SimpleTableInternalMng:
Collaboration diagram for Arcane::SimpleTableInternalMng:

Public Member Functions

 SimpleTableInternalMng (Ref< SimpleTableInternal > simple_table_internal)
void clearInternal () override
 Method to clear the content of the SimpleTableInternal.
Integer addRow (const String &row_name) override
 Method to add a row.
Integer addRow (const String &row_name, ConstArrayView< Real > elements) override
 Method to add a row.
bool addRows (StringConstArrayView rows_names) override
 Method to add multiple rows.
Integer addColumn (const String &column_name) override
 Method to add a column.
Integer addColumn (const String &column_name, ConstArrayView< Real > elements) override
 Method to add a column.
bool addColumns (StringConstArrayView columns_names) override
 Method to add multiple columns.
bool addElementInRow (Integer position, Real element) override
 Method to add an element to a row.
bool addElementInRow (const String &row_name, Real element, bool create_if_not_exist) override
 Method to add an element to a row.
bool addElementInSameRow (Real element) override
 Method to add an element to the row most recently manipulated.
bool addElementsInRow (Integer position, ConstArrayView< Real > elements) override
 Method to add multiple elements to a row.
bool addElementsInRow (const String &row_name, ConstArrayView< Real > elements, bool create_if_not_exist) override
 Method to add multiple elements to a row.
bool addElementsInSameRow (ConstArrayView< Real > elements) override
 Method to add multiple elements to the row most recently manipulated.
bool addElementInColumn (Integer position, Real element) override
 Method to add an element to a column.
bool addElementInColumn (const String &column_name, Real element, bool create_if_not_exist) override
 Method to add an element to a column.
bool addElementInSameColumn (Real element) override
 Method to add an element to the column most recently manipulated.
bool addElementsInColumn (Integer position, ConstArrayView< Real > elements) override
 Method to add multiple elements to a column.
bool addElementsInColumn (const String &column_name, ConstArrayView< Real > elements, bool create_if_not_exist) override
 Method to add multiple elements to a column.
bool addElementsInSameColumn (ConstArrayView< Real > elements) override
 Method to add multiple elements to the column most recently manipulated.
bool editElementUp (Real element, bool update_last_position) override
 Method to edit an element above the last element most recently manipulated (row above/same column).
bool editElementDown (Real element, bool update_last_position) override
 Method to edit an element below the last element most recently manipulated (row below/same column).
bool editElementLeft (Real element, bool update_last_position) override
 Method to edit an element to the left of the last element most recently manipulated (same row/column to the left).
bool editElementRight (Real element, bool update_last_position) override
 Method allowing editing an element to the right of the last element recently manipulated (same row/column to the right).
Real elementUp (bool update_last_position) override
 Method allowing retrieval of an element above the last element recently manipulated (row above/same column).
Real elementDown (bool update_last_position) override
 Method allowing retrieval of an element below the last element recently manipulated (row below/same column).
Real elementLeft (bool update_last_position) override
 Method allowing retrieval of an element to the left of the last element recently manipulated (same row/column to the left).
Real elementRight (bool update_last_position) override
 Method allowing retrieval of an element to the right of the last element recently manipulated (same row/column to the right).
bool editElement (Real element) override
 Method allowing modification of an element in the table.
bool editElement (Integer position_x, Integer position_y, Real element) override
 Method allowing modification of an element in the table.
bool editElement (const String &column_name, const String &row_name, Real element) override
 Method allowing modification of an element in the table.
Real element () override
 Method allowing retrieval of a copy of an element.
Real element (Integer position_x, Integer position_y, bool update_last_position) override
 Method allowing retrieval of a copy of an element.
Real element (const String &column_name, const String &row_name, bool update_last_position) override
 Method allowing retrieval of a copy of an element.
RealUniqueArray row (Integer position) override
 Method allowing retrieval of a copy of a row.
RealUniqueArray column (Integer position) override
 Method allowing retrieval of a copy of a column.
RealUniqueArray row (const String &row_name) override
 Method allowing retrieval of a copy of a row.
RealUniqueArray column (const String &column_name) override
 Method allowing retrieval of a copy of a column.
Integer rowSize (Integer position) override
 Method allowing retrieval of the size of a row. Including hypothetical 'gaps' in the row.
Integer columnSize (Integer position) override
 Method allowing retrieval of the size of a column. Including hypothetical 'gaps' in the column.
Integer rowSize (const String &row_name) override
 Method allowing retrieval of the size of a row. Including hypothetical 'gaps' in the row.
Integer columnSize (const String &column_name) override
 Method allowing retrieval of the size of a column. Including hypothetical 'gaps' in the column.
Integer rowPosition (const String &row_name) override
 Method allowing retrieval of the position of a row.
Integer columnPosition (const String &column_name) override
 Method allowing retrieval of the position of a column.
Integer numberOfRows () override
 Method allowing retrieval of the number of rows in the table. This is, in a sense, the maximum number of elements a column can contain.
Integer numberOfColumns () override
 Method allowing retrieval of the number of columns in the table. This is, in a sense, the maximum number of elements a row can contain.
String rowName (Integer position) override
 Method allowing retrieval of the name of a row from its position.
String columnName (Integer position) override
 Method allowing retrieval of the name of a column from its position.
bool editRowName (Integer position, const String &new_name) override
 Method allowing changing the name of a row.
bool editRowName (const String &row_name, const String &new_name) override
 Method allowing changing the name of a row.
bool editColumnName (Integer position, const String &new_name) override
 Method allowing changing the name of a column.
bool editColumnName (const String &column_name, const String &new_name) override
 Method allowing changing the name of a column.
Integer addAverageColumn (const String &column_name) override
 Method allowing creation of a column containing the average of elements of each row.
Ref< SimpleTableInternalinternal () override
 Method allowing retrieval of a reference to the object SimpleTableInternal used.
void setInternal (const Ref< SimpleTableInternal > &simple_table_internal) override
 Method allowing setting a reference to a SimpleTableInternal.

Protected Attributes

Ref< SimpleTableInternalm_simple_table_internal

Detailed Description

Definition at line 29 of file SimpleTableInternalMng.h.

Constructor & Destructor Documentation

◆ SimpleTableInternalMng() [1/2]

Arcane::SimpleTableInternalMng::SimpleTableInternalMng ( Ref< SimpleTableInternal > simple_table_internal)
inline

Definition at line 34 of file SimpleTableInternalMng.h.

◆ SimpleTableInternalMng() [2/2]

Arcane::SimpleTableInternalMng::SimpleTableInternalMng ( )
inline

Definition at line 41 of file SimpleTableInternalMng.h.

Member Function Documentation

◆ addAverageColumn()

Integer Arcane::SimpleTableInternalMng::addAverageColumn ( const String & column_name)
overridevirtual

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

Parameters
column_nameThe name of the new column. Must not be empty.
Returns
Integer The position of the column.

Implements Arcane::ISimpleTableInternalMng.

Definition at line 760 of file SimpleTableInternalMng.cc.

References addColumn(), addElementInColumn(), Arcane::String::empty(), and Arcane::ConstArrayView< T >::size().

Here is the call graph for this function:

◆ addColumn() [1/2]

Integer Arcane::SimpleTableInternalMng::addColumn ( const String & column_name)
overridevirtual

Method to add a column.

Parameters
column_nameThe name of the column. Must not be empty.
Returns
Integer The position of the column in the array. (-1 if the given name is incorrect).

Implements Arcane::ISimpleTableInternalMng.

Definition at line 94 of file SimpleTableInternalMng.cc.

References Arcane::String::empty().

Referenced by addAverageColumn(), addElementInColumn(), and addElementsInColumn().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ addColumn() [2/2]

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

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_nameThe name of the column. Must not be empty.
elementsThe elements to add to the column.
Returns
Integer The position of the column in the array. (-1 if the given name is incorrect).

Implements Arcane::ISimpleTableInternalMng.

Definition at line 111 of file SimpleTableInternalMng.cc.

References addElementsInColumn(), and Arcane::String::empty().

Here is the call graph for this function:

◆ addColumns()

bool Arcane::SimpleTableInternalMng::addColumns ( StringConstArrayView columns_names)
overridevirtual

Method to add multiple columns.

Parameters
rows_namesThe names of the columns. Each name must not be empty.
Returns
true If all columns were created.
false If not all columns were created.

Implements Arcane::ISimpleTableInternalMng.

Definition at line 128 of file SimpleTableInternalMng.cc.

References Arcane::ConstArrayView< T >::contains(), and Arcane::ConstArrayView< T >::size().

Here is the call graph for this function:

◆ addElementInColumn() [1/2]

bool Arcane::SimpleTableInternalMng::addElementInColumn ( const String & column_name,
Real element,
bool create_if_not_exist )
overridevirtual

Method to add an element to a column.

Parameters
column_nameThe name of the column.
elementThe element to add.
create_if_not_existTo specify whether the column should be created if it does not already exist.
Returns
true If the element was successfully added.
false If the element could not be added.

Implements Arcane::ISimpleTableInternalMng.

Definition at line 277 of file SimpleTableInternalMng.cc.

References addColumn(), addElementInColumn(), and element().

Here is the call graph for this function:

◆ addElementInColumn() [2/2]

bool Arcane::SimpleTableInternalMng::addElementInColumn ( Integer position,
Real element )
overridevirtual

Method to add an element to a column.

Parameters
positionThe position of the column.
elementThe element to add.
Returns
true If the element was successfully added.
false If the element could not be added.

Implements Arcane::ISimpleTableInternalMng.

Definition at line 255 of file SimpleTableInternalMng.cc.

References element().

Referenced by addAverageColumn(), addElementInColumn(), and addElementInSameColumn().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ addElementInRow() [1/2]

bool Arcane::SimpleTableInternalMng::addElementInRow ( const String & row_name,
Real element,
bool create_if_not_exist )
overridevirtual

Method to add an element to a row.

Parameters
row_nameThe name of the row.
elementThe element to add.
create_if_not_existTo specify whether the row should be created if it does not already exist.
Returns
true If the element was successfully added.
false If the element could not be added.

Implements Arcane::ISimpleTableInternalMng.

Definition at line 182 of file SimpleTableInternalMng.cc.

References addElementInRow(), addRow(), and element().

Here is the call graph for this function:

◆ addElementInRow() [2/2]

bool Arcane::SimpleTableInternalMng::addElementInRow ( Integer position,
Real element )
overridevirtual

Method to add an element to a row.

Parameters
positionThe position of the row.
elementThe element to add.
Returns
true If the element was successfully added.
false If the element could not be added.

Implements Arcane::ISimpleTableInternalMng.

Definition at line 152 of file SimpleTableInternalMng.cc.

References element().

Referenced by addElementInRow(), and addElementInSameRow().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ addElementInSameColumn()

bool Arcane::SimpleTableInternalMng::addElementInSameColumn ( Real element)
overridevirtual

Method to add an element to the column most recently manipulated.

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
elementThe element to add.
Returns
true If the element was added.
false If the element could not be added.

Implements Arcane::ISimpleTableInternalMng.

Definition at line 290 of file SimpleTableInternalMng.cc.

References addElementInColumn(), and element().

Here is the call graph for this function:

◆ addElementInSameRow()

bool Arcane::SimpleTableInternalMng::addElementInSameRow ( Real element)
overridevirtual

Method to add an element to the row most recently manipulated.

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
elementThe element to add.
Returns
true If the element was added.
false If the element could not be added.

Implements Arcane::ISimpleTableInternalMng.

Definition at line 195 of file SimpleTableInternalMng.cc.

References addElementInRow(), and element().

Here is the call graph for this function:

◆ addElementsInColumn() [1/2]

bool Arcane::SimpleTableInternalMng::addElementsInColumn ( const String & column_name,
ConstArrayView< Real > elements,
bool create_if_not_exist )
overridevirtual

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 value of false will be returned.

Parameters
column_nameThe name of the column.
elementsThe array of elements to add.
create_if_not_existTo specify whether the column should be created if it does not already exist.
Returns
true If all elements were added.
false If [0;len(elements)[ elements were added.

Implements Arcane::ISimpleTableInternalMng.

Definition at line 324 of file SimpleTableInternalMng.cc.

References addColumn(), and addElementsInColumn().

Here is the call graph for this function:

◆ addElementsInColumn() [2/2]

bool Arcane::SimpleTableInternalMng::addElementsInColumn ( Integer position,
ConstArrayView< Real > elements )
overridevirtual

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 value of false will be returned.

Parameters
positionThe position of the column.
elementsThe array of elements to add.
Returns
true If all elements were added.
false If [0;len(elements)[ elements were added.

Implements Arcane::ISimpleTableInternalMng.

Definition at line 301 of file SimpleTableInternalMng.cc.

References Arcane::ConstArrayView< T >::size().

Referenced by addColumn(), addElementsInColumn(), and addElementsInSameColumn().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ addElementsInRow() [1/2]

bool Arcane::SimpleTableInternalMng::addElementsInRow ( const String & row_name,
ConstArrayView< Real > elements,
bool create_if_not_exist )
overridevirtual

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 value of false will be returned.

Parameters
row_nameThe name of the row.
elementsThe array of elements to add.
create_if_not_existTo specify whether the row should be created if it does not already exist.
Returns
true If all elements were added.
false If [0;len(elements)[ elements were added.

Implements Arcane::ISimpleTableInternalMng.

Definition at line 230 of file SimpleTableInternalMng.cc.

References addElementsInRow(), and addRow().

Here is the call graph for this function:

◆ addElementsInRow() [2/2]

bool Arcane::SimpleTableInternalMng::addElementsInRow ( Integer position,
ConstArrayView< Real > elements )
overridevirtual

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 value of false will be returned.

Parameters
positionThe position of the row.
elementsThe array of elements to add.
Returns
true If all elements were added.
false If [0;len(elements)[ elements were added.

Implements Arcane::ISimpleTableInternalMng.

Definition at line 206 of file SimpleTableInternalMng.cc.

References Arcane::ConstArrayView< T >::size().

Referenced by addElementsInRow(), addElementsInSameRow(), and addRow().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ addElementsInSameColumn()

bool Arcane::SimpleTableInternalMng::addElementsInSameColumn ( ConstArrayView< Real > elements)
overridevirtual

Method to add multiple elements to the column most recently manipulated.

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 value of false will be returned.

Apart 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
elementsThe array of elements to add.
Returns
true If all elements were added.
false If [0;len(elements)[ elements were added.

Implements Arcane::ISimpleTableInternalMng.

Definition at line 338 of file SimpleTableInternalMng.cc.

References addElementsInColumn().

Here is the call graph for this function:

◆ addElementsInSameRow()

bool Arcane::SimpleTableInternalMng::addElementsInSameRow ( ConstArrayView< Real > elements)
overridevirtual

Method to add multiple elements to the row most recently manipulated.

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 value of false will be returned.

Apart 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
elementsThe array of elements to add.
Returns
true If all elements were added.
false If [0;len(elements)[ elements were added.

Implements Arcane::ISimpleTableInternalMng.

Definition at line 244 of file SimpleTableInternalMng.cc.

References addElementsInRow().

Here is the call graph for this function:

◆ addRow() [1/2]

Integer Arcane::SimpleTableInternalMng::addRow ( const String & row_name)
overridevirtual

Method to add a row.

Parameters
row_nameThe name of the row. Must not be empty.
Returns
Integer The position of the row in the array (-1 if the given name is incorrect).

Implements Arcane::ISimpleTableInternalMng.

Definition at line 36 of file SimpleTableInternalMng.cc.

References Arcane::String::empty().

Referenced by addElementInRow(), and addElementsInRow().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ addRow() [2/2]

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

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_nameThe name of the row. Must not be empty.
elementsThe elements to insert into the row.
Returns
Integer The position of the row in the array. (-1 if the given name is incorrect).

Implements Arcane::ISimpleTableInternalMng.

Definition at line 53 of file SimpleTableInternalMng.cc.

References addElementsInRow(), and Arcane::String::empty().

Here is the call graph for this function:

◆ addRows()

bool Arcane::SimpleTableInternalMng::addRows ( StringConstArrayView rows_names)
overridevirtual

Method to add multiple rows.

Parameters
rows_namesThe names of the rows. Each name must not be empty.
Returns
true If all rows were created.
false If not all rows were created.

Implements Arcane::ISimpleTableInternalMng.

Definition at line 70 of file SimpleTableInternalMng.cc.

References Arcane::ConstArrayView< T >::contains(), and Arcane::ConstArrayView< T >::size().

Here is the call graph for this function:

◆ clearInternal()

void Arcane::SimpleTableInternalMng::clearInternal ( )
overridevirtual

Method to clear the content of the SimpleTableInternal.

Implements Arcane::ISimpleTableInternalMng.

Definition at line 27 of file SimpleTableInternalMng.cc.

◆ column() [1/2]

RealUniqueArray Arcane::SimpleTableInternalMng::column ( const String & column_name)
overridevirtual

Method allowing retrieval of a copy of a column.

Parameters
column_nameThe name of the column.
Returns
RealUniqueArray The copy of the column (empty array if not found).

Implements Arcane::ISimpleTableInternalMng.

Definition at line 612 of file SimpleTableInternalMng.cc.

References column(), Arcane::SpanImpl< T, SizeType, Extent >::findFirst(), and Arcane::Array< T >::span().

Here is the call graph for this function:

◆ column() [2/2]

RealUniqueArray Arcane::SimpleTableInternalMng::column ( Integer position)
overridevirtual

Method allowing retrieval of a copy of a column.

Parameters
positionThe position of the column.
Returns
RealUniqueArray The copy of the column (empty array if not found).

Implements Arcane::ISimpleTableInternalMng.

Definition at line 600 of file SimpleTableInternalMng.cc.

References columnSize().

Referenced by column().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ columnName()

String Arcane::SimpleTableInternalMng::columnName ( Integer position)
overridevirtual

Method allowing retrieval of the name of a column from its position.

Parameters
positionThe position of the column.
Returns
String The name of the column (empty string if the column was not found).

Implements Arcane::ISimpleTableInternalMng.

Definition at line 709 of file SimpleTableInternalMng.cc.

◆ columnPosition()

Integer Arcane::SimpleTableInternalMng::columnPosition ( const String & column_name)
overridevirtual

Method allowing retrieval of the position of a column.

Parameters
row_nameThe name of the column.
Returns
Integer The position of the column (-1 if not found).

Implements Arcane::ISimpleTableInternalMng.

Definition at line 673 of file SimpleTableInternalMng.cc.

◆ columnSize() [1/2]

Integer Arcane::SimpleTableInternalMng::columnSize ( const String & column_name)
overridevirtual

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

Parameters
positionThe name of the column.
Returns
Integer The size of the column (0 if not found).

Implements Arcane::ISimpleTableInternalMng.

Definition at line 652 of file SimpleTableInternalMng.cc.

References columnSize().

Here is the call graph for this function:

◆ columnSize() [2/2]

Integer Arcane::SimpleTableInternalMng::columnSize ( Integer position)
overridevirtual

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

Parameters
positionThe position of the column.
Returns
Integer The size of the column (0 if not found).

Implements Arcane::ISimpleTableInternalMng.

Definition at line 644 of file SimpleTableInternalMng.cc.

Referenced by column(), and columnSize().

Here is the caller graph for this function:

◆ editColumnName() [1/2]

bool Arcane::SimpleTableInternalMng::editColumnName ( const String & column_name,
const String & new_name )
overridevirtual

Method allowing changing the name of a column.

Parameters
column_nameThe current name of the column.
new_nameThe new name of the column. Must not be empty.
Returns
true If the change occurred.
false If the change did not occur.

Implements Arcane::ISimpleTableInternalMng.

Definition at line 748 of file SimpleTableInternalMng.cc.

References editColumnName().

Here is the call graph for this function:

◆ editColumnName() [2/2]

bool Arcane::SimpleTableInternalMng::editColumnName ( Integer position,
const String & new_name )
overridevirtual

Method allowing changing the name of a column.

Parameters
positionThe position of the column.
new_nameThe new name of the column. Must not be empty.
Returns
true If the change occurred.
false If the change did not occur.

Implements Arcane::ISimpleTableInternalMng.

Definition at line 739 of file SimpleTableInternalMng.cc.

References Arcane::String::empty().

Referenced by editColumnName().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ editElement() [1/3]

bool Arcane::SimpleTableInternalMng::editElement ( const String & column_name,
const String & row_name,
Real element )
overridevirtual

Method allowing modification of an element in the table.

Parameters
column_nameThe name of the column where the element is located.
row_nameThe name of the row where the element is located.
elementThe replacement element.
Returns
true If the element was successfully replaced.
false If the element could not be replaced.

Implements Arcane::ISimpleTableInternalMng.

Definition at line 529 of file SimpleTableInternalMng.cc.

References editElement(), and element().

Here is the call graph for this function:

◆ editElement() [2/3]

bool Arcane::SimpleTableInternalMng::editElement ( Integer position_x,
Integer position_y,
Real element )
overridevirtual

Method allowing modification of an element in the table.

Parameters
position_xThe position of the column to modify.
position_yThe position of the row to modify.
elementThe replacement element.
Returns
true If the element was successfully replaced.
false If the element was not replaced.

Implements Arcane::ISimpleTableInternalMng.

Definition at line 510 of file SimpleTableInternalMng.cc.

References element().

Here is the call graph for this function:

◆ editElement() [3/3]

bool Arcane::SimpleTableInternalMng::editElement ( Real element)
overridevirtual

Method allowing modification of 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
elementThe replacement element.
Returns
true If the element was successfully replaced.
false If the element was not replaced.

Implements Arcane::ISimpleTableInternalMng.

Definition at line 503 of file SimpleTableInternalMng.cc.

References element().

Referenced by editElement().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ editElementDown()

bool Arcane::SimpleTableInternalMng::editElementDown ( Real element,
bool update_last_position )
overridevirtual

Method to edit an element below the last element most recently 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
elementThe element to modify.
update_last_positionShould the "last modified element" cursor be moved?
Returns
true If the element was modified.
false If the element could not be modified.

Implements Arcane::ISimpleTableInternalMng.

Definition at line 366 of file SimpleTableInternalMng.cc.

References element().

Here is the call graph for this function:

◆ editElementLeft()

bool Arcane::SimpleTableInternalMng::editElementLeft ( Real element,
bool update_last_position )
overridevirtual

Method to edit an element to the left of the last element most recently 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
elementThe element to modify.
update_last_positionShould the "last modified element" cursor be moved?
Returns
true If the element was modified.
false If the element could not be modified.

Implements Arcane::ISimpleTableInternalMng.

Definition at line 384 of file SimpleTableInternalMng.cc.

References element().

Here is the call graph for this function:

◆ editElementRight()

bool Arcane::SimpleTableInternalMng::editElementRight ( Real element,
bool update_last_position )
overridevirtual

Method allowing editing an element to the right of the last element recently 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, we add (or modify) an element to the right of the last manipulated element, which is not necessarily at the end of the column.

Parameters
elementThe element to modify.
update_last_positionShould the "last modified element" cursor be moved?
Returns
true If the element was modified.
false If the element could not be modified.

Implements Arcane::ISimpleTableInternalMng.

Definition at line 401 of file SimpleTableInternalMng.cc.

References element().

Here is the call graph for this function:

◆ editElementUp()

bool Arcane::SimpleTableInternalMng::editElementUp ( Real element,
bool update_last_position )
overridevirtual

Method to edit an element above the last element most recently 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
elementThe element to modify.
update_last_positionShould the "last modified element" cursor be moved?
Returns
true If the element was modified.
false If the element could not be modified.

Implements Arcane::ISimpleTableInternalMng.

Definition at line 349 of file SimpleTableInternalMng.cc.

References element().

Here is the call graph for this function:

◆ editRowName() [1/2]

bool Arcane::SimpleTableInternalMng::editRowName ( const String & row_name,
const String & new_name )
overridevirtual

Method allowing changing the name of a row.

Parameters
row_nameThe current name of the row.
new_nameThe new name of the row. Must not be empty.
Returns
true If the change occurred.
false If the change did not occur.

Implements Arcane::ISimpleTableInternalMng.

Definition at line 730 of file SimpleTableInternalMng.cc.

References editRowName().

Here is the call graph for this function:

◆ editRowName() [2/2]

bool Arcane::SimpleTableInternalMng::editRowName ( Integer position,
const String & new_name )
overridevirtual

Method allowing changing the name of a row.

Parameters
positionThe position of the row.
new_nameThe new name of the row. Must not be empty.
Returns
true If the change occurred.
false If the change did not occur.

Implements Arcane::ISimpleTableInternalMng.

Definition at line 721 of file SimpleTableInternalMng.cc.

References Arcane::String::empty().

Referenced by editRowName().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ element() [1/3]

Real Arcane::SimpleTableInternalMng::element ( )
overridevirtual

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

Implements Arcane::ISimpleTableInternalMng.

Definition at line 543 of file SimpleTableInternalMng.cc.

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

Here is the caller graph for this function:

◆ element() [2/3]

Real Arcane::SimpleTableInternalMng::element ( const String & column_name,
const String & row_name,
bool update_last_position )
overridevirtual

Method allowing retrieval of a copy of an element.

Parameters
column_nameThe name of the column where the element is located.
row_nameThe name of the row where the element is located.
update_last_positionShould the "last modified element" cursor be moved?
Returns
Real The found element (0 if not found).

Implements Arcane::ISimpleTableInternalMng.

Definition at line 563 of file SimpleTableInternalMng.cc.

References element().

Here is the call graph for this function:

◆ element() [3/3]

Real Arcane::SimpleTableInternalMng::element ( Integer position_x,
Integer position_y,
bool update_last_position )
overridevirtual

Method allowing retrieval of a copy of an element.

Parameters
position_xThe position of the column where the element is located.
position_yThe position of the row where the element is located.
update_last_positionShould the "last modified element" cursor be moved?
Returns
Real The found element (0 if not found).

Implements Arcane::ISimpleTableInternalMng.

Definition at line 549 of file SimpleTableInternalMng.cc.

◆ elementDown()

Real Arcane::SimpleTableInternalMng::elementDown ( bool update_last_position)
overridevirtual

Method allowing retrieval of an element below the last element recently 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_positionShould the "last modified element" cursor be moved?
Returns
Real The found element (0 if not found).

Implements Arcane::ISimpleTableInternalMng.

Definition at line 441 of file SimpleTableInternalMng.cc.

◆ elementLeft()

Real Arcane::SimpleTableInternalMng::elementLeft ( bool update_last_position)
overridevirtual

Method allowing retrieval of an element to the left of the last element recently 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_positionShould the "last modified element" cursor be moved?
Returns
Real The found element (0 if not found).

Implements Arcane::ISimpleTableInternalMng.

Definition at line 461 of file SimpleTableInternalMng.cc.

◆ elementRight()

Real Arcane::SimpleTableInternalMng::elementRight ( bool update_last_position)
overridevirtual

Method allowing retrieval of an element to the right of the last element recently 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_positionShould the "last modified element" cursor be moved?
Returns
Real The found element (0 if not found).

Implements Arcane::ISimpleTableInternalMng.

Definition at line 480 of file SimpleTableInternalMng.cc.

◆ elementUp()

Real Arcane::SimpleTableInternalMng::elementUp ( bool update_last_position)
overridevirtual

Method allowing retrieval of an element above the last element recently 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_positionShould the "last modified element" cursor be moved?
Returns
Real The found element (0 if not found).

Implements Arcane::ISimpleTableInternalMng.

Definition at line 422 of file SimpleTableInternalMng.cc.

◆ internal()

Ref< SimpleTableInternal > Arcane::SimpleTableInternalMng::internal ( )
overridevirtual

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

Returns
Ref<SimpleTableInternal> A copy of the reference.

Implements Arcane::ISimpleTableInternalMng.

Definition at line 782 of file SimpleTableInternalMng.cc.

◆ numberOfColumns()

Integer Arcane::SimpleTableInternalMng::numberOfColumns ( )
overridevirtual

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

Returns
Integer The number of columns in the table.

Implements Arcane::ISimpleTableInternalMng.

Definition at line 691 of file SimpleTableInternalMng.cc.

◆ numberOfRows()

Integer Arcane::SimpleTableInternalMng::numberOfRows ( )
overridevirtual

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

Returns
Integer The number of rows in the table.

Implements Arcane::ISimpleTableInternalMng.

Definition at line 685 of file SimpleTableInternalMng.cc.

◆ row() [1/2]

RealUniqueArray Arcane::SimpleTableInternalMng::row ( const String & row_name)
overridevirtual

Method allowing retrieval of a copy of a row.

Parameters
row_nameThe name of the row.
Returns
RealUniqueArray The copy of the row (empty array if not found).

Implements Arcane::ISimpleTableInternalMng.

Definition at line 588 of file SimpleTableInternalMng.cc.

References Arcane::SpanImpl< T, SizeType, Extent >::findFirst(), row(), and Arcane::Array< T >::span().

Here is the call graph for this function:

◆ row() [2/2]

RealUniqueArray Arcane::SimpleTableInternalMng::row ( Integer position)
overridevirtual

Method allowing retrieval of a copy of a row.

Parameters
positionThe position of the row.
Returns
RealUniqueArray The copy of the row (empty array if not found).

Implements Arcane::ISimpleTableInternalMng.

Definition at line 577 of file SimpleTableInternalMng.cc.

References rowSize().

Referenced by row().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ rowName()

String Arcane::SimpleTableInternalMng::rowName ( Integer position)
overridevirtual

Method allowing retrieval of the name of a row from its position.

Parameters
positionThe position of the row.
Returns
String The name of the row (empty string if the row was not found).

Implements Arcane::ISimpleTableInternalMng.

Definition at line 700 of file SimpleTableInternalMng.cc.

◆ rowPosition()

Integer Arcane::SimpleTableInternalMng::rowPosition ( const String & row_name)
overridevirtual

Method allowing retrieval of the position of a row.

Parameters
row_nameThe name of the row.
Returns
Integer The position of the row (-1 if not found).

Implements Arcane::ISimpleTableInternalMng.

Definition at line 664 of file SimpleTableInternalMng.cc.

◆ rowSize() [1/2]

Integer Arcane::SimpleTableInternalMng::rowSize ( const String & row_name)
overridevirtual

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

Parameters
positionThe name of the row.
Returns
Integer The size of the row (0 if not found).

Implements Arcane::ISimpleTableInternalMng.

Definition at line 632 of file SimpleTableInternalMng.cc.

References rowSize().

Here is the call graph for this function:

◆ rowSize() [2/2]

Integer Arcane::SimpleTableInternalMng::rowSize ( Integer position)
overridevirtual

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

Parameters
positionThe position of the row.
Returns
Integer The size of the row (0 if not found).

Implements Arcane::ISimpleTableInternalMng.

Definition at line 624 of file SimpleTableInternalMng.cc.

Referenced by row(), and rowSize().

Here is the caller graph for this function:

◆ setInternal()

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

Method allowing setting a reference to a SimpleTableInternal.

Parameters
simple_table_internalThe reference to a SimpleTableInternal.

Implements Arcane::ISimpleTableInternalMng.

Definition at line 788 of file SimpleTableInternalMng.cc.

References ARCANE_FATAL, and Arcane::RefImpl< InstanceType, RefClassType, ImplTagId >::isNull().

Here is the call graph for this function:

Member Data Documentation

◆ m_simple_table_internal

Ref<SimpleTableInternal> Arcane::SimpleTableInternalMng::m_simple_table_internal
protected

Definition at line 128 of file SimpleTableInternalMng.h.


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