1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
|
// File generated by CPPExt (Transient)
//
//
// Copyright (C) 1991 - 2000 by
// Matra Datavision SA. All rights reserved.
//
// Copyright (C) 2001 - 2004 by
// Open CASCADE SA. All rights reserved.
//
// This file is part of the Open CASCADE Technology software.
//
// This software may be distributed and/or modified under the terms and
// conditions of the Open CASCADE Public License as defined by Open CASCADE SA
// and appearing in the file LICENSE included in the packaging of this file.
//
// This software is distributed on an "AS IS" basis, without warranty of any
// kind, and Open CASCADE SA hereby disclaims all such warranties,
// including without limitation, any warranties of merchantability, fitness
// for a particular purpose or non-infringement. Please see the License for
// the specific terms and conditions governing rights and limitations under the
// License.
#ifndef _Interface_FileReaderData_HeaderFile
#define _Interface_FileReaderData_HeaderFile
#ifndef _Standard_HeaderFile
#include <Standard.hxx>
#endif
#ifndef _Handle_Interface_FileReaderData_HeaderFile
#include <Handle_Interface_FileReaderData.hxx>
#endif
#ifndef _Standard_Integer_HeaderFile
#include <Standard_Integer.hxx>
#endif
#ifndef _Handle_Interface_ParamSet_HeaderFile
#include <Handle_Interface_ParamSet.hxx>
#endif
#ifndef _TColStd_Array1OfInteger_HeaderFile
#include <TColStd_Array1OfInteger.hxx>
#endif
#ifndef _TColStd_Array1OfTransient_HeaderFile
#include <TColStd_Array1OfTransient.hxx>
#endif
#ifndef _MMgt_TShared_HeaderFile
#include <MMgt_TShared.hxx>
#endif
#ifndef _Standard_CString_HeaderFile
#include <Standard_CString.hxx>
#endif
#ifndef _Interface_ParamType_HeaderFile
#include <Interface_ParamType.hxx>
#endif
#ifndef _Handle_Interface_ParamList_HeaderFile
#include <Handle_Interface_ParamList.hxx>
#endif
#ifndef _Standard_Boolean_HeaderFile
#include <Standard_Boolean.hxx>
#endif
#ifndef _Handle_Standard_Transient_HeaderFile
#include <Handle_Standard_Transient.hxx>
#endif
#ifndef _Standard_Real_HeaderFile
#include <Standard_Real.hxx>
#endif
class Interface_ParamSet;
class Standard_NoSuchObject;
class TCollection_AsciiString;
class Interface_FileParameter;
class Interface_ParamList;
class Standard_Transient;
//! This class defines services which permit to access Data issued <br>
//! from a File, in a form which does not depend of physical <br>
//! format : thus, each Record has an attached ParamList (to be <br>
//! managed) and resulting Entity. <br>
//! <br>
//! Each Interface defines its own FileReaderData : on one hand by <br>
//! defining deferred methods given here, on the other hand by <br>
//! describing literal data and their accesses, with the help of <br>
//! basic classes such as String, Array1OfString, etc... <br>
//! <br>
//! FileReaderData is used by a FileReaderTool, which is also <br>
//! specific of each Norm, to read an InterfaceModel of the Norm <br>
//! FileReaderData inherits TShared to be accessed by Handle : <br>
//! this allows FileReaderTool to define more easily the specific <br>
//! methods, and improves memory management. <br>
class Interface_FileReaderData : public MMgt_TShared {
public:
// Methods PUBLIC
//
//! Returns the count of registered records <br>
//! That is, value given for Initialization (can be redefined) <br>
Standard_EXPORT virtual Standard_Integer NbRecords() const;
//! Returns the count of entities. Depending of each norm, records <br>
//! can be Entities or SubParts (SubList in STEP, SubGroup in SET <br>
//! ...). NbEntities counts only Entities, not Subs <br>
//! Used for memory reservation in InterfaceModel <br>
//! Default implementation uses FindNextRecord <br>
//! Can be redefined into a more performant way <br>
Standard_EXPORT virtual Standard_Integer NbEntities() const;
//! Determines the record number defining an Entity following a <br>
//! given record number. Specific to each sub-class of <br>
//! FileReaderData. Returning zero means no record found <br>
Standard_EXPORT virtual Standard_Integer FindNextRecord(const Standard_Integer num) const = 0;
//! attaches an empty ParamList to a Record <br>
Standard_EXPORT void InitParams(const Standard_Integer num) ;
//! Adds a parameter to record no "num" and fills its fields <br>
//! (EntityNumber is optional) <br>
//! Warning : <aval> is assumed to be memory-managed elsewhere : it is NOT <br>
//! copied. This gives a best speed : strings remain stored in <br>
//! pages of characters <br>
Standard_EXPORT void AddParam(const Standard_Integer num,const Standard_CString aval,const Interface_ParamType atype,const Standard_Integer nument = 0) ;
//! Same as above, but gets a AsciiString from TCollection <br>
//! Remark that the content of the AsciiString is locally copied <br>
//! (because its content is most often lost after using) <br>
Standard_EXPORT void AddParam(const Standard_Integer num,const TCollection_AsciiString& aval,const Interface_ParamType atype,const Standard_Integer nument = 0) ;
//! Same as above, but gets a complete FileParameter <br>
//! Warning : Content of <FP> is NOT copied : its original address and space <br>
//! in memory are assumed to be managed elsewhere (see ParamSet) <br>
Standard_EXPORT void AddParam(const Standard_Integer num,const Interface_FileParameter& FP) ;
//! Sets a new value for a parameter of a record, given by : <br>
//! num : record number; nump : parameter number in the record <br>
Standard_EXPORT void SetParam(const Standard_Integer num,const Standard_Integer nump,const Interface_FileParameter& FP) ;
//! Returns count of parameters attached to record "num" <br>
//! If <num> = 0, returns the total recorded count of parameters <br>
Standard_EXPORT Standard_Integer NbParams(const Standard_Integer num) const;
//! Returns the complete ParamList of a record (read only) <br>
//! num = 0 to return the whole param list for the file <br>
Standard_EXPORT Handle_Interface_ParamList Params(const Standard_Integer num) const;
//! Returns parameter "nump" of record "num", as a complete <br>
//! FileParameter <br>
Standard_EXPORT const Interface_FileParameter& Param(const Standard_Integer num,const Standard_Integer nump) const;
//! Same as above, but in order to be modified on place <br>
Standard_EXPORT Interface_FileParameter& ChangeParam(const Standard_Integer num,const Standard_Integer nump) ;
//! Returns type of parameter "nump" of record "num" <br>//! Returns literal value of parameter "nump" of record "num" <br>
//! was C++ : return const & <br>
Standard_EXPORT Interface_ParamType ParamType(const Standard_Integer num,const Standard_Integer nump) const;
//! Same as above, but as a CString <br>
//! was C++ : return const <br>
Standard_EXPORT Standard_CString ParamCValue(const Standard_Integer num,const Standard_Integer nump) const;
//! Returns True if parameter "nump" of record "num" is defined <br>
//! (it is not if its type is ParamVoid) <br>
Standard_EXPORT Standard_Boolean IsParamDefined(const Standard_Integer num,const Standard_Integer nump) const;
//! Returns record number of an entity referenced by a parameter <br>
//! of type Ident; 0 if no EntityNumber has been determined <br>
//! Note that it is used to reference Entities but also Sublists <br>
//! (sublists are not objects, but internal descriptions) <br>
Standard_EXPORT Standard_Integer ParamNumber(const Standard_Integer num,const Standard_Integer nump) const;
//! Returns the StepEntity referenced by a parameter <br>
//! Error if none <br>
Standard_EXPORT const Handle_Standard_Transient& ParamEntity(const Standard_Integer num,const Standard_Integer nump) const;
//! Returns the absolute rank of the beginning of a record <br>
//! (its lsit is from ParamFirstRank+1 to ParamFirstRank+NbParams) <br>
Standard_EXPORT Standard_Integer ParamFirstRank(const Standard_Integer num) const;
//! Returns the entity bound to a record, set by SetEntities <br>
Standard_EXPORT const Handle_Standard_Transient& BoundEntity(const Standard_Integer num) const;
//! Binds an entity to a record <br>
Standard_EXPORT void BindEntity(const Standard_Integer num,const Handle(Standard_Transient)& ent) ;
//! Sets the status "Error Load" on, to overside check fails <br>
//! <val> True : declares unloaded <br>
//! <val> False : declares loaded <br>
//! If not called before loading (see FileReaderTool), check fails <br>
//! give the status <br>
//! IsErrorLoad says if SetErrorLoad has been called by user <br>
//! ResetErrorLoad resets it (called by FileReaderTool) <br>
//! This allows to specify that the currently loaded entity <br>
//! remains unloaded (because of syntactic fail) <br>
Standard_EXPORT void SetErrorLoad(const Standard_Boolean val) ;
//! Returns True if the status "Error Load" has been set (to True <br>
//! or False) <br>
Standard_EXPORT Standard_Boolean IsErrorLoad() const;
//! Returns the former value of status "Error Load" then resets it <br>
//! Used to read the status then ensure it is reset <br>
Standard_EXPORT Standard_Boolean ResetErrorLoad() ;
//! Destructor (waiting for memory management) <br>
Standard_EXPORT void Destroy() ;
~Interface_FileReaderData()
{
Destroy();
}
//! Same spec.s as standard <atof> but 5 times faster <br>
Standard_EXPORT static Standard_Real Fastof(const Standard_CString str) ;
// Type management
//
Standard_EXPORT const Handle(Standard_Type)& DynamicType() const;
//Standard_EXPORT Standard_Boolean IsKind(const Handle(Standard_Type)&) const;
protected:
// Methods PROTECTED
//
//! Initializes arrays of Entities and of ParamLists attached <br>
//! to registered records <br>
//! <nbr> must be the maximum number of records to get (no way to <br>
//! extend it at run-time) : count entities and sub-entities ... <br>
//! <npar> is the total count of parameters (if it is not exact, <br>
//! it will be extented as necessary) <br>
//! <br>
//! Hence, to each record can be bound an Entity and a list of <br>
//! Parameters. Each kind of FileReaderData can add other data, by <br>
//! having them in parallel (other arrays with same sizes) <br>
//! Else, it must manage binding between items and their data <br>
Standard_EXPORT Interface_FileReaderData(const Standard_Integer nbr,const Standard_Integer npar);
//! Returns a parameter given its absolute rank in the file <br>
//! in order to be consulted or modified in specilaized actions <br>
Standard_EXPORT Interface_FileParameter& ChangeParameter(const Standard_Integer numpar) ;
//! For a given absolute rank of parameter, determines the <br>
//! record to which its belongs, and the parameter number for it <br>
Standard_EXPORT void ParamPosition(const Standard_Integer numpar,Standard_Integer& num,Standard_Integer& nump) const;
// Fields PROTECTED
//
private:
// Methods PRIVATE
//
// Fields PRIVATE
//
Standard_Integer thenum0;
Standard_Integer thenump0;
Standard_Integer therrload;
Handle_Interface_ParamSet theparams;
TColStd_Array1OfInteger thenumpar;
TColStd_Array1OfTransient theents;
};
// other Inline functions and methods (like "C++: function call" methods)
//
#endif
|
