Version: 6.5.0
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Pages
SALOMEDS_Attributes.idl
Go to the documentation of this file.
1 // Copyright (C) 2007-2012 CEA/DEN, EDF R&D, OPEN CASCADE
2 //
3 // Copyright (C) 2003-2007 OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
4 // CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
5 //
6 // This library is free software; you can redistribute it and/or
7 // modify it under the terms of the GNU Lesser General Public
8 // License as published by the Free Software Foundation; either
9 // version 2.1 of the License.
10 //
11 // This library is distributed in the hope that it will be useful,
12 // but WITHOUT ANY WARRANTY; without even the implied warranty of
13 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 // Lesser General Public License for more details.
15 //
16 // You should have received a copy of the GNU Lesser General Public
17 // License along with this library; if not, write to the Free Software
18 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
19 //
20 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
21 //
22 
23 // File : SALOMEDS_Attributes.idl
24 // Author : Yves FRICAUD
25 // $Header: /home/server/cvs/KERNEL/KERNEL_SRC/idl/SALOMEDS_Attributes.idl,v 1.10.2.1.22.4.12.1 2012-04-12 14:04:58 vsr Exp $
26 //
31 #ifndef _SALOMEDS_AttributesIDL_
32 #define _SALOMEDS_AttributesIDL_
33 
34 #include "SALOMEDS.idl"
35 
36 module SALOMEDS
37 {
39  typedef sequence <double> DoubleSeq;
41  typedef sequence <long> LongSeq;
43  typedef sequence <string> StringSeq;
44 
50  struct Color {
52  double R;
54  double G;
56  double B;
57  };
58 
59  //==========================================================================
67  //==========================================================================
69  {
74  double Value();
79  void SetValue(in double value);
80 
81  };
82 
83  //==========================================================================
91  //==========================================================================
93  {
98  long Value();
99 
104  void SetValue(in long value);
105  };
106 
107  //==========================================================================
116  //==========================================================================
118  {
123  void Assign (in DoubleSeq other);
128  DoubleSeq CorbaSequence();
133  void Add (in double value);
139  void Remove(in long index);
145  void ChangeValue(in long index, in double value);
151  double Value(in short index);
156  long Length();
157  };
158 
159  //==========================================================================
168  //==========================================================================
170  {
175  void Assign (in LongSeq other);
180  LongSeq CorbaSequence();
185  void Add (in long value);
191  void Remove(in long index);
197  void ChangeValue(in long index, in long value);
203  long Value(in short index);
208  long Length();
209  };
210 
211  //==========================================================================
222  //==========================================================================
224  {
229  string Value();
234  void SetValue(in string value);
235  };
236 
237  //==========================================================================
254  //==========================================================================
256  {
261  string Value();
266  void SetValue(in string value);
267  };
268 
269  //==========================================================================
276  //==========================================================================
278  {
283  string Value();
288  void SetValue(in string value);
289  };
290 
291  //==========================================================================
302  //==========================================================================
304  {
309  string Value();
314  void SetValue(in string value);
315  };
316 
317  //==========================================================================
328  //==========================================================================
330  {
335  string Value();
340  void SetValue(in string value);
341  };
342 
343  //==========================================================================
351  //==========================================================================
353  {
358  string Value();
363  void SetValue(in string value);
364  };
365 
366  //==========================================================================
374  //==========================================================================
376  {
381  string Value();
386  void SetValue(in string value);
387  };
388 
389  //==========================================================================
390  // Presentation attributes (parameters of the object displaying in the Object browser)
391  //==========================================================================
392 
393  //==========================================================================
407  //==========================================================================
409  {
414  boolean IsDrawable();
419  void SetDrawable(in boolean value);
420  };
421 
422  //==========================================================================
435  //==========================================================================
437  {
442  boolean IsSelectable();
447  void SetSelectable(in boolean value);
448  };
449 
450  //==========================================================================
464  //==========================================================================
466  {
471  boolean IsExpandable();
476  void SetExpandable(in boolean value);
477  };
478 
479  //==========================================================================
489  //==========================================================================
490 
492  {
497  long GetFlags();
502  void SetFlags(in long flags);
508  boolean Get(in long flags);
515  void Set(in long flags, in boolean value);
516  };
517 
518  //==========================================================================
525  //==========================================================================
527  {
534  void SetVisibility(in long viewId, in boolean value);
541  boolean GetVisibility(in long viewId);
542  };
543 
544  //==========================================================================
552  //==========================================================================
554  {
560  boolean IsOpened();
567  void SetOpened(in boolean value);
568  };
569 
570  //==========================================================================
582  //==========================================================================
584  {
589  Color TextColor();
594  void SetTextColor(in Color value);
595  };
596 
597  //==========================================================================
609  //==========================================================================
611  {
616  Color TextHighlightColor();
621  void SetTextHighlightColor(in Color value);
622  };
623 
624  //==========================================================================
635  //==========================================================================
637  {
642  boolean HasPixMap();
647  string GetPixMap();
652  void SetPixMap(in string value);
653  };
654 
655  //==========================================================================
667  //==========================================================================
669  {
674  void SetFather(in AttributeTreeNode father);
679  boolean HasFather();
684  AttributeTreeNode GetFather();
689  void SetPrevious(in AttributeTreeNode sibling);
694  boolean HasPrevious();
699  AttributeTreeNode GetPrevious();
704  void SetNext(in AttributeTreeNode sibling);
709  boolean HasNext();
714  AttributeTreeNode GetNext();
719  void SetFirst(in AttributeTreeNode child);
724  boolean HasFirst();
729  AttributeTreeNode GetFirst();
735  void SetTreeID(in string ID);
740  string GetTreeID();
745  void Append(in AttributeTreeNode child);
750  void Prepend(in AttributeTreeNode child);
755  void InsertBefore(in AttributeTreeNode child);
760  void InsertAfter(in AttributeTreeNode child);
764  void Remove();
771  long Depth();
776  boolean IsRoot();
782  boolean IsDescendant(in AttributeTreeNode other);
788  boolean IsFather(in AttributeTreeNode other);
794  boolean IsChild(in AttributeTreeNode other);
799  string Label();
800  };
801 
802  //==========================================================================
812  //==========================================================================
814  {
819  long Value();
824  void SetValue(in long value);
825  };
826 
827  //==========================================================================
838  //==========================================================================
840  {
845  string Value();
850  void SetValue(in string value);
851  };
852 
853  //==========================================================================
864  //==========================================================================
865 
867  {
872  void Add(in SObject refobj);
882  void Remove(in SObject anObject);
883  };
884 
885  //==========================================================================
896  //==========================================================================
897 
899  {
901  exception IncorrectIndex {};
904 
906  enum SortOrder {
908  DescendingOrder
909  };
910 
912  enum SortPolicy {
917  EmptyIgnore
918  };
919 
925  void SetTitle(in string title);
931  string GetTitle();
941  void SetRowTitle(in long row, in string title) raises(IncorrectIndex);
951  string GetRowTitle(in long row) raises(IncorrectIndex);
961  void SetRowTitles(in StringSeq titles) raises(IncorrectArgumentLength);
967  StringSeq GetRowTitles();
977  void SetColumnTitle(in long column, in string title) raises(IncorrectIndex);
987  string GetColumnTitle(in long column) raises(IncorrectIndex);
997  void SetColumnTitles(in StringSeq titles) raises(IncorrectArgumentLength);
1003  StringSeq GetColumnTitles();
1013  void SetRowUnit(in long row, in string unit) raises(IncorrectIndex);
1023  string GetRowUnit(in long row) raises(IncorrectIndex);
1033  void SetRowUnits(in StringSeq units) raises(IncorrectArgumentLength);
1039  StringSeq GetRowUnits();
1045  long GetNbRows();
1051  long GetNbColumns();
1059  boolean HasValue(in long row, in long column);
1069  void RemoveValue(in long row, in long column) raises(IncorrectIndex);
1081  void SetNbColumns(in long columns);
1091  LongSeq GetRowSetIndices(in long row) raises(IncorrectIndex);
1107  LongSeq SortRow(in long row, in SortOrder order, in SortPolicy policy) raises(IncorrectIndex);
1123  LongSeq SortColumn(in long column, in SortOrder order, in SortPolicy policy) raises(IncorrectIndex);
1138  LongSeq SortByRow(in long row, in SortOrder order, in SortPolicy policy) raises(IncorrectIndex);
1153  LongSeq SortByColumn(in long column, in SortOrder order, in SortPolicy policy) raises(IncorrectIndex);
1164  void SwapCells(in long row1, in long column1, in long row2, in long column2) raises(IncorrectIndex);
1173  void SwapRows(in long row1, in long row2) raises(IncorrectIndex);
1182  void SwapColumns(in long column1, in long column2) raises(IncorrectIndex);
1189  boolean ReadFromFile(in SALOMEDS::TMPFile fileStream);
1195  SALOMEDS::TMPFile SaveToFile();
1196  };
1197 
1198  //==========================================================================
1212  //==========================================================================
1213 
1215  {
1225  void AddRow(in LongSeq data) raises(IncorrectArgumentLength);
1236  void SetRow(in long row, in LongSeq data) raises(IncorrectArgumentLength, IncorrectIndex);
1248  LongSeq GetRow(in long row) raises(IncorrectIndex);
1258  void AddColumn(in LongSeq data) raises(IncorrectArgumentLength);
1269  void SetColumn(in long column, in LongSeq data) raises(IncorrectArgumentLength, IncorrectIndex);
1281  LongSeq GetColumn(in long column) raises(IncorrectIndex);
1293  void PutValue(in long value, in long row, in long column) raises(IncorrectIndex);
1305  long GetValue(in long row, in long column) raises(IncorrectIndex);
1306  };
1307 
1308  //==========================================================================
1322  //==========================================================================
1323 
1325  {
1335  void AddRow(in DoubleSeq data) raises(IncorrectArgumentLength);
1346  void SetRow(in long row, in DoubleSeq data) raises(IncorrectArgumentLength, IncorrectIndex);
1358  DoubleSeq GetRow(in long row) raises(IncorrectIndex);
1368  void AddColumn(in DoubleSeq data) raises(IncorrectArgumentLength);
1379  void SetColumn(in long column, in DoubleSeq data) raises(IncorrectArgumentLength, IncorrectIndex);
1391  DoubleSeq GetColumn(in long column) raises(IncorrectIndex);
1403  void PutValue(in double value, in long row, in long volumn) raises(IncorrectIndex);
1415  double GetValue(in long row, in long column) raises(IncorrectIndex);
1416  };
1417 
1418  //==========================================================================
1429  //==========================================================================
1431  {
1441  void AddRow(in StringSeq data) raises(IncorrectArgumentLength);
1452  void SetRow(in long row, in StringSeq data) raises(IncorrectArgumentLength, IncorrectIndex);
1464  StringSeq GetRow(in long row) raises(IncorrectIndex);
1474  void AddColumn(in StringSeq data) raises(IncorrectArgumentLength);
1485  void SetColumn(in long column, in StringSeq data) raises(IncorrectArgumentLength, IncorrectIndex);
1497  StringSeq GetColumn(in long column) raises(IncorrectIndex);
1509  void PutValue(in string value, in long row, in long column) raises(IncorrectIndex);
1521  string GetValue(in long row, in long column) raises(IncorrectIndex);
1522  };
1523 
1524  //==========================================================================
1533  //==========================================================================
1535  {
1540  void SetUserName(in string author);
1545  string GetUserName();
1554  void SetCreationDate(in long minute, in long hour, in long day, in long month, in long year);
1564  boolean GetCreationDate(out long minute, out long hour, out long day, out long month, out long year);
1570  void SetCreationMode(in string mode);
1579  string GetCreationMode();
1584  void SetModified(in long modified);
1589  boolean IsModified();
1594  long GetModified();
1602  void SetLocked(in boolean lock);
1607  boolean IsLocked();
1617  void SetModification(in string author, in long minute, in long hour, in long day, in long month, in long year);
1628  void GetModificationsList(out StringSeq authors, out LongSeq minutes, out LongSeq hours, out LongSeq days, out LongSeq months, out LongSeq years, in boolean withCreator);
1629 
1634  void SetComment(in string comment);
1635 
1640  string GetComment();
1641 
1646  void SetUnits(in string units);
1647 
1652  string GetUnits();
1653  };
1654 
1655  //==========================================================================
1661  //==========================================================================
1663  {
1669  void SetObject(in string pyObject, in boolean isScript);
1674  string GetObject();
1680  boolean IsScript();
1681  };
1682 
1683  //==========================================================================
1694  //==========================================================================
1696  {
1698  exception InvalidIdentifier {};
1699 
1705  void SetInt(in string ID, in long value);
1715  long GetInt(in string ID) raises(InvalidIdentifier);
1721  void SetReal(in string ID, in double value);
1731  double GetReal(in string ID) raises(InvalidIdentifier);
1737  void SetString(in string ID, in string value);
1747  string GetString(in string ID) raises(InvalidIdentifier);
1753  void SetBool(in string ID, in boolean value);
1763  boolean GetBool(in string ID) raises(InvalidIdentifier);
1769  void SetRealArray(in string ID, in DoubleSeq value);
1779  DoubleSeq GetRealArray(in string ID) raises(InvalidIdentifier);
1785  void SetIntArray(in string ID, in LongSeq value);
1795  LongSeq GetIntArray(in string ID) raises(InvalidIdentifier);
1801  void SetStrArray(in string ID, in StringSeq value);
1811  StringSeq GetStrArray(in string ID) raises(InvalidIdentifier);
1819  boolean IsSet(in string ID, in long ptype);
1827  boolean RemoveID(in string ID, in long ptype);
1832  AttributeParameter GetFather();
1837  boolean HasFather();
1842  boolean IsRoot();
1846  void Clear();
1854  StringSeq GetIDs(in long ptype);
1855  };
1856 };
1857 #endif
Attribute allowing to store a sequence of real values.
Definition: SALOMEDS_Attributes.idl:117
Parameter attribute.
Definition: SALOMEDS_Attributes.idl:1695
External file definition.
Definition: SALOMEDS_Attributes.idl:352
Name attribute.
Definition: SALOMEDS_Attributes.idl:223
Flags attribute.
Definition: SALOMEDS_Attributes.idl:491
IOR attribute.
Definition: SALOMEDS_Attributes.idl:303
SortOrder
Sort order.
Definition: SALOMEDS_Attributes.idl:906
This exception is raised when sequence of incorrect length is passed as parameter.
Definition: SALOMEDS_Attributes.idl:903
Opened flag Attribute.
Definition: SALOMEDS_Attributes.idl:553
Python object attribute.
Definition: SALOMEDS_Attributes.idl:1662
Text color attribute.
Definition: SALOMEDS_Attributes.idl:583
double R
Red component of the color.
Definition: SALOMEDS_Attributes.idl:52
Icon attribute.
Definition: SALOMEDS_Attributes.idl:636
Persistent reference attribute.
Definition: SALOMEDS_Attributes.idl:329
This exception is raised when an invalid (out of range) index is passed as parameter.
Definition: SALOMEDS_Attributes.idl:901
Selectable flag attribute.
Definition: SALOMEDS_Attributes.idl:436
string ID
Main identifier of an object in SALOME application.
Definition: SALOMEDS.idl:48
The items are sorted ascending.
Definition: SALOMEDS_Attributes.idl:907
sequence< long > LongSeq
Sequence of long values.
Definition: SALOMEDS_Attributes.idl:41
sequence< SObject > ListOfSObject
Sequence containing SObjects.
Definition: SALOMEDS.idl:154
Attribute allowing to store an integer value.
Definition: SALOMEDS_Attributes.idl:92
Tree node attribute.
Definition: SALOMEDS_Attributes.idl:668
This exception is raised when an invalid identifier is passed as parameter.
Definition: SALOMEDS_Attributes.idl:1698
Table of real values.
Definition: SALOMEDS_Attributes.idl:1324
sequence< octet > TMPFile
A byte stream which is used for binary data transfer between different components.
Definition: SALOMEDS.idl:73
SortPolicy
Sort policy (specifies how empty cells are taken into account when sorting)
Definition: SALOMEDS_Attributes.idl:912
Drawable flag attribute.
Definition: SALOMEDS_Attributes.idl:408
Represents the color based on RGB palette.
Definition: SALOMEDS_Attributes.idl:50
Study properties attribute
Definition: SALOMEDS_Attributes.idl:1534
Table of integer values.
Definition: SALOMEDS_Attributes.idl:1214
Expandable flag attribute.
Definition: SALOMEDS_Attributes.idl:465
Graphic attribute.
Definition: SALOMEDS_Attributes.idl:526
double G
Green component of the color.
Definition: SALOMEDS_Attributes.idl:54
This package contains the interfaces used for creation, management and modification of the Study...
Definition: SALOMEDS.idl:40
Attribute allowing to store a sequence of integer values.
Definition: SALOMEDS_Attributes.idl:169
Empty cells are considered as lowest values.
Definition: SALOMEDS_Attributes.idl:913
Empty cells are considered as highest values.
Definition: SALOMEDS_Attributes.idl:914
Back references attribute.
Definition: SALOMEDS_Attributes.idl:866
String attribute.
Definition: SALOMEDS_Attributes.idl:277
sequence< double > DoubleSeq
Sequence of double values.
Definition: SALOMEDS_Attributes.idl:39
Text highlight color attribute.
Definition: SALOMEDS_Attributes.idl:610
Empty cells are always first.
Definition: SALOMEDS_Attributes.idl:915
SObject interface
Definition: SALOMEDS.idl:1006
double B
Blue component of the color.
Definition: SALOMEDS_Attributes.idl:56
Empty cells are always last.
Definition: SALOMEDS_Attributes.idl:916
Attribute storing GUID.
Definition: SALOMEDS_Attributes.idl:839
Comment attribute.
Definition: SALOMEDS_Attributes.idl:255
This file contains a set of interfaces used for creation, management and modification of the Study...
Table of string values.
Definition: SALOMEDS_Attributes.idl:1430
sequence< string > StringSeq
Sequence of string values.
Definition: SALOMEDS_Attributes.idl:43
Generic attribute interface
Definition: SALOMEDS.idl:1125
Generic table attribute.
Definition: SALOMEDS_Attributes.idl:898
External file type definition.
Definition: SALOMEDS_Attributes.idl:375
Local identifier attribute.
Definition: SALOMEDS_Attributes.idl:813
Attribute allowing to store a real value.
Definition: SALOMEDS_Attributes.idl:68
Copyright © 2007-2012 CEA/DEN, EDF R&D, OPEN CASCADE
Copyright © 2003-2007 OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN, CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS