1 //=====================================================
3 // Created : Thu Jul 4 19:25:39 2002
4 // Author : Yves FRICAUD
6 // Copyright : Open CASCADE 2002
8 //=====================================================
9 //The following attributes can be assigned to SObject
10 //=====================================================
11 /*! \file SALOMEDS_Attributes.idl This file contains a set of interfaces
12 for the attributes which can be assigned to %SObject
14 #ifndef _SALOMEDS_AttributesIDL_
15 #define _SALOMEDS_AttributesIDL_
17 #include "SALOMEDS.idl"
21 /*! Sequence of double values
23 typedef sequence <double> DoubleSeq;
24 /*! Sequence of long values
26 typedef sequence <long> LongSeq;
27 /*! Sequence of string values
29 typedef sequence <string> StringSeq;
31 This structure stores a set of elements defining the color based on RGB.
44 //==========================================================================
45 /*! \brief Attribute allowing to store a real value
47 Attribute allowing to store a real value
49 //==========================================================================
50 interface AttributeReal : GenericAttribute
53 Returns the value of this attribute.
54 <BR><VAR>See also <A href=exemple/Example1.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
57 const string Value__doc__ = "Returns the value of this attribute.";
59 Sets the value of this attribute.
60 <BR><VAR>See also <A href=exemple/Example1.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
62 void SetValue(in double value);
63 const string SetValue__doc__ = "Sets the value of this attribute.";
65 const string AttributeReal__doc__ = "Attribute allowing to store a real value.";
66 //==========================================================================
67 /*! \brief Attribute allowing to store an integer value
69 Attribute allowing to store an integer value
71 //==========================================================================
72 interface AttributeInteger : GenericAttribute
75 Returns the value of this attribute
76 <BR><VAR>See also <A href=exemple/Example1.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
79 const string Value__doc__ = "Returns the value of this attribute.";
81 Sets the value of this attribute
82 <BR><VAR>See also <A href=exemple/Example1.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
84 void SetValue(in long value);
85 const string SetValue__doc__ = "Sets the value of this attribute.";
87 const string AttributeInteger__doc__ = "Attribute allowing to store an integer value.";
88 //==========================================================================
89 /*! \brief Attribute - sequence of real values
91 Attribute - sequence of real values, indexing from 1 (like in CASCADE).
93 //==========================================================================
94 interface AttributeSequenceOfReal : GenericAttribute
97 Initialization of the attribute with initial data.
98 \param other Initially assigned sequence of real numbers.
100 void Assign (in DoubleSeq other);
101 const string Assign__doc__ = "Initialization of the attribute with initial data.";
103 Returns the sequence of real numbers stored in the attribute.
105 DoubleSeq CorbaSequence();
106 const string CorbaSequence__doc__ = "Returns the sequence of real numbers stored in the attribute.";
108 Adds to the end of the sequence a real number.
109 \param value A real number added to the sequence.
111 <BR><VAR>See also <A href=exemple/Example3.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
113 void Add (in double value);
114 const string Add__doc__ = "Adds to the end of the sequence a real number.";
116 Removes a real number with a definite index
117 from the sequence of real numbers stored in the Attribute.
119 void Remove(in long index);
120 const string Remove__doc__ = "Removes a real number with a definite index from the sequence of real numbers stored in the attribute.";
122 Substitutes a real number with a definite index for another real number.
123 <BR><VAR>See also <A href=exemple/Example3.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
126 void ChangeValue(in long index, in double value);
127 const string ChangeValue__doc__ = "Substitutes a real number with a definite index for another real number.";
129 Returns a real number with a definite index
130 in the sequence of real numbers stored in the Attribute.
131 <BR><VAR>See also <A href=exemple/Example1.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
133 double Value(in short index);
134 const string Value__doc__ = "Returns a real number with a definite index in the \nsequence of real numbers stored in the attribute.";
136 Returns the length of the sequence of real numbers stored in the Attribute.
137 <BR><VAR>See also <A href=exemple/Example3.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
141 const string Length__doc__ = "Returns the length of the sequence of real numbers stored in the attribute.";
143 const string AttributeSequenceOfReal__doc__ = "Attribute - sequence of real values.";
144 //==========================================================================
145 /*! \brief Attribute - sequence of integer
147 Attribute - sequence of integer, indexing from 1 (like in CASCADE)
149 //==========================================================================
150 interface AttributeSequenceOfInteger : GenericAttribute
153 Initialization of the attribute with initial data.
154 \param other Initially assigned sequence of integer numbers.
156 void Assign (in LongSeq other);
157 const string Assign__doc__ = "Initialization of the attribute with initial data.";
159 Returns the sequence of integer numbers stored in the Attribute.
161 LongSeq CorbaSequence();
162 const string CorbaSequence__doc__ = "Returns the sequence of integer numbers stored in the attribute.";
164 Adds to the end of the sequence an integer number.
165 \param value An integer number added to the sequence.
167 <BR><VAR>See also <A href=exemple/Example3.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
170 void Add (in long value);
171 const string Add__doc__ = "Adds to the end of the sequence an integer number.";
173 Removes an integer number with a definite index
174 from the sequence of integer numbers stored in the Attribute.
175 <BR><VAR>See also <A href=exemple/Example3.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
178 void Remove(in long index);
179 const string Remove__doc__ = "Removes an integer number with a definite index from the sequence of integer numbers stored in the attribute.";
181 Substitutes an integer number with a definite index for another integer number.
183 void ChangeValue(in long index, in long value);
184 const string ChangeValue__doc__ = "Substitutes an integer number with a definite index for another integer number.";
186 Returns an integer number with a definite index
187 in the sequence of integer numbers stored in the Attribute.
188 <BR><VAR>See also <A href=exemple/Example1.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
190 long Value(in short index);
191 const string Value__doc__ = "Returns an integer number with a definite index in the \nsequence of integer numbers stored in the attribute.";
193 Returns the length of the sequence of integer numbers stored in the Attribute.
194 <BR><VAR>See also <A href=exemple/Example3.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
198 const string Length__doc__ = "Returns the length of the sequence of integer numbers stored in the attribute.";
201 //==========================================================================
202 /*! \brief Name attribute
204 This attribute stores a string value, which corresponds to the name of the %SObject
205 or to the name of corresponding object.
207 //==========================================================================
209 interface AttributeName : GenericAttribute
212 Returns the value of this attribute
213 <BR><VAR>See also <A href=exemple/Example1.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
216 const string Value__doc__ = "Returns the value of this attribute.";
218 Sets the value of this attribute
219 <BR><VAR>See also <A href=exemple/Example1.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
221 void SetValue(in string value);
222 const string SetValue__doc__ = "Sets the value of this attribute.";
224 const string AttributeName__doc__ = "This attribute stores a string value, which corresponds to the name of the SObject \nor to the name of corresponding object.";
226 //==========================================================================
227 /*! \brief Comment attribute
229 This attribute stores a string value containing supplementary information about
230 the %SObject. In particular it contains the data type of the %SComponent.
232 //==========================================================================
233 interface AttributeComment : GenericAttribute
236 Returns the value of this attribute
237 <BR><VAR>See also <A href=exemple/Example1.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
240 const string Value__doc__ = "Returns the value of this attribute.";
242 Sets the value of this attribute
243 <BR><VAR>See also <A href=exemple/Example1.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
245 void SetValue(in string value);
246 const string SetValue__doc__ = "Sets the value of this attribute.";
248 const string AttributeComment__doc__ = "This attribute stores a string value containing supplementary information about \nthe SObject. In particular it contains the data type of the SComponent.";
249 //==========================================================================
250 /*! \brief IOR attribute
252 This attribute stores a string value identifying a runtime object.In particular
253 it contains CORBA Interoperable Object Reference.
255 //==========================================================================
256 interface AttributeIOR : GenericAttribute
259 Returns the value of this attribute
260 <BR><VAR>See also <A href=exemple/Example1.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
263 const string Value__doc__ = "Returns the value of this attribute.";
265 Sets the value of this attribute
266 <BR><VAR>See also <A href=exemple/Example1.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
268 void SetValue(in string value);
269 const string SetValue__doc__ = "Sets the value of this attribute.";
271 const string AttributeIOR__doc__ = "This attribute stores a string value identifying a runtime object.\nIn particular it contains CORBA Interoperable Object Reference.";
273 //==========================================================================
274 /*! \brief Persistent reference attribute
276 This attribute stores a persistent identifier of the object.
278 //==========================================================================
279 interface AttributePersistentRef : GenericAttribute
282 Returns the value of this attribute
283 <BR><VAR>See also <A href=exemple/Example1.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
286 const string Value__doc__ = "Returns the value of this attribute.";
288 Sets the value of this attribute
289 <BR><VAR>See also <A href=exemple/Example1.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
291 void SetValue(in string value);
292 const string SetValue__doc__ = "Sets the value of this attribute.";
294 const string AttributePersistentRef__doc__ = "This attribute stores a persistent identifier of the object.";
296 //==========================================================================
297 //Below the list of presentation attributes for display study tree in browser
298 //==========================================================================
301 //==========================================================================
302 /*! \brief Drawable flag Attribute.
304 This is a presentation attribute necessary for display of the study tree in the browser.
305 The item associated to SObject is created/displayed if TRUE.
307 //==========================================================================
308 interface AttributeDrawable : GenericAttribute
311 Returns TRUE if the item is drawable (as it is by default) and FALSE if it isn't.
312 <BR><VAR>See also <A href=exemple/Example8.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
315 boolean IsDrawable();
316 const string IsDrawable__doc__ = "Returns TRUE if the item is drawable (as it is by default) and FALSE if it isn't.";
318 Sets the items to be drawable if <VAR>value</VAR> is TRUE (the default) or not to be selectable if <VAR>value</VAR>is FALSE.
319 <BR><VAR>See also <A href=exemple/Example8.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
322 void SetDrawable(in boolean value);
323 const string SetDrawable__doc__ = "Sets the items to be drawable if value is TRUE (the default) or not to be selectable if value is FALSE.";
325 const string AttributeDrawable__doc__ = "This is a presentation attribute necessary for display of the study tree in the browser. \nThe item associated to SObject is created/displayed if TRUE.";
327 //==========================================================================
328 /*! \brief Selectable flag Attribute.
330 This is a presentation attribute necessary for display of the study tree in the browser.
331 The item is selectable by %SALOME selection mechanism if TRUE.
333 //==========================================================================
334 interface AttributeSelectable : GenericAttribute
337 Returns TRUE if the item is selectable (as it is by default) and FALSE if it isn't.
338 <BR><VAR>See also <A href=exemple/Example9.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
341 boolean IsSelectable();
342 const string IsSelectable__doc__ = "Returns TRUE if the item is selectable (as it is by default) and FALSE if it isn't.";
344 Sets the items to be selectable if <VAR>value</VAR> is TRUE (the default) or not to be selectable if <VAR>value</VAR>is FALSE.
345 <BR><VAR>See also <A href=exemple/Example9.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
348 void SetSelectable(in boolean value);
349 const string SetSelectable__doc__ = "Sets the items to be selectable if value is TRUE (the default) or not to be selectable if value is FALSE.";
351 const string AttributeSelectable__doc__ = "This is a presentation attribute necessary for display of the study tree in the browser. \nThe item is selectable by SALOME selection mechanism if TRUE.";
353 //==========================================================================
354 /*! \brief Expandable flag Attribute.
356 This is a presentation attribute necessary for display of the study tree in the browser.
357 It sets this item to be expandable even if it has no children if value is TRUE. If value is FALSE
358 expandable only if it has children.
360 //==========================================================================
361 interface AttributeExpandable : GenericAttribute
364 Returns TRUE if this item is expandable even when it has no children.
365 <BR><VAR>See also <A href=exemple/Example10.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
368 boolean IsExpandable();
369 const string IsExpandable__doc__ = "Returns TRUE if this item is expandable even when it has no children.";
371 Sets this item to be expandable even if it has no children if <VAR>value</VAR> is TRUE, and to be
372 expandable only if it has children if <VAR>value</VAR> is FALSE (the default).
373 <BR><VAR>See also <A href=exemple/Example10.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
376 void SetExpandable(in boolean value);
377 const string SetExpandable__doc__ = "Sets this item to be expandable even if it has no children if value is TRUE, and to be \nexpandable only if it has children if value is FALSE (the default).";
379 const string AttributeExpandable__doc__ = "This is a presentation attribute necessary for display of the study tree in the browser. \nIt sets this item to be expandable even if it has no children if value is TRUE. \nIf value is FALSE expandable only if it has children.";
381 //==========================================================================
382 /*! \brief Opened flag Attribute.
384 This is a presentation attribute necessary for display of the study tree in the browser.
385 It sets this item to be open (its children are visible) if bool is TRUE, and to be closed (its children
386 are not visible) if bool is FALSE.
388 //==========================================================================
389 interface AttributeOpened : GenericAttribute
392 Returns TRUE if this item is open (its children are visible) and FALSE if it isn't.
393 <BR><VAR>See also <A href=exemple/Example11.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
397 const string IsOpened__doc__ = "Returns TRUE if this item is open (its children are visible) and FALSE if it isn't.";
399 Sets this item to be open (its children are visible) if <VAR>value</VAR> is TRUE, and to be closed
400 (its children are not visible) if <VAR>value</VAR> is FALSE.
401 <BR><VAR>See also <A href=exemple/Example11.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
404 void SetOpened(in boolean value);
405 const string SetOpened__doc__ = "Sets this item to be open (its children are visible) if value is TRUE, and to be closed \n(its children are not visible) if value is FALSE.";
407 const string AttributeOpened__doc__ = "This is a presentation attribute necessary for display of the study tree in the browser. \nIt sets this item to be open (its children are visible) if bool is TRUE, and to be closed (its children \nare not visible) if bool is FALSE.";
408 //==========================================================================
409 /*! \brief TextColorAttribute.
411 This attribute sets the color of an item.
413 //==========================================================================
414 interface AttributeTextColor : GenericAttribute
417 Returns the color of an item.
418 <BR><VAR>See also <A href=exemple/Example12.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
422 const string TextColor__doc__ = "Returns the color of an item.";
424 Sets the color of an item.
425 <BR><VAR>See also <A href=exemple/Example12.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
428 void SetTextColor(in Color value);
429 const string SetTextColor__doc__ = "Sets the color of an item.";
431 const string AttributeTextColor__doc__ = "This attribute sets the color of an item.";
433 //==========================================================================
434 /*! \brief TextHighlightColorAttribute.
436 This attribute sets the highlight color of an item.
438 //==========================================================================
439 interface AttributeTextHighlightColor : GenericAttribute
442 Returns the highlight color of an item.
443 <BR><VAR>See also <A href=exemple/Example13.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
446 Color TextHighlightColor();
447 const string TextHighlightColor__doc__ = "Returns the highlight color of an item.";
449 Sets the highlight color of an item.
450 <BR><VAR>See also <A href=exemple/Example13.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
453 void SetTextHighlightColor(in Color value);
454 const string SetTextHighlightColor__doc__ = "Sets the highlight color of an item.";
456 const string AttributeTextHighlightColor__doc__ = "This attribute sets the highlight color of an item.";
457 //==========================================================================
458 /*! \brief PixMapAttribute.
460 This attribute stores an icon which is put before the name of an item.
462 //==========================================================================
463 interface AttributePixMap : GenericAttribute
466 Returns True if there is an icon before the name of the item.
469 const string HasPixMap__doc__ = "Returns True if there is an icon before the name of the item.";
471 Returns the name of the icon.
472 <BR><VAR>See also <A href=exemple/Example14.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
476 const string GetPixMap__doc__ = "Returns the name of the icon.";
478 Sets the name of the icon.
479 <BR><VAR>See also <A href=exemple/Example14.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
482 void SetPixMap(in string value);
483 const string SetPixMap__doc__ = "Sets the name of the icon.";
485 const string AttributePixMap__doc__ = "This attribute stores an icon which is put before the name of an item.";
487 //==========================================================================
488 /*! \brief TreeNodeAttribute.
490 A set of these attributes on the %SObjects of the %study forms an inner auxiliary
491 tree whith its own structure and identifier. The quantity of such trees with different
492 identifiers can be arbitrary.
493 <BR><VAR>See also <A href=exemple/Example18.html> an example </A> of usage of the methods of this interface in batchmode of %SALOME application.</VAR>
496 //==========================================================================
497 interface AttributeTreeNode : GenericAttribute
500 Sets the father TreeNode to this TreeNode.
502 void SetFather(in AttributeTreeNode value);
503 const string SetFather__doc__ = "Sets the father TreeNode to this TreeNode.";
505 Returns True if there is the father TreeNode of this TreeNode.
508 const string HasFather__doc__ = "Returns True if there is the father TreeNode of this TreeNode.";
510 Returns the father Treenode of this TreeNode.
512 AttributeTreeNode GetFather();
513 const string GetFather__doc__ = "Returns the father Treenode of this TreeNode.";
515 Sets the previous brother TreeNode to this treeNode.
517 void SetPrevious(in AttributeTreeNode value);
518 const string SetPrevious__doc__ = "Sets the previous brother TreeNode to this treeNode.";
520 Returns True if there is the previous brother TreeNode of this TreeNode.
522 boolean HasPrevious();
523 const string HasPrevious__doc__ = "Returns True if there is the previous brother TreeNode of this TreeNode.";
525 Returns the previous brother TreeNode of this TreeNode.
527 AttributeTreeNode GetPrevious();
528 const string GetPrevious__doc__ = "Returns the previous brother TreeNode of this TreeNode.";
530 Sets the next brother TreeNode to this treeNode.
532 void SetNext(in AttributeTreeNode value);
533 const string SetNext__doc__ = "Sets the next brother TreeNode to this treeNode.";
535 Returns True if there is the next brother TreeNode of this TreeNode.
538 const string HasNext__doc__ = "Returns True if there is the next brother TreeNode of this TreeNode.";
540 Returns the previous brother TreeNode of this TreeNode.
542 AttributeTreeNode GetNext();
543 const string GetNext__doc__ = "Returns the previous brother TreeNode of this TreeNode.";
545 Sets the first child TreeNode to this treeNode.
547 void SetFirst(in AttributeTreeNode value);
548 const string SetFirst__doc__ = "Sets the first child TreeNode to this treeNode.";
550 Returns True if there is the first child TreeNode of this TreeNode.
553 const string HasFirst__doc__ = "Returns True if there is the first child TreeNode of this TreeNode.";
555 Returns the first child TreeNode of this TreeNode.
557 AttributeTreeNode GetFirst();
558 const string GetFirst__doc__ = "Returns the first child TreeNode of this TreeNode.";
560 Sets ID of the tree. TreeNodes of one tree have the same ID.
562 void SetTreeID(in string value);
563 const string SetTreeID__doc__ = "Sets ID of the tree. TreeNodes of one tree have the same ID.";
568 const string GetTreeID__doc__ = "Gets ID of the tree.";
571 Adds a child TreeNode to the end of the list of children of this Treenode.
573 void Append(in AttributeTreeNode value);
574 const string Append__doc__ = "Adds a child TreeNode to the end of the list of children of this Treenode.";
576 Adds a child TreeNode to the beginning of the list of children of this Treenode.
579 void Prepend(in AttributeTreeNode value);
580 const string Prepend__doc__ = "Adds a child TreeNode to the beginning of the list of children of this Treenode.";
582 Adds a brother TreeNode before this Treenode.
583 In this case the both TreeNodes will belong to the same father.
585 void InsertBefore(in AttributeTreeNode value);
586 const string InsertBefore__doc__ = "Adds a brother TreeNode before this Treenode. In this case the both TreeNodes will belong to the same father.";
588 Adds a brother TreeNode after this Treenode.
589 In this case the both TreeNodes will belong to the same father.
591 void InsertAfter(in AttributeTreeNode value);
592 const string InsertAfter__doc__ = "Adds a brother TreeNode after this Treenode. In this case the both TreeNodes will belong to the same father.";
595 <BR><VAR>See also <A href=exemple/Example3.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
599 const string Remove__doc__ = "Deletes a TreeNode.";
602 Returns the depth of the TreeNode in the
603 structure, it means the number of fathers of the given TreeNode.
604 (i.e.: the depth of the root TreeNode is 0).
607 const string Depth__doc__ = "Returns the depth of the TreeNode in the structure, it means the number of fathers of the given TreeNode. \n(i.e.: the depth of the root TreeNode is 0).";
609 Returns True if it is a root TreeNode.
612 const string IsRoot__doc__ = "Returns True if it is a root TreeNode.";
614 Returns True if this TreeNode is a descendant of the TreeNode.
616 boolean IsDescendant(in AttributeTreeNode value);
617 const string IsDescendant__doc__ = "Returns True if this TreeNode is a descendant of the TreeNode.";
619 Returns True if this TreeNode is the father of the TreeNode.
621 boolean IsFather(in AttributeTreeNode value);
622 const string IsFather__doc__ = "Returns True if this TreeNode is the father of the TreeNode.";
624 Returns True if this TreeNode is a child of the TreeNode.
626 boolean IsChild(in AttributeTreeNode value);
627 const string IsChild__doc__ = "Returns True if this TreeNode is a child of the TreeNode.";
629 Returns ID of the according %SObject.
632 const string Label__doc__ = "Returns ID of the according SObject.";
634 const string AttributeTreeNode__doc__ = "A set of these attributes on the SObjects of the study forms an inner auxiliary \ntree whith its own structure and identifier. The quantity of such trees with different \nidentifiers can be arbitrary.";
635 //==========================================================================
636 /*! \brief LocalID attribute
638 Attribute describing the link between a %SObject and a local object in the component.
640 //==========================================================================
641 interface AttributeLocalID : GenericAttribute
644 Returns the value of this attribute.
645 <BR><VAR>See also <A href=exemple/Example1.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
648 const string Value__doc__ = "Returns the value of this attribute.";
650 Sets the value of this attribute.
651 <BR><VAR>See also <A href=exemple/Example1.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
653 void SetValue(in long value);
654 const string SetValue__doc__ = "Sets the value of this attribute.";
656 const string AttributeLocalID__doc__ = "Attribute describing the link between a SObject and a local object in the component.";
658 //==========================================================================
659 /*! \brief Attribute storing GUID
661 Attribute allowing to store GUID
663 //==========================================================================
664 interface AttributeUserID : GenericAttribute
667 Returns the value of this attribute
668 <BR><VAR>See also <A href=exemple/Example1.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
671 const string Value__doc__ = "Returns the value of this attribute.";
673 Sets the value of this attribute
674 <BR><VAR>See also <A href=exemple/Example1.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
676 void SetValue(in string value);
677 const string SetValue__doc__ = "Sets the value of this attribute.";
679 const string AttributeUserID__doc__ = "Attribute allowing to store GUID.";
681 //==========================================================================
682 /*! \brief %AttributeTarget iterface
684 This attribute stores the list of all %SObjects that refer
685 to this %SObject. This attribute is used for inner purposes of the application.
686 It is also needed for optimization.
688 //==========================================================================
690 interface AttributeTarget : GenericAttribute
693 Adds a %SObject to the list of %SObjects which refer to this %SObject.
695 <BR><VAR>See also <A href=exemple/Example3.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
698 void Add(in SObject anObject);
699 const string Add__doc__ = "Adds a SObject to the list of SObjects which refer to this SObject.";
701 Returns the list of %SObjects which refer to this %SObject.
703 SALOMEDS::Study::ListOfSObject Get();
704 const string Get__doc__ = "Returns the list of SObjects which refer to this SObject.";
706 Deletes a %SObject from the list of %SObjects which refer to this %SObject.
708 <BR><VAR>See also <A href=exemple/Example3.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
711 void Remove(in SObject anObject);
712 const string Remove__doc__ = "Deletes a SObject from the list of SObjects which refer to this SObject.";
714 const string AttributeTarget__doc__ = "Adds a SObject to the list of SObjects which refer to this SObject.";
715 //==========================================================================
716 /*! \brief %AttributeTableOfInteger interface
718 This attribute allows to store a table of integers (indexing from 1 like in CASCADE)
719 and string titles of this table, of each row, of each column.
720 <BR><VAR>See also <A href=exemple/Example21.html> an example </A> of usage of these methods in batchmode of %SALOME application.</VAR>
723 //==========================================================================
725 interface AttributeTableOfInteger : GenericAttribute
728 This exception is raised when an incorrect index is passed as parameter.
730 exception IncorrectIndex {};
732 This exception is raised when an incorrect length of the argument is passed as parameter.
734 exception IncorrectArgumentLength {};
736 // titles: for table, for each row, for each column
738 Sets the title of the table.
740 void SetTitle(in string theTitle);
741 const string SetTitle__doc__ = "Sets the title of the table.";
743 Returns the title of the table.
746 const string GetTitle__doc__ = "Returns the title of the table.";
748 Sets the title of a row with a definite index.
750 void SetRowTitle(in long theIndex, in string theTitle) raises(IncorrectIndex);
751 const string SetRowTitle__doc__ = "Sets the title of a row with a definite index.";
753 Sets the titles for all rows of the table.
755 void SetRowTitles(in StringSeq theTitles) raises(IncorrectArgumentLength);
756 const string SetRowTitles__doc__ = "Sets the titles for all rows of the table.";
758 Returns the titles of all rows of the table.
760 StringSeq GetRowTitles();
761 const string GetRowTitles__doc__ = "Returns the titles of all rows of the table.";
763 Sets the title of a column with a definite index.
765 void SetColumnTitle(in long theIndex, in string theTitle) raises(IncorrectIndex);
766 const string SetColumnTitle__doc__ = "Sets the title of a column with a definite index.";
768 Sets the titles for all columns of the table.
770 void SetColumnTitles(in StringSeq theTitles) raises(IncorrectArgumentLength);
771 const string SetColumnTitles__doc__ = "Sets the titles for all columns of the table.";
773 Returns the titles of all columns of the table.
775 StringSeq GetColumnTitles();
776 const string GetColumnTitles__doc__ = "Returns the titles of all columns of the table.";
780 Sets the unit of a row with a definite index.
782 void SetRowUnit(in long theIndex, in string theUnit) raises(IncorrectIndex);
783 const string SetRowUnit__doc__ = "Sets the unit of a row with a definite index.";
785 Sets the units for all rows of the table.
787 void SetRowUnits(in StringSeq theUnits) raises(IncorrectArgumentLength);
788 const string SetRowUnits__doc__ = "Sets the units for all rows of the table.";
790 Returns the units of all rows of the table.
792 StringSeq GetRowUnits();
793 const string GetRowUnits__doc__ = "Returns the units of all rows of the table.";
797 Returns the number of rows of the table.
800 const string GetNbRows__doc__ = "Returns the number of rows of the table.";
802 Returns the number of columns of the table.
805 const string GetNbColumns__doc__ = "Returns the number of columns of the table.";
807 // operations with rows
809 Adds a row to the end of the table.
811 void AddRow(in LongSeq theData) raises(IncorrectArgumentLength);
812 const string AddRow__doc__ = "Adds a row to the end of the table.";
814 Sets the values of all elements of the row.
816 void SetRow(in long theRow, in LongSeq theData) raises(IncorrectArgumentLength, IncorrectIndex);
817 const string SetRow__doc__ = "Sets the values of all elements of the row.";
819 Returns the row of the table.
821 LongSeq GetRow(in long theRow) raises(IncorrectIndex);
822 const string GetRow__doc__ = "Returns the row of the table.";
824 // operations with columns
826 Adds a column to the end of the table.
828 void AddColumn(in LongSeq theData) raises(IncorrectArgumentLength);
829 const string AddColumn__doc__ = "Adds a column to the end of the table.";
831 Sets the values of all elements of the column.
833 void SetColumn(in long theColumn, in LongSeq theData) raises(IncorrectArgumentLength, IncorrectIndex);
834 const string SetColumn__doc__ = "Sets the values of all elements of the column.";
836 Returns the column of the table.
838 LongSeq GetColumn(in long theColumn) raises(IncorrectIndex);
839 const string GetColumn__doc__ = "Returns the column of the table.";
841 // operations with elements
843 Puts a value in the table.
844 \param theRow The row, where the value will be placed.
845 \param theColumn The column, where the value will be placed.
847 void PutValue(in long theValue, in long theRow, in long theColumn) raises(IncorrectIndex);
848 const string PutValue__doc__ = "Puts a value in a definite row theRow and column theColumn of the table.";
850 Returns True if there is a value in the table.
851 \param theRow The row containing the value
852 \param theColumn The column containing the value
854 boolean HasValue(in long theRow, in long theColumn);
855 const string HasValue__doc__ = "Returns True if there is a value in a definite row and column of the table.";
857 Returns the value from the table.
858 \param theRow The row containing the value
859 \param theColumn The column containing the value
861 long GetValue(in long theRow, in long theColumn) raises(IncorrectIndex);
862 const string GatValue__doc__ = "Returns the value from a definite row and column of the table.";
865 Sets the max number of colums in the table.
866 \note It'd better to set it before filling the table.
868 void SetNbColumns(in long theNbColumns);
869 const string SetNbColumns__doc__ = "Sets the max number of colums in the table. ";
872 Returns the indices of the row where the values are defined.
874 LongSeq GetRowSetIndices(in long theRow) raises(IncorrectIndex);
875 const string GetRowSetIndices__doc__ = "Returns the indices of the row where the values are defined.";
876 // operations with files
878 Reads a table from a file.
880 boolean ReadFromFile(in SALOMEDS::TMPFile theStream);
881 const string ReadFromFile__doc__ = "Reads a table from a file.";
883 Saves a table into a file.
885 SALOMEDS::TMPFile SaveToFile();
886 const string SaveToFile__doc__ = "Saves a table into a file.";
888 const string AttributeTableOfInteger__doc__ = "This attribute allows to store a table of integers (indexing from 1 like in CASCADE) \nand string titles of this table, of each row, of each column.";
890 //==========================================================================
891 /*! \brief %AttributeTableOfReal interface
893 This attribute allows to store a table of reals (indexing from 1 like in CASCADE)
894 and string titles of this table, of each row, of each column.
895 <BR><VAR>See also <A href=exemple/Example21.html> an example </A> of usage of these methods in batchmode of %SALOME application.</VAR>
898 //==========================================================================
900 interface AttributeTableOfReal : GenericAttribute
903 This exception is raised when an incorrect index is passed as parameter.
905 exception IncorrectIndex {};
907 This exception is raised when an incorrect length of the argument is passed as parameter.
909 exception IncorrectArgumentLength {};
911 // titles: for table, for each row, for each column
913 Sets the title of the table.
915 void SetTitle(in string theTitle);
916 const string SetTitle__doc__ = "Sets the title of the table.";
918 Returns the title of the table.
921 const string GetTitle__doc__ = "Returns the title of the table.";
923 Sets the title of a row with a definite index.
925 void SetRowTitle(in long theIndex, in string theTitle) raises(IncorrectIndex);
926 const string SetRowTitle__doc__ = "Sets the title of a row with a definite index.";
928 Sets the titles for all rows of the table.
930 void SetRowTitles(in StringSeq theTitles) raises(IncorrectArgumentLength);
931 const string SetRowTitles__doc__ = "Sets the titles for all rows of the table.";
933 Returns the titles of all rows of the table.
935 StringSeq GetRowTitles();
936 const string GetRowTitles__doc__ = "Returns the titles of all rows of the table.";
938 Sets the title of a column with a definite index.
940 void SetColumnTitle(in long theIndex, in string theTitle) raises(IncorrectIndex);
941 const string SetColumnTitle__doc__ = "Sets the title of a column with a definite index.";
943 Sets the titles for all columns of the table.
945 void SetColumnTitles(in StringSeq theTitles) raises(IncorrectArgumentLength);
946 const string SetColumnTitles__doc__ = "Sets the titles for all columns of the table.";
948 Returns the titles of all columns of the table.
950 StringSeq GetColumnTitles();
951 const string GetColumnTitles__doc__ = "Returns the titles of all columns of the table.";
955 Sets the unit of a row with a definite index.
957 void SetRowUnit(in long theIndex, in string theUnit) raises(IncorrectIndex);
958 const string SetRowUnit__doc__ = "Sets the unit of a row with a definite index.";
960 Sets the units for all rows of the table.
962 void SetRowUnits(in StringSeq theUnits) raises(IncorrectArgumentLength);
963 const string SetRowUnits__doc__ = "Sets the units for all rows of the table.";
965 Returns the units of all rows of the table.
967 StringSeq GetRowUnits();
968 const string GetRowUnits__doc__ = "Returns the units of all rows of the table.";
972 Returns the number of rows of the table.
975 const string GetNbRows__doc__ = "Returns the number of rows of the table.";
977 Returns the number of columns of the table.
980 const string GetNbColumns__doc__ = "Returns the number of columns of the table.";
982 // operations with rows
984 Adds a row to the end of the table.
986 void AddRow(in DoubleSeq theData) raises(IncorrectArgumentLength);
987 const string AddRow__doc__ = "Adds a row to the end of the table.";
989 Sets the values of all elements of the row.
991 void SetRow(in long theRow, in DoubleSeq theData) raises(IncorrectArgumentLength, IncorrectIndex);
992 const string SetRow__doc__ = "Sets the values of all elements of the row.";
994 Returns the row of the table.
996 DoubleSeq GetRow(in long theRow) raises(IncorrectIndex);
997 const string GetRow__doc__ = "Returns the row of the table.";
999 // operations with columns
1001 Adds a column to the end of the table.
1003 void AddColumn(in DoubleSeq theData) raises(IncorrectArgumentLength);
1004 const string AddColumn__doc__ = "Adds a column to the end of the table.";
1006 Sets the values of all elements of the column.
1008 void SetColumn(in long theColumn, in DoubleSeq theData) raises(IncorrectArgumentLength, IncorrectIndex);
1009 const string SetColumn__doc__ = "Sets the values of all elements of the column.";
1011 Returns the column of the table.
1013 DoubleSeq GetColumn(in long theColumn) raises(IncorrectIndex);
1014 const string GetColumn__doc__ = "Returns the column of the table.";
1016 // operations with elements
1018 Puts a value in the table.
1019 \param theRow The row, where the value will be placed.
1020 \param theColumn The column, where the value will be placed.
1022 void PutValue(in double theValue, in long theRow, in long theColumn) raises(IncorrectIndex);
1023 const string PutValue__doc__ = "Puts a value in a definite row theRow and column theColumn of the table.";
1025 Returns True if there is a value in the table.
1026 \param theRow The row containing the value
1027 \param theColumn The column containing the value
1029 boolean HasValue(in long theRow, in long theColumn);
1030 const string HasValue__doc__ = "Returns True if there is a value in a definite row and column of the table.";
1032 Returns the value from the table.
1033 \param theRow The row containing the value
1034 \param theColumn The column containing the value
1036 double GetValue(in long theRow, in long theColumn) raises(IncorrectIndex);
1037 const string GatValue__doc__ = "Returns the value from a definite row and column of the table.";
1040 Sets the max number of colums in the table.
1041 \note It'd better to set it before filling the table.
1043 void SetNbColumns(in long theNbColumns);
1044 const string SetNbColumns__doc__ = "Sets the max number of colums in the table. ";
1047 Returns the indices of the row where the values are defined.
1049 LongSeq GetRowSetIndices(in long theRow) raises(IncorrectIndex);
1050 const string GetRowSetIndices__doc__ = "Returns the indices of the row where the values are defined.";
1051 // operations with files
1053 Reads a table from a file.
1055 boolean ReadFromFile(in SALOMEDS::TMPFile theStream);
1056 const string ReadFromFile__doc__ = "Reads a table from a file.";
1058 Saves a table into a file.
1060 SALOMEDS::TMPFile SaveToFile();
1061 const string SaveToFile__doc__ = "Saves a table into a file.";
1063 const string AttributeTableOfReal__doc__ = "This attribute allows to store a table of reals (indexing from 1 like in CASCADE) \nand string titles of this table, of each row, of each column.";
1067 //==========================================================================
1068 /*! \brief %AttributeTableOfString interface
1070 This attribute allows to store a table of strings (indexing from 1 like in CASCADE)
1071 and string titles of this table, of each row, of each column.
1072 <BR><VAR>See also <A href=exemple/Example21.html> an example </A> of usage of these methods in batchmode of %SALOME application.</VAR>
1075 //==========================================================================
1077 interface AttributeTableOfString : GenericAttribute
1080 This exception is raised when an incorrect index is passed as parameter.
1082 exception IncorrectIndex {};
1084 This exception is raised when an incorrect length of the argument is passed as parameter.
1086 exception IncorrectArgumentLength {};
1088 // titles: for table, for each row, for each column
1090 Sets the title of the table.
1092 void SetTitle(in string theTitle);
1093 const string SetTitle__doc__ = "Sets the title of the table.";
1095 Returns the title of the table.
1098 const string GetTitle__doc__ = "Returns the title of the table.";
1100 Sets the title of a row with a definite index.
1102 void SetRowTitle(in long theIndex, in string theTitle) raises(IncorrectIndex);
1103 const string SetRowTitle__doc__ = "Sets the title of a row with a definite index.";
1105 Sets the titles for all rows of the table.
1107 void SetRowTitles(in StringSeq theTitles) raises(IncorrectArgumentLength);
1108 const string SetRowTitles__doc__ = "Sets the titles for all rows of the table.";
1110 Returns the titles of all rows of the table.
1112 StringSeq GetRowTitles();
1113 const string GetRowTitles__doc__ = "Returns the titles of all rows of the table.";
1115 Sets the title of a column with a definite index.
1117 void SetColumnTitle(in long theIndex, in string theTitle) raises(IncorrectIndex);
1118 const string SetColumnTitle__doc__ = "Sets the title of a column with a definite index.";
1120 Sets the titles for all columns of the table.
1122 void SetColumnTitles(in StringSeq theTitles) raises(IncorrectArgumentLength);
1123 const string SetColumnTitles__doc__ = "Sets the titles for all columns of the table.";
1125 Returns the titles of all columns of the table.
1127 StringSeq GetColumnTitles();
1128 const string GetColumnTitles__doc__ = "Returns the titles of all columns of the table.";
1132 Sets the unit of a row with a definite index.
1134 void SetRowUnit(in long theIndex, in string theUnit) raises(IncorrectIndex);
1135 const string SetRowUnit__doc__ = "Sets the unit of a row with a definite index.";
1137 Sets the units for all rows of the table.
1139 void SetRowUnits(in StringSeq theUnits) raises(IncorrectArgumentLength);
1140 const string SetRowUnits__doc__ = "Sets the units for all rows of the table.";
1142 Returns the units of all rows of the table.
1144 StringSeq GetRowUnits();
1145 const string GetRowUnits__doc__ = "Returns the units of all rows of the table.";
1147 // table information
1149 Returns the number of rows of the table.
1152 const string GetNbRows__doc__ = "Returns the number of rows of the table.";
1154 Returns the number of columns of the table.
1156 long GetNbColumns();
1157 const string GetNbColumns__doc__ = "Returns the number of columns of the table.";
1159 // operations with rows
1161 Adds a row to the end of the table.
1163 void AddRow(in StringSeq theData) raises(IncorrectArgumentLength);
1164 const string AddRow__doc__ = "Adds a row to the end of the table.";
1166 Sets the values of all elements of the row.
1168 void SetRow(in long theRow, in StringSeq theData) raises(IncorrectArgumentLength, IncorrectIndex);
1169 const string SetRow__doc__ = "Sets the values of all elements of the row.";
1171 Returns the row of the table.
1173 StringSeq GetRow(in long theRow) raises(IncorrectIndex);
1174 const string GetRow__doc__ = "Returns the row of the table.";
1176 // operations with columns
1178 Adds a column to the end of the table.
1180 void AddColumn(in StringSeq theData) raises(IncorrectArgumentLength);
1181 const string AddColumn__doc__ = "Adds a column to the end of the table.";
1183 Sets the values of all elements of the column.
1185 void SetColumn(in long theColumn, in StringSeq theData) raises(IncorrectArgumentLength, IncorrectIndex);
1186 const string SetColumn__doc__ = "Sets the values of all elements of the column.";
1188 Returns the column of the table.
1190 StringSeq GetColumn(in long theColumn) raises(IncorrectIndex);
1191 const string GetColumn__doc__ = "Returns the column of the table.";
1193 // operations with elements
1195 Puts a value in the table.
1196 \param theRow The row, where the value will be placed.
1197 \param theColumn The column, where the value will be placed.
1199 void PutValue(in string theValue, in long theRow, in long theColumn) raises(IncorrectIndex);
1200 const string PutValue__doc__ = "Puts a value in a definite row theRow and column theColumn of the table.";
1202 Returns True if there is a value in the table.
1203 \param theRow The row containing the value
1204 \param theColumn The column containing the value
1206 boolean HasValue(in long theRow, in long theColumn);
1207 const string HasValue__doc__ = "Returns True if there is a value in a definite row and column of the table.";
1209 Returns the value from the table.
1210 \param theRow The row containing the value
1211 \param theColumn The column containing the value
1213 string GetValue(in long theRow, in long theColumn) raises(IncorrectIndex);
1214 const string GatValue__doc__ = "Returns the value from a definite row and column of the table.";
1217 Sets the max number of colums in the table.
1218 \note It'd better to set it before filling the table.
1220 void SetNbColumns(in long theNbColumns);
1221 const string SetNbColumns__doc__ = "Sets the max number of colums in the table. ";
1224 Returns the indices of the row where the values are defined.
1226 LongSeq GetRowSetIndices(in long theRow) raises(IncorrectIndex);
1227 const string GetRowSetIndices__doc__ = "Returns the indices of the row where the values are defined.";
1228 // operations with files
1230 Reads a table from a file.
1232 boolean ReadFromFile(in SALOMEDS::TMPFile theStream);
1233 const string ReadFromFile__doc__ = "Reads a table from a file.";
1235 Saves a table into a file.
1237 SALOMEDS::TMPFile SaveToFile();
1238 const string SaveToFile__doc__ = "Saves a table into a file.";
1240 const string AttributeTableOfString__doc__ = "This attribute allows to store a table of string (indexing from 1 like in CASCADE) \nand string titles of this table, of each row, of each column.";
1243 //==========================================================================
1244 /*! \brief %AttributeStudyProperties interface
1246 This attribute allows to store study properties: user name, creation date, creation
1247 mode, modified flag, locked flag.
1248 <BR><VAR>See also <A href=exemple/Example20.html> an example </A> of usage of these methods in batchmode of %SALOME application.</VAR>
1251 //==========================================================================
1253 interface AttributeStudyProperties : GenericAttribute
1256 Sets the name of the author of the %Study
1258 void SetUserName(in string theName);
1259 const string SetUserName__doc__ = "Sets the name of the author of the study.";
1261 Returns the name of the user of the %Study.
1262 \note <BR>It returns a null string, if user name is not set
1264 string GetUserName();
1265 const string GetUserName__doc__ = "Returns the name of the user of the study.";
1267 Sets creation date of the %Study.
1269 void SetCreationDate(in long theMinute, in long theHour, in long theDay, in long theMonth, in long theYear);
1270 const string SetCreationDate__doc__ = "Sets creation date of the study.";
1272 Returns creation date of the %Study and True if creation date is set.
1274 boolean GetCreationDate(out long theMinute, out long theHour, out long theDay, out long theMonth, out long theYear);
1275 const string GetCreationDate__doc__ = "Returns creation date of the study and True if creation date is set.";
1277 Sets creation mode of the %Study.
1278 \note <BR>Creation mode must be: "from scratch" or "copy from".
1280 void SetCreationMode(in string theMode);
1281 const string SetCreationMode__doc__ = "Sets creation mode of the study. Creation mode must be: from scratch or copy from.";
1283 Returns creation mode: "from scratch", "copy from", or null string
1284 if creation mode is not set
1286 string GetCreationMode();
1287 const string GetCreationMode__doc__ = "Returns creation mode of the study.";
1289 Sets the number of transactions executed after the last saving of the document.
1291 void SetModified(in long theModified);
1292 const string SetModified__doc__ = "Sets the number of transactions executed after the last saving of the document.";
1294 Returns True, if the document has been modified and not saved.
1296 boolean IsModified();
1297 const string IsModified__doc__ = "Returns True, if the document has been modified and not saved.";
1299 Returns the number of transactions executed after the last saving of the document.
1302 const string GetModified__doc__ = "Returns the number of transactions executed after the last saving of the document.";
1304 Sets the document locked for modifications if <VAR>theLocked</VAR> is True.
1306 void SetLocked(in boolean theLocked);
1307 const string SetLocked__doc__ = "Sets the document locked for modifications if theLocked is True.";
1309 Returns True if the document is locked for modifications.
1312 const string IsLocked__doc__ = "Returns True if the document is locked for modifications.";
1314 Appends modification parameters to the modifications list.
1316 void SetModification(in string theName, in long theMinute, in long theHour, in long theDay, in long theMonth, in long theYear);
1317 const string SetModification__doc__ = "Appends modification parameters to the modifications list.";
1319 Returns a list of mosdifiers user names, modification dates.
1320 /note <BR>If <VAR>theWithCreator</VAR> is True, then the output list will also contain the name of the author and the date of creation.
1322 void GetModificationsList(out StringSeq theNames, out LongSeq theMinutes, out LongSeq theHours, out LongSeq theDays, out LongSeq theMonths, out LongSeq theYears, in boolean theWithCreator);
1323 const string GetModificationsList__doc__ = "Returns a list of mosdifiers user names, modification dates.";
1325 const string AttributeStudyProperties__doc__ = "This attribute allows to store properties of the study : user name, creation date, \ncreation mode, modified flag, locked flag.";
1326 //==========================================================================
1327 /*! \brief %AttributePythonObject interface
1329 Attribute allowing to store pyton objects as a sequence of chars.
1331 //==========================================================================
1333 interface AttributePythonObject : GenericAttribute
1336 Sets in the attribute a Python object converted into a sequence of chars.
1337 \param theSequence A sequence of chars.
1338 \param IsScript Defines (if True) whether this sequence of chars is a Python script.
1340 void SetObject(in string theSequence, in boolean IsScript);
1341 const string SetObject__doc__ = "Sets in the attribute a Python object converted into a sequence of chars.";
1343 Returns a Python object stored in the attribute as a sequence of chars.
1346 const string GetObject__doc__ = "Returns a Python object stored in the attribute as a sequence of chars.";
1348 Returns True if the sequence of bytes stored in the attribute corresponds
1352 const string IsScript__doc__ = "Returns True if the sequence of bytes stored in the attribute corresponds to a Python script.";
1354 const string AttributePythonObject__doc__ = "Attribute allowing to store pyton objects as a sequence of chars.";