SALOMEDS::AttributeTableOfInteger Interface Reference
AttributeTableOfInteger interface
More...
Data Structures |
exception | IncorrectArgumentLength |
| This exception is raised when an incorrect length of the argument is passed as parameter. More...
|
exception | IncorrectIndex |
| This exception is raised when an incorrect index is passed as parameter. More...
|
Public Member Functions |
void | SetTitle (in string theTitle) |
string | GetTitle () |
void | SetRowTitle (in long theIndex, in string theTitle) raises (IncorrectIndex) |
void | SetRowTitles (in StringSeq theTitles) raises (IncorrectArgumentLength) |
StringSeq | GetRowTitles () |
void | SetColumnTitle (in long theIndex, in string theTitle) raises (IncorrectIndex) |
void | SetColumnTitles (in StringSeq theTitles) raises (IncorrectArgumentLength) |
StringSeq | GetColumnTitles () |
void | SetRowUnit (in long theIndex, in string theUnit) raises (IncorrectIndex) |
void | SetRowUnits (in StringSeq theUnits) raises (IncorrectArgumentLength) |
StringSeq | GetRowUnits () |
long | GetNbRows () |
long | GetNbColumns () |
void | AddRow (in LongSeq theData) raises (IncorrectArgumentLength) |
void | SetRow (in long theRow, in LongSeq theData) raises (IncorrectArgumentLength, IncorrectIndex) |
LongSeq | GetRow (in long theRow) raises (IncorrectIndex) |
void | AddColumn (in LongSeq theData) raises (IncorrectArgumentLength) |
void | SetColumn (in long theColumn, in LongSeq theData) raises (IncorrectArgumentLength, IncorrectIndex) |
LongSeq | GetColumn (in long theColumn) raises (IncorrectIndex) |
void | PutValue (in long theValue, in long theRow, in long theColumn) raises (IncorrectIndex) |
boolean | HasValue (in long theRow, in long theColumn) |
long | GetValue (in long theRow, in long theColumn) raises (IncorrectIndex) |
void | SetNbColumns (in long theNbColumns) |
LongSeq | GetRowSetIndices (in long theRow) raises (IncorrectIndex) |
boolean | ReadFromFile (in SALOMEDS::TMPFile theStream) |
SALOMEDS::TMPFile | SaveToFile () |
void | CheckLocked () raises (LockProtection) |
| Method CheckLocked.
|
string | Type () |
| Get Type.
|
string | GetClassType () |
| Get the class type.
|
SObject | GetSObject () |
| Get SObject.
|
long long | GetLocalImpl (in string theHostname, in long thePID, out boolean isLocal) |
| Private method, returns an implementation of this GenericAttribute.
|
void | Register () |
| Increase the reference count (mark as used by another object).
|
void | Destroy () |
| Decrease the reference count (release by another object).
|
Detailed Description
AttributeTableOfInteger interface
This attribute allows to store a table of integers (indexing from 1 like in CASCADE) and string titles of this table, of each row, of each column.
See example21 for an example of usage of these methods in batchmode of SALOME application.
Member Function Documentation
void SALOMEDS::AttributeTableOfInteger::SetTitle |
( |
in string |
theTitle |
) |
|
Sets the title of the table.
string SALOMEDS::AttributeTableOfInteger::GetTitle |
( |
|
) |
|
Returns the title of the table.
void SALOMEDS::AttributeTableOfInteger::SetRowTitle |
( |
in long |
theIndex, |
|
|
in string |
theTitle | |
|
) |
| | raises (IncorrectIndex) |
Sets the title of a row with a definite index.
Sets the titles for all rows of the table.
StringSeq SALOMEDS::AttributeTableOfInteger::GetRowTitles |
( |
|
) |
|
Returns the titles of all rows of the table.
void SALOMEDS::AttributeTableOfInteger::SetColumnTitle |
( |
in long |
theIndex, |
|
|
in string |
theTitle | |
|
) |
| | raises (IncorrectIndex) |
Sets the title of a column with a definite index.
Sets the titles for all columns of the table.
StringSeq SALOMEDS::AttributeTableOfInteger::GetColumnTitles |
( |
|
) |
|
Returns the titles of all columns of the table.
void SALOMEDS::AttributeTableOfInteger::SetRowUnit |
( |
in long |
theIndex, |
|
|
in string |
theUnit | |
|
) |
| | raises (IncorrectIndex) |
Sets the unit of a row with a definite index.
Sets the units for all rows of the table.
StringSeq SALOMEDS::AttributeTableOfInteger::GetRowUnits |
( |
|
) |
|
Returns the units of all rows of the table.
long SALOMEDS::AttributeTableOfInteger::GetNbRows |
( |
|
) |
|
Returns the number of rows of the table.
long SALOMEDS::AttributeTableOfInteger::GetNbColumns |
( |
|
) |
|
Returns the number of columns of the table.
Adds a row to the end of the table.
- Parameters:
-
| theData | A sequence of long values which will be set as elements of the added row. |
Sets the elements of a definite row.
- Parameters:
-
| theRow | The number of the row. |
| theData | A sequence of long values which will be set as elements of this row. |
Gets the row of the table.
- Parameters:
-
| theRow | The number of the row. |
- Returns:
- A sequence of long values which are set as elements of this row.
Adds a column to the end of the table.
- Parameters:
-
| theData | A sequence of long values which will be set as elements of this column. |
Sets the values of all elements of the column.
- Parameters:
-
| theData | A sequence of long values which will be set as elements of this column. |
Returns the column of the table.
void SALOMEDS::AttributeTableOfInteger::PutValue |
( |
in long |
theValue, |
|
|
in long |
theRow, |
|
|
in long |
theColumn | |
|
) |
| | raises (IncorrectIndex) |
Puts a value in the table.
- Parameters:
-
| theRow | The row, where the value will be placed. |
| theColumn | The column, where the value will be placed. |
boolean SALOMEDS::AttributeTableOfInteger::HasValue |
( |
in long |
theRow, |
|
|
in long |
theColumn | |
|
) |
| | |
Returns True if there is a value in the table.
- Parameters:
-
| theRow | The row containing the value |
| theColumn | The column containing the value |
long SALOMEDS::AttributeTableOfInteger::GetValue |
( |
in long |
theRow, |
|
|
in long |
theColumn | |
|
) |
| | raises (IncorrectIndex) |
Returns the value from the table.
- Parameters:
-
| theRow | The row containing the value |
| theColumn | The column containing the value |
void SALOMEDS::AttributeTableOfInteger::SetNbColumns |
( |
in long |
theNbColumns |
) |
|
Sets the max number of colums in the table.
- Note:
- It'd better to set it before filling the table.
Returns the indices of the row where the values are defined.
boolean SALOMEDS::AttributeTableOfInteger::ReadFromFile |
( |
in SALOMEDS::TMPFile |
theStream |
) |
|
Reads a table from a file.
Saves a table into a file.
void SALOMEDS::GenericAttribute::CheckLocked |
( |
|
) |
raises (LockProtection) [inherited] |
Method CheckLocked.
Checks whether the Study is protected for modifications.
- Note:
This exception is raised only outside a transaction.
string SALOMEDS::GenericAttribute::Type |
( |
|
) |
[inherited] |
string SALOMEDS::GenericAttribute::GetClassType |
( |
|
) |
[inherited] |
SObject SALOMEDS::GenericAttribute::GetSObject |
( |
|
) |
[inherited] |
long long SALOMEDS::GenericAttribute::GetLocalImpl |
( |
in string |
theHostname, |
|
|
in long |
thePID, |
|
|
out boolean |
isLocal | |
|
) |
| | [inherited] |
Private method, returns an implementation of this GenericAttribute.
- Parameters:
-
| theHostname | is a hostname of the caller |
| thePID | is a process ID of the caller |
| isLocal | is set True if the GenericAttribute is launched locally with the caller |
void SALOME::GenericObj::Register |
( |
|
) |
[inherited] |
Increase the reference count (mark as used by another object).
void SALOME::GenericObj::Destroy |
( |
|
) |
[inherited] |
Decrease the reference count (release by another object).