SALOMEDS::AttributeTableOfString Interface Reference

AttributeTableOfString interface More...

import "SALOMEDS_Attributes.idl";

Inheritance diagram for SALOMEDS::AttributeTableOfString:

Collaboration diagram for SALOMEDS::AttributeTableOfString:


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 StringSeq theData) raises (IncorrectArgumentLength)
void	SetRow (in long theRow, in StringSeq theData) raises (IncorrectArgumentLength, IncorrectIndex)
StringSeq	GetRow (in long theRow) raises (IncorrectIndex)
void	AddColumn (in StringSeq theData) raises (IncorrectArgumentLength)
void	SetColumn (in long theColumn, in StringSeq theData) raises (IncorrectArgumentLength, IncorrectIndex)
StringSeq	GetColumn (in long theColumn) raises (IncorrectIndex)
void	PutValue (in string theValue, in long theRow, in long theColumn) raises (IncorrectIndex)
boolean	HasValue (in long theRow, in long theColumn)
string	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 ()
string	GetClassType ()
SObject	GetSObject ()
long	GetLocalImpl (in string theHostname, in long thePID, out boolean isLocal)
void	Register ()
void	Destroy ()
Data Structures
exception	IncorrectArgumentLength
exception	IncorrectIndex

Detailed Description

This attribute allows to store a table of strings (indexing from 1 like in CASCADE) and string titles of this table, of each row, of each column.
See also an example of usage of these methods in batchmode of SALOME application.

Member Function Documentation

void SALOMEDS::AttributeTableOfString::SetTitle ( in string theTitle )

Sets the title of the table.

string SALOMEDS::AttributeTableOfString::GetTitle ( )

Returns the title of the table.

void SALOMEDS::AttributeTableOfString::SetRowTitle ( in long theIndex,

in string theTitle

) raises (IncorrectIndex)

Sets the title of a row with a definite index.

void SALOMEDS::AttributeTableOfString::SetRowTitles ( in StringSeq theTitles ) raises (IncorrectArgumentLength)

Sets the titles for all rows of the table.

StringSeq SALOMEDS::AttributeTableOfString::GetRowTitles ( )

Returns the titles of all rows of the table.

void SALOMEDS::AttributeTableOfString::SetColumnTitle ( in long theIndex,

in string theTitle

) raises (IncorrectIndex)

Sets the title of a column with a definite index.

void SALOMEDS::AttributeTableOfString::SetColumnTitles ( in StringSeq theTitles ) raises (IncorrectArgumentLength)

Sets the titles for all columns of the table.

StringSeq SALOMEDS::AttributeTableOfString::GetColumnTitles ( )

Returns the titles of all columns of the table.

void SALOMEDS::AttributeTableOfString::SetRowUnit ( in long theIndex,

in string theUnit

) raises (IncorrectIndex)

Sets the unit of a row with a definite index.

void SALOMEDS::AttributeTableOfString::SetRowUnits ( in StringSeq theUnits ) raises (IncorrectArgumentLength)

Sets the units for all rows of the table.

StringSeq SALOMEDS::AttributeTableOfString::GetRowUnits ( )

Returns the units of all rows of the table.

long SALOMEDS::AttributeTableOfString::GetNbRows ( )

Returns the number of rows of the table.

long SALOMEDS::AttributeTableOfString::GetNbColumns ( )

Returns the number of columns of the table.

void SALOMEDS::AttributeTableOfString::AddRow ( in StringSeq theData ) raises (IncorrectArgumentLength)

Adds a row to the end of the table.

void SALOMEDS::AttributeTableOfString::SetRow ( in long theRow,

in StringSeq theData

) raises (IncorrectArgumentLength, IncorrectIndex)

Sets the values of all elements of the row.

StringSeq SALOMEDS::AttributeTableOfString::GetRow ( in long theRow ) raises (IncorrectIndex)

Returns the row of the table.

void SALOMEDS::AttributeTableOfString::AddColumn ( in StringSeq theData ) raises (IncorrectArgumentLength)

Adds a column to the end of the table.

void SALOMEDS::AttributeTableOfString::SetColumn ( in long theColumn,

in StringSeq theData

) raises (IncorrectArgumentLength, IncorrectIndex)

Sets the values of all elements of the column.

StringSeq SALOMEDS::AttributeTableOfString::GetColumn ( in long theColumn ) raises (IncorrectIndex)

Returns the column of the table.

void SALOMEDS::AttributeTableOfString::PutValue ( in string 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::AttributeTableOfString::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

string SALOMEDS::AttributeTableOfString::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::AttributeTableOfString::SetNbColumns ( in long theNbColumns )

Sets the max number of colums in the table.
Note:
It'd better to set it before filling the table.

LongSeq SALOMEDS::AttributeTableOfString::GetRowSetIndices ( in long theRow ) raises (IncorrectIndex)

Returns the indices of the row where the values are defined.

boolean SALOMEDS::AttributeTableOfString::ReadFromFile ( in SALOMEDS::TMPFile theStream )

Reads a table from a file.

SALOMEDS::TMPFile SALOMEDS::AttributeTableOfString::SaveToFile ( )

Saves a table into a file.

void SALOMEDS::GenericAttribute::CheckLocked ( ) raises (LockProtection) [inherited]

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

SALOMEDS::AttributeTableOfString Interface Reference

Public Member Functions

Data Structures

Detailed Description

Member Function Documentation