31 #ifndef _SALOMEDS_AttributesIDL_
32 #define _SALOMEDS_AttributesIDL_
133 void Add (in
double value);
1554 void SetCreationDate(in
long minute, in
long hour, in
long day, in
long month, in
long year);
1617 void SetModification(in
string author, in
long minute, in
long hour, in
long day, in
long month, in
long year);
static std::ostream * out
Definition: DSC_interface.cxx:381
This file contains a set of interfaces used for creation, management and modification of the Study.
This exception is raised when an invalid identifier is passed as parameter.
Definition: SALOMEDS_Attributes.idl:1719
This exception is raised when sequence of incorrect length is passed as parameter.
Definition: SALOMEDS_Attributes.idl:903
This exception is raised when an invalid (out of range) index is passed as parameter.
Definition: SALOMEDS_Attributes.idl:901
Drawable flag attribute.
Definition: SALOMEDS_Attributes.idl:409
void SetDrawable(in boolean value)
Sets the value of the attribute.
boolean IsDrawable()
Returns the value of the attribute.
Expandable flag attribute.
Definition: SALOMEDS_Attributes.idl:466
void SetExpandable(in boolean value)
Sets the value of the attribute.
boolean IsExpandable()
Returns the value of the attribute.
External file definition.
Definition: SALOMEDS_Attributes.idl:353
string Value()
Returns the value of the attribute.
void SetValue(in string value)
Sets the value of the attribute.
External file type definition.
Definition: SALOMEDS_Attributes.idl:376
void SetValue(in string value)
Sets the value of the attribute.
string Value()
Returns the value of the attribute.
Flags attribute.
Definition: SALOMEDS_Attributes.idl:492
void Set(in long flags, in boolean value)
Set/clear specific flag or set of flags.
long GetFlags()
Returns the value of the attribute.
void SetFlags(in long flags)
Sets the value of the attribute.
boolean Get(in long flags)
Test the value for the specified flag or set of flags.
Graphic attribute.
Definition: SALOMEDS_Attributes.idl:527
void SetVisibility(in long viewId, in boolean value)
Set / clear visibility flag of the parent SObject for the view specified by viewId.
boolean GetVisibility(in long viewId)
Get visibility flag of the parent SObject for the view specified by viewId.
IOR attribute.
Definition: SALOMEDS_Attributes.idl:304
string Value()
Returns the value of the attribute.
void SetValue(in string value)
Sets the value of the attribute (IOR of a SObject).
Attribute allowing to store an integer value.
Definition: SALOMEDS_Attributes.idl:93
long Value()
Returns the value of the attribute.
void SetValue(in long value)
Sets the value of the attribute.
Local identifier attribute.
Definition: SALOMEDS_Attributes.idl:814
void SetValue(in long value)
Sets the value of the attribute.
long Value()
Returns the value of the attribute.
Name attribute.
Definition: SALOMEDS_Attributes.idl:224
string Value()
Returns the value assigned to the attribute.
void SetValue(in string value)
Sets the value of the attribute (name of a SObject).
Opened flag Attribute.
Definition: SALOMEDS_Attributes.idl:554
void SetOpened(in boolean value)
Sets the value of the attribute.
boolean IsOpened()
Returns the value of the attribute.
Parameter attribute.
Definition: SALOMEDS_Attributes.idl:1717
void Clear()
Clears the content of the attribute.
AttributeParameter GetFather()
Returns a father attribute of this attribute.
void SetString(in string ID, in string value)
Associates string value with the unique identifier.
void SetIntArray(in string ID, in LongSeq value)
Associates integer array value with the unique identifier.
boolean IsSet(in string ID, in long ptype)
Checks if the value of specified type is set for the identifier.
boolean IsRoot()
Check if this attribute is a root (top-level) parameter attribute.
void SetInt(in string ID, in long value)
Associates integer value with the unique identifier.
string GetString(in string ID)
Returns string value associated with the specified identifier.
boolean GetBool(in string ID)
Returns boolean value associated with the specified identifier.
long GetInt(in string ID)
Returns integer value associated with the specified identifier.
double GetReal(in string ID)
Returns real value associated with the specified identifier.
void SetRealArray(in string ID, in DoubleSeq value)
Associates real array value with the unique identifier.
void SetStrArray(in string ID, in StringSeq value)
Associates string array value with the unique identifier.
StringSeq GetStrArray(in string ID)
Returns string array value associated with the specified identifier.
void SetBool(in string ID, in boolean value)
Associates boolean value with the unique identifier.
DoubleSeq GetRealArray(in string ID)
Returns real array value associated with the specified identifier.
LongSeq GetIntArray(in string ID)
Returns integer array value associated with the specified identifier.
void SetReal(in string ID, in double value)
Associates real value with the unique identifier.
boolean RemoveID(in string ID, in long ptype)
Removes value of specified type from the named parameter.
StringSeq GetIDs(in long ptype)
Returns a sequence of parameters identifiers of the specified type stored in the attribute.
boolean HasFather()
Check if this attribute has parent parameter attribute.
Persistent reference attribute.
Definition: SALOMEDS_Attributes.idl:330
void SetValue(in string value)
Sets the value of the attribute.
string Value()
Returns the value of the attribute.
Icon attribute.
Definition: SALOMEDS_Attributes.idl:637
string GetPixMap()
Returns the value of the attribute.
void SetPixMap(in string value)
Sets the value of the attribute.
boolean HasPixMap()
Checks if the pixmap is assigned to the attribute.
Python object attribute.
Definition: SALOMEDS_Attributes.idl:1684
void SetObject(in string pyObject, in boolean isScript)
Sets a Python object converted into a sequence of characters to the attribute.
string GetObject()
Returns a Python object stored in the attribute as a sequence of characters.
boolean IsScript()
Check if the value stored in the attribute is a Python script.
Attribute allowing to store a real value.
Definition: SALOMEDS_Attributes.idl:69
void SetValue(in double value)
Sets the value of the attribute.
double Value()
Returns the value of the attribute.
Selectable flag attribute.
Definition: SALOMEDS_Attributes.idl:437
void SetSelectable(in boolean value)
Sets the value of the attribute.
boolean IsSelectable()
Returns the value of the attribute.
Attribute allowing to store a sequence of integer values.
Definition: SALOMEDS_Attributes.idl:170
void ChangeValue(in long index, in long value)
Sets new value to the sequence by the specified index.
LongSeq CorbaSequence()
Returns the sequence of values stored in the attribute.
void Assign(in LongSeq other)
Initialization of the attribute with initial data.
void Add(in long value)
Adds new value to the end of the sequence.
long Value(in short index)
Returns a value in the sequence specified by its index.
void Remove(in long index)
Removes an value by the specified index from the sequence stored in the attribute.
long Length()
Returns the length of the sequence stored in the attribute.
Attribute allowing to store a sequence of real values.
Definition: SALOMEDS_Attributes.idl:118
double Value(in short index)
Returns a value in the sequence specified by its index.
void Remove(in long index)
Removes a value by the specified index from the sequence stored in the attribute.
DoubleSeq CorbaSequence()
Returns the sequence of values stored in the attribute.
void ChangeValue(in long index, in double value)
Sets new value to the sequence by the specified index.
void Assign(in DoubleSeq other)
Initialization of the attribute with initial data.
long Length()
Returns the length of the sequence stored in the attribute.
void Add(in double value)
Adds new value to the end of the sequence.
String attribute.
Definition: SALOMEDS_Attributes.idl:278
string Value()
Returns the value of the attribute.
void SetValue(in string value)
Sets the value of the attribute.
Study properties attribute
Definition: SALOMEDS_Attributes.idl:1535
void SetModification(in string author, in long minute, in long hour, in long day, in long month, in long year)
Appends modification record to the list of study modifications.
void SetModified(in long modified)
Sets the number of transactions executed after the last saving of the study.
StringSeq GetComponentVersions(in string comp)
Returns all versions of component data stored in the study.
string GetUserName()
Returns the name of the study author.
long GetModified()
Returns the number of transactions executed after the last saving of the study.
string GetUnits()
Returns units of the study.
string GetComment()
Returns comment of the study.
string GetComponentVersion(in string comp)
Returns version of component data stored in the study.
void SetLocked(in boolean lock)
Lock/unlock the study for modifications.
void SetCreationDate(in long minute, in long hour, in long day, in long month, in long year)
Sets creation date of the study.
void SetUnits(in string units)
Sets the units of the study.
void SetUserName(in string author)
Sets the name of the study author to the attribute.
void SetCreationMode(in string mode)
Sets creation mode of the study.
void SetComment(in string comment)
Sets the comment of the study.
boolean GetCreationDate(out long minute, out long hour, out long day, out long month, out long year)
Returns creation date of the study.
StringSeq GetStoredComponents()
Returns list of components which data was stored (after previous sessions) in the study.
boolean IsModified()
Check if study has been modified since last saving operation.
string GetCreationMode()
Returns creation mode of the study.
boolean IsLocked()
Check if study is locked.
void GetModificationsList(out StringSeq authors, out LongSeq minutes, out LongSeq hours, out LongSeq days, out LongSeq months, out LongSeq years, in boolean withCreator)
Returns list of all the study modification records.
Table of integer values.
Definition: SALOMEDS_Attributes.idl:1215
void PutValue(in long value, in long row, in long column)
Puts a value to the table cell specified by row and column indices.
void AddRow(in LongSeq data)
Appends new row to the table.
long GetValue(in long row, in long column)
Returns the value from the cell table.
LongSeq GetRow(in long row)
Returns all the values of the specified row in the table.
void AddColumn(in LongSeq data)
Appends new column to the table.
LongSeq GetColumn(in long column)
Returns all the values of the specified column in the table.
void SetRow(in long row, in LongSeq data)
Replaces all the elements of the specified row with new values.
void SetColumn(in long column, in LongSeq data)
Replaces all the elements of the specified column with new values.
Table of real values.
Definition: SALOMEDS_Attributes.idl:1325
double GetValue(in long row, in long column)
Returns the value from the cell table.
DoubleSeq GetColumn(in long column)
Returns all the values of the specified column in the table.
void AddColumn(in DoubleSeq data)
Appends new column to the table.
void PutValue(in double value, in long row, in long volumn)
Puts a value to the table cell specified by row and column indices.
void SetColumn(in long column, in DoubleSeq data)
Replaces all the elements of the specified column with new values.
DoubleSeq GetRow(in long row)
Returns all the values of the specified row in the table.
void AddRow(in DoubleSeq data)
Appends new row to the table.
void SetRow(in long row, in DoubleSeq data)
Replaces all the elements of the specified row with new values.
Table of string values.
Definition: SALOMEDS_Attributes.idl:1431
void SetColumn(in long column, in StringSeq data)
Replaces all the elements of the specified column with new values.
void PutValue(in string value, in long row, in long column)
Puts a value to the table cell specified by row and column indices.
void SetRow(in long row, in StringSeq data)
Replaces all the elements of the specified row with new values.
void AddColumn(in StringSeq data)
Appends new column to the table.
StringSeq GetRow(in long row)
Returns all the values of the specified row in the table.
StringSeq GetColumn(in long column)
Returns all the values of the specified column in the table.
void AddRow(in StringSeq data)
Appends new row to the table.
string GetValue(in long row, in long column)
Returns the value from the cell table.
Generic table attribute.
Definition: SALOMEDS_Attributes.idl:899
void SwapColumns(in long column1, in long column2)
Swap two table columns.
long GetNbColumns()
Returns the number of columns of the table.
void SetRowUnit(in long row, in string unit)
Assigns the unit label to the row with specified index.
void SetNbColumns(in long columns)
Sets the maximum number of columns in the table.
void SetTitle(in string title)
Sets the main title of the table.
void SetColumnTitles(in StringSeq titles)
Sets the titles for all columns in the table.
boolean HasValue(in long row, in long column)
Check if the value is set for the cell with specified row and column indices.
StringSeq GetColumnTitles()
Returns the titles of all columns of the table.
void SwapRows(in long row1, in long row2)
Swap two table rows.
LongSeq SortByRow(in long row, in SortOrder order, in SortPolicy policy)
Sort table columns by the specified row.
LongSeq SortRow(in long row, in SortOrder order, in SortPolicy policy)
Sort values in the specified table row.
SortPolicy
Sort policy (specifies how empty cells are taken into account when sorting)
Definition: SALOMEDS_Attributes.idl:912
@ EmptyLowest
Empty cells are considered as lowest values.
Definition: SALOMEDS_Attributes.idl:913
@ EmptyHighest
Empty cells are considered as highest values.
Definition: SALOMEDS_Attributes.idl:914
@ EmptyLast
Empty cells are always last.
Definition: SALOMEDS_Attributes.idl:916
@ EmptyFirst
Empty cells are always first.
Definition: SALOMEDS_Attributes.idl:915
string GetTitle()
Returns the title of the table.
void SetColumnTitle(in long column, in string title)
Sets the title of a column with specified index.
void SetRowUnits(in StringSeq units)
Sets the unit labels for all rows in the table.
void RemoveValue(in long row, in long column)
Clear value in the specified table cell.
LongSeq SortByColumn(in long column, in SortOrder order, in SortPolicy policy)
Sort table rows by the specified column.
SALOMEDS::TMPFile SaveToFile()
Saves a table into a byte stream.
SortOrder
Sort order.
Definition: SALOMEDS_Attributes.idl:906
@ AscendingOrder
The items are sorted ascending.
Definition: SALOMEDS_Attributes.idl:907
string GetColumnTitle(in long column)
Returns the title of a column with specified index.
long GetNbRows()
Returns the number of rows of the table.
string GetRowUnit(in long row)
Returns the unit label of a row with specified index.
LongSeq GetRowSetIndices(in long row)
Returns the indices of the columns in the specified row for which values are set.
StringSeq GetRowTitles()
Returns the titles of all rows of the table.
void SetRowTitles(in StringSeq titles)
Sets the titles for all rows in the table.
void SwapCells(in long row1, in long column1, in long row2, in long column2)
Swap values in two table cells.
StringSeq GetRowUnits()
Returns the unit labels of all rows of the table.
string GetRowTitle(in long row)
Returns the title of a row with specified index.
boolean ReadFromFile(in SALOMEDS::TMPFile fileStream)
Reads a table from a byte stream.
void SetRowTitle(in long row, in string title)
Sets the title of a row with specified index.
LongSeq SortColumn(in long column, in SortOrder order, in SortPolicy policy)
Sort values in the specified table column.
Back references attribute.
Definition: SALOMEDS_Attributes.idl:867
void Remove(in SObject anObject)
Removes specified SObject from the list of SObjects which refer to the owner SObject.
void Add(in SObject refobj)
Adds specified SObject to the list of SObjects which refer to the owner SObject.
SALOMEDS::Study::ListOfSObject Get()
Returns a list of SObjects which refer to the owner SObject.
Text color attribute.
Definition: SALOMEDS_Attributes.idl:584
Color TextColor()
Returns the value of the attribute.
void SetTextColor(in Color value)
Sets the value of the attribute.
Text highlight color attribute.
Definition: SALOMEDS_Attributes.idl:611
void SetTextHighlightColor(in Color value)
Sets the value of the attribute.
Color TextHighlightColor()
Returns the value of the attribute.
Tree node attribute.
Definition: SALOMEDS_Attributes.idl:669
boolean IsDescendant(in AttributeTreeNode other)
Checks if the tree node is a descendant of the specified tree node.
boolean HasFather()
Checks if father tree node attribute is set for this tree node.
boolean IsRoot()
Checks if the tree node is a root of the tree.
string GetTreeID()
Returns identifier of the parent tree.
void Prepend(in AttributeTreeNode child)
Puts specified tree node to the beginning of the children list of this tree node.
AttributeTreeNode GetNext()
Returns the next sibling tree node of this tree node.
void Append(in AttributeTreeNode child)
Appends specified tree node to the end of the children list of this tree node.
string Label()
Returns string identifier of the owner SObject (e.g.
AttributeTreeNode GetPrevious()
Returns the previous sibling tree node of this tree node.
boolean IsChild(in AttributeTreeNode other)
Checks if this tree node is a child of the specified tree node other.
void InsertAfter(in AttributeTreeNode child)
Insert specified tree node as a next child in the parent tree node's children list.
void SetFather(in AttributeTreeNode father)
Assigns the father tree node to this tree node.
boolean HasPrevious()
Checks if previous sibling tree node attribute is set for this tree node.
boolean IsFather(in AttributeTreeNode other)
Checks if this tree node is a parent of the specified tree node other.
void SetNext(in AttributeTreeNode sibling)
Assigns the next sibling tree node to this tree node.
void SetTreeID(in string ID)
Sets identifier of the parent tree to this tree node.
long Depth()
Returns the depth of the tree node in the tree structure.
void SetPrevious(in AttributeTreeNode sibling)
Assigns the previous sibling tree node to this tree node.
boolean HasFirst()
Checks if first child tree node attribute is set for this tree node.
AttributeTreeNode GetFirst()
Returns the first child tree node of this tree node.
void InsertBefore(in AttributeTreeNode child)
Insert specified tree node as a previous child in the parent tree node's children list.
void SetFirst(in AttributeTreeNode child)
Sets the specified tree node as a first child of this tree node.
boolean HasNext()
Checks if next sibling tree node attribute is set for this tree node.
AttributeTreeNode GetFather()
Returns the father tree node of this tree node.
void Remove()
Removes this tree node.
Attribute storing GUID.
Definition: SALOMEDS_Attributes.idl:840
string Value()
Returns the value of the attribute.
void SetValue(in string value)
Sets the value of the attribute.
Generic attribute interface
Definition: SALOMEDS.idl:989
SObject interface
Definition: SALOMEDS.idl:873
sequence< SObject > ListOfSObject
Indicate the file where the study has been saved.
Definition: SALOMEDS.idl:413
This package contains the interfaces used for creation, management and modification of the Study.
Definition: SALOMEDS.hxx:37
void lock()
Definition: SALOMEDS.cxx:60
sequence< double > DoubleSeq
Sequence of double values.
Definition: SALOMEDS_Attributes.idl:39
sequence< string > StringSeq
Sequence of string values.
Definition: SALOMEDS_Attributes.idl:43
sequence< octet > TMPFile
A byte stream which is used for binary data transfer between different components.
Definition: SALOMEDS.idl:67
string ID
Main identifier of an object in SALOME application.
Definition: SALOMEDS.idl:48
sequence< long > LongSeq
Sequence of long values.
Definition: SALOMEDS_Attributes.idl:41
comp
Definition: TestLifeCycleCORBA.py:38
index
Definition: python_test_driver.py:105
flags
Definition: salome.py:91
Represents the color based on RGB palette.
Definition: SALOMEDS_Attributes.idl:50
double G
Green component of the color.
Definition: SALOMEDS_Attributes.idl:54
double R
Red component of the color.
Definition: SALOMEDS_Attributes.idl:52
double B
Blue component of the color.
Definition: SALOMEDS_Attributes.idl:56