0024927: Getting rid of "Persistent" functionality -- Code
[occt.git] / src / PDataStd / PDataStd_NamedData.cdl
1 -- Created on: 2007-06-26
2 -- Created by: Sergey ZARITCHNY
3 -- Copyright (c) 2007-2014 OPEN CASCADE SAS
4 --
5 -- This file is part of Open CASCADE Technology software library.
6 --
7 -- This library is free software; you can redistribute it and/or modify it under
8 -- the terms of the GNU Lesser General Public License version 2.1 as published
9 -- by the Free Software Foundation, with special exception defined in the file
10 -- OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
11 -- distribution for complete text of the license and disclaimer of any warranty.
12 --
13 -- Alternatively, this file may be used under the terms of Open CASCADE
14 -- commercial license or contractual agreement.
15
16 class NamedData from PDataStd inherits Attribute from PDF
17
18         ---Purpose: Persistence of NamedData
19
20 uses
21     HExtendedString from PCollection,
22     HArray1OfExtendedString from PColStd, 
23     HArray2OfInteger  from  PColStd, 
24     HArray1OfInteger  from  PColStd, 
25     HArray1OfReal  from  PColStd, 
26     HArray1OfByte  from  PDataStd, 
27     HArray2OfInteger  from TColStd, 
28     HArray1OfHArray1OfInteger from PDataStd, 
29     HArray1OfHArray1OfReal from PDataStd
30 is
31
32     Create 
33     returns NamedData from PDataStd;
34
35     Init (me : mutable; theDimension:  HArray2OfInteger  from TColStd);
36     ---Purpose: 6 pairs of (lower, upper) <theDimension> should be  initialized
37     --  if  (upper  -  lower)  ==  0  and (upper  |  lower) == 0, the corresponding  
38     --  array is empty (not requested) 
39     
40     SetIntDataItem (me: mutable; 
41               index : Integer from Standard; 
42               key   : HExtendedString from PCollection; 
43               value : Integer from Standard); 
44      
45     IntDataItemValue(me; 
46               index : Integer from Standard; 
47               key   : out HExtendedString from PCollection) 
48     returns Integer from Standard;        
49      
50     SetRealDataItem (me: mutable; 
51               index : Integer from Standard; 
52               key   : HExtendedString from PCollection; 
53               value : Real from Standard); 
54      
55     RealDataItemValue(me; 
56               index : Integer from Standard; 
57               key   : out HExtendedString from PCollection) 
58     returns Real from Standard;        
59          
60     SetStrDataItem (me: mutable; 
61               index : Integer from Standard; 
62               key   : HExtendedString from PCollection; 
63               value : HExtendedString from PCollection); 
64      
65     StrDataItemValue(me; 
66               index : Integer from Standard; 
67               key   : out HExtendedString from PCollection) 
68     returns HExtendedString from PCollection; 
69      
70     SetByteDataItem (me: mutable; 
71               index : Integer from Standard; 
72               key   : HExtendedString from PCollection; 
73               value : Byte from Standard); 
74      
75     ByteDataItemValue(me; 
76               index : Integer from Standard; 
77               key   : out HExtendedString from PCollection) 
78     returns Byte from Standard;        
79      
80     SetArrIntDataItem (me: mutable; 
81               index : Integer from Standard; 
82               key   : HExtendedString from PCollection; 
83               value : HArray1OfInteger from PColStd); 
84      
85     ArrIntDataItemValue(me; 
86               index : Integer from Standard; 
87               key   : out HExtendedString from PCollection) 
88     returns HArray1OfInteger from PColStd;
89
90     SetArrRealDataItem (me: mutable; 
91               index : Integer from Standard; 
92               key   : HExtendedString from PCollection; 
93               value : HArray1OfReal from PColStd); 
94      
95     ArrRealDataItemValue(me; 
96               index : Integer from Standard; 
97               key   : out HExtendedString from PCollection) 
98     returns HArray1OfReal from PColStd;
99
100
101     LowerI (me) 
102     returns Integer from Standard;      
103
104     UpperI (me) 
105     returns Integer from Standard; 
106      
107     LowerR (me) 
108     returns Integer from Standard;      
109
110     UpperR (me) 
111     returns Integer from Standard;     
112
113     LowerS (me) 
114     returns Integer from Standard;      
115
116     UpperS (me) 
117     returns Integer from Standard; 
118
119     LowerB (me) 
120     returns Integer from Standard;      
121
122     UpperB (me) 
123     returns Integer from Standard;  
124      
125     LowerAI (me) 
126     returns Integer from Standard;      
127
128     UpperAI (me) 
129     returns Integer from Standard;  
130
131     LowerAR (me) 
132     returns Integer from Standard;      
133
134     UpperAR (me) 
135     returns Integer from Standard; 
136      
137     HasIntegers (me)
138     ---Purpose: Returns true if at least one named integer value is kept. 
139     returns Boolean from Standard;  
140      
141     HasReals (me)
142     ---Purpose: Returns true if at least one named real value is kept. 
143     returns Boolean from Standard; 
144      
145     HasStrings (me)
146     ---Purpose: Returns true if at least one named string value is kept.
147     returns Boolean from Standard; 
148      
149     HasBytes (me)
150     ---Purpose: Returns true if at least one named byte value is kept.
151     returns Boolean from Standard; 
152      
153     HasArraysOfIntegers (me)
154     ---Purpose: Returns true if at least one named array of integer values is kept.
155     returns Boolean from Standard; 
156      
157     HasArraysOfReals (me)
158     ---Purpose: Returns true if at least one named array of real values is kept.
159     returns Boolean from Standard;
160      
161 fields
162  
163     myDimensions     :  HArray2OfInteger  from  PColStd; 
164     
165     myIntKeys        :  HArray1OfExtendedString from PColStd;  
166     myIntValues      :  HArray1OfInteger from PColStd;   
167     
168     myRealKeys       :  HArray1OfExtendedString from PColStd;  
169     myRealValues     :  HArray1OfReal from PColStd;    
170     
171     myStrKeys        :  HArray1OfExtendedString from PColStd; 
172     myStrValues      :  HArray1OfExtendedString from PColStd; 
173      
174     myByteKeys       :  HArray1OfExtendedString from PColStd;   
175     myByteValues     :  HArray1OfByte from PDataStd;    
176      
177     myArrIntKeys     :  HArray1OfExtendedString from PColStd;  
178     myArrIntValues   :  HArray1OfHArray1OfInteger from PDataStd; 
179      
180     myArrRealKeys    :  HArray1OfExtendedString from PColStd;  
181     myArrRealValues  :  HArray1OfHArray1OfReal from PDataStd;  
182     
183 end NamedData;