Salome HOME
Update version to 3.2.0a1
[modules/kernel.git] / src / SALOMEDS / SALOMEDS_OpenedAttribute.cdl
1 // Copyright (C) 2005  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
2 // CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
3 // 
4 // This library is free software; you can redistribute it and/or
5 // modify it under the terms of the GNU Lesser General Public
6 // License as published by the Free Software Foundation; either 
7 // version 2.1 of the License.
8 // 
9 // This library is distributed in the hope that it will be useful 
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of 
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU 
12 // Lesser General Public License for more details.
13 //
14 // You should have received a copy of the GNU Lesser General Public  
15 // License along with this library; if not, write to the Free Software 
16 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
17 //
18 // See http://www.salome-platform.org/
19 //
20 --  SALOME SALOMEDS : data structure of SALOME and sources of Salome data server 
21 --
22 --  Copyright (C) 2003  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
23 --  CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS 
24 -- 
25 --  This library is free software; you can redistribute it and/or 
26 --  modify it under the terms of the GNU Lesser General Public 
27 --  License as published by the Free Software Foundation; either 
28 --  version 2.1 of the License. 
29 -- 
30 --  This library is distributed in the hope that it will be useful, 
31 --  but WITHOUT ANY WARRANTY; without even the implied warranty of 
32 --  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU 
33 --  Lesser General Public License for more details. 
34 -- 
35 --  You should have received a copy of the GNU Lesser General Public 
36 --  License along with this library; if not, write to the Free Software 
37 --  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA 
38 -- 
39 --  See http://www.opencascade.org/SALOME/ or email : webmaster.salome@opencascade.org 
40 --
41 --
42 --
43 --  File   : SALOMEDS_OpenedAttribute.cdl
44 --  Author : Yves FRICAUD
45 --  Module : SALOME
46
47 class OpenedAttribute from SALOMEDS inherits Integer from TDataStd
48
49         ---Purpose: 
50
51
52 uses Attribute         from TDF,
53      Label             from TDF,
54      GUID              from Standard,
55      ExtendedString    from TCollection,
56      DataSet           from TDF,
57      RelocationTable   from TDF,
58      AttributeSequence from TDF,
59      Data              from TDF,
60      Comment           from TDataStd            
61
62
63 is    
64
65
66     ---Purpose: class methods
67     --          =============
68
69     GetID (myclass)   
70     ---C++: return const &  
71     returns GUID from Standard;    
72
73     Set (myclass; label : Label from TDF; value  : Integer from Standard)
74     ---Purpose: Find, or create a Comment attribute and set the string.
75     --          the Comment attribute is returned.
76     returns OpenedAttribute from SALOMEDS;
77     
78     ---Purpose: Comment methods
79     --          ============
80     
81     Create 
82     returns mutable OpenedAttribute from SALOMEDS;
83
84     ID (me)
85         ---C++: return const & 
86     returns GUID from Standard;
87
88     Restore (me: mutable; with : Attribute from TDF);
89
90     NewEmpty (me)
91     returns mutable Attribute from TDF;
92
93     Paste (me; into : mutable Attribute from TDF;
94                RT   : mutable RelocationTable from TDF);    
95
96 end OpenedAttribute;