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
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
|
-- File: BinObjMgt_Persistent.cdl
-- Created: Wed Oct 30 09:17:21 2002
-- Author: Michael SAZONOV
-- <msv@novgorox.nnov.matra-dtv.fr>
---Copyright: Matra Datavision 2002
class Persistent from BinObjMgt
---Purpose: Binary persistent representation of an object.
-- Really it is used as a buffer for read/write an object.
--
-- It takes care of Little/Big endian by inversing bytes
-- in objects of standard types (see FSD_FileHeader.hxx
-- for the default value of DO_INVERSE).
uses
Integer from Standard,
Address from Standard,
OStream from Standard,
IStream from Standard,
SequenceOfAddress from TColStd,
AsciiString from TCollection,
ExtendedString from TCollection,
Label from TDF,
Data from TDF,
PChar from BinObjMgt,
PExtChar from BinObjMgt,
PInteger from BinObjMgt,
PReal from BinObjMgt,
PShortReal from BinObjMgt,
PByte from BinObjMgt
is
Create
returns Persistent from BinObjMgt;
---Purpose: Empty constructor
-------------------------------------------
---Category: API for attribute drivers
-------------------------------------------
PutCharacter (me : in out; theValue : Character from Standard)
returns like me;
---C++: alias operator <<
---C++: return &
PutByte (me : in out; theValue : Byte from Standard)
returns like me;
---C++: alias operator <<
---C++: return &
PutExtCharacter (me : in out; theValue : ExtCharacter from Standard)
returns like me;
---C++: alias operator <<
---C++: return &
PutInteger (me : in out; theValue : Integer from Standard)
returns like me;
---C++: alias operator <<
---C++: return &
PutBoolean (me : in out; theValue : Boolean from Standard)
returns like me;
---C++: alias operator <<
---C++: inline
---C++: return &
PutReal (me : in out; theValue : Real from Standard)
returns like me;
---C++: alias operator <<
---C++: return &
PutShortReal (me : in out; theValue : ShortReal from Standard)
returns like me;
---C++: alias operator <<
---C++: return &
PutCString (me : in out; theValue : CString from Standard)
returns like me;
---C++: alias operator <<
---C++: return &
---Purpose: Offset in output buffer is not aligned
PutAsciiString (me : in out; theValue : AsciiString from TCollection)
returns like me;
---C++: alias operator <<
---C++: return &
---Purpose: Offset in output buffer is word-aligned
PutExtendedString (me : in out; theValue : ExtendedString from TCollection)
returns like me;
---C++: alias operator <<
---C++: return &
---Purpose: Offset in output buffer is word-aligned
PutLabel (me : in out; theValue : Label from TDF)
returns like me;
---C++: alias operator <<
---C++: return &
PutGUID (me : in out; theValue : GUID from Standard)
returns like me;
---C++: alias operator <<
---C++: return &
PutCharArray (me : in out; theArray : PChar from BinObjMgt;
theLength: Integer from Standard)
returns like me;
---C++: return &
---Purpose: Put C array of char, theLength is the number of elements
PutByteArray (me : in out; theArray : PByte from BinObjMgt;
theLength: Integer from Standard)
returns like me;
---C++: return &
---Purpose: Put C array of unsigned chars, theLength is the number of elements
PutExtCharArray (me : in out; theArray : PExtChar from BinObjMgt;
theLength: Integer from Standard)
returns like me;
---C++: return &
---Purpose: Put C array of ExtCharacter, theLength is the number of elements
PutIntArray (me : in out; theArray : PInteger from BinObjMgt;
theLength: Integer from Standard)
returns like me;
---C++: return &
---Purpose: Put C array of int, theLength is the number of elements
PutRealArray (me : in out; theArray : PReal from BinObjMgt;
theLength: Integer from Standard)
returns like me;
---C++: return &
---Purpose: Put C array of double, theLength is the number of elements
PutShortRealArray (me : in out; theArray : PShortReal from BinObjMgt;
theLength: Integer from Standard)
returns like me;
---C++: return &
---Purpose: Put C array of float, theLength is the number of elements
GetCharacter (me : in; theValue : out Character from Standard)
returns like me;
---C++: alias operator >>
---C++: return const &
GetByte (me : in; theValue : out Byte from Standard)
returns like me;
---C++: alias operator >>
---C++: return const &
GetExtCharacter (me : in; theValue : out ExtCharacter from Standard)
returns like me;
---C++: alias operator >>
---C++: return const &
GetInteger (me : in; theValue : out Integer from Standard)
returns like me;
---C++: alias operator >>
---C++: return const &
GetBoolean (me : in; theValue : out Boolean from Standard)
returns like me;
---C++: alias operator >>
---C++: inline
---C++: return const &
GetReal (me : in; theValue : out Real from Standard)
returns like me;
---C++: alias operator >>
---C++: return const &
GetShortReal (me : in; theValue : out ShortReal from Standard)
returns like me;
---C++: alias operator >>
---C++: return const &
GetAsciiString (me : in; theValue : out AsciiString from TCollection)
returns like me;
---C++: alias operator >>
---C++: return const &
GetExtendedString (me : in; theValue : out ExtendedString from TCollection)
returns like me;
---C++: alias operator >>
---C++: return const &
GetLabel (me : in; theDS : Data from TDF;
theValue : out Label from TDF)
returns like me;
---C++: return const &
GetGUID (me : in; theValue : out GUID from Standard)
returns like me;
---C++: alias operator >>
---C++: return const &
GetCharArray (me : in; theArray : PChar from BinObjMgt;
theLength: Integer from Standard)
returns like me;
---C++: return const &
---Purpose: Get C array of char, theLength is the number of elements;
-- theArray must point to a
-- space enough to place theLength elements
GetByteArray (me : in; theArray : PByte from BinObjMgt;
theLength: Integer from Standard)
returns like me;
---C++: return const &
---Purpose: Get C array of unsigned chars, theLength is the number of elements;
-- theArray must point to a
-- space enough to place theLength elements
GetExtCharArray (me : in; theArray : PExtChar from BinObjMgt;
theLength: Integer from Standard)
returns like me;
---C++: return const &
---Purpose: Get C array of ExtCharacter, theLength is the number of elements;
-- theArray must point to a
-- space enough to place theLength elements
GetIntArray (me : in; theArray : PInteger from BinObjMgt;
theLength: Integer from Standard)
returns like me;
---C++: return const &
---Purpose: Get C array of int, theLength is the number of elements;
-- theArray must point to a
-- space enough to place theLength elements
GetRealArray (me : in; theArray : PReal from BinObjMgt;
theLength: Integer from Standard)
returns like me;
---C++: return const &
---Purpose: Get C array of double, theLength is the number of elements;
-- theArray must point to a
-- space enough to place theLength elements
GetShortRealArray (me : in; theArray : PShortReal from BinObjMgt;
theLength: Integer from Standard)
returns like me;
---C++: return const &
---Purpose: Get C array of float, theLength is the number of elements;
-- theArray must point to a
-- space enough to place theLength elements
Position (me) returns Integer from Standard;
---C++: inline
---Purpose: Tells the current position for get/put
SetPosition (me; thePos : Integer from Standard)
returns Boolean from Standard;
---C++: inline
---Purpose: Sets the current position for get/put.
-- Resets an error state depending on the validity of thePos.
-- Returns the new state (value of IsOK())
Truncate (me : in out);
---C++: inline
---Purpose: Truncates the buffer by current position,
-- i.e. updates mySize
IsError (me) returns Boolean from Standard;
---C++: inline
---C++: alias operator !
---Purpose: Indicates an error after Get methods or SetPosition
IsOK (me) returns Boolean from Standard;
---C++: inline
---C++: alias "operator Standard_Boolean () const { return IsOK(); }"
---Purpose: Indicates a good state after Get methods or SetPosition
-------------------------------------------
---Category: API for retrieval/storage driver
-------------------------------------------
Init (me: in out);
---Purpose: Initializes me to reuse again
SetId (me:out; theId: Integer from Standard)
is static;
---C++: inline
---Purpose: Sets the Id of the object
SetTypeId (me:out; theId: Integer from Standard)
is static;
---C++: inline
---Purpose: Sets the Id of the type of the object
Id (me) returns Integer from Standard
is static;
---C++: inline
---Purpose: Returns the Id of the object
TypeId (me) returns Integer from Standard
is static;
---C++: inline
---Purpose: Returns the Id of the type of the object
Length (me) returns Integer from Standard
is static;
---C++: inline
---Purpose: Returns the length of data
Write (me: in out; theOS: in out OStream from Standard)
returns OStream from Standard is static;
---C++: return &
---Purpose: Stores <me> to the stream.
-- inline Standard_OStream& operator<< (Standard_OStream&,
-- BinObjMgt_Persistent&) is also available
Read (me: in out; theIS: in out IStream from Standard)
returns IStream from Standard is static;
---C++: return &
---Purpose: Retrieves <me> from the stream.
-- inline Standard_IStream& operator>> (Standard_IStream&,
-- BinObjMgt_Persistent&) is also available
Destroy (me: in out);
---C++: alias ~
---Purpose: Frees the allocated memory;
-- This object can be reused after call to Init
-------------------------------------------
---Category: Private methods
-------------------------------------------
alignOffset (me; theSize: Integer from Standard;
toClear: Boolean from Standard = Standard_False)
is private;
---C++: inline
---Purpose: Aligns myOffset to the given size;
-- enters the next piece if the end of the current one is reached;
-- toClear==true means to fill unused space by 0
prepareForPut (me: in out; theSize: Integer from Standard)
returns Integer from Standard is private;
---C++: inline
---Purpose: Prepares the room for theSize bytes;
-- returns the number of pieces except for the current one
-- are to be occupied
incrementData (me: in out; theNbPieces: Integer from Standard)
is private;
---Purpose: Allocates theNbPieces more pieces
noMoreData (me; theSize: Integer from Standard)
returns Boolean from Standard is private;
---C++: inline
---Purpose: Checks if there is no more data of the given size starting
-- from the current position in myData
putArray (me : in out; theArray : Address from Standard;
theSize : Integer from Standard)
is private;
---Purpose: Puts theLength bytes from theArray
getArray (me : in; theArray : Address from Standard;
theSize : Integer from Standard)
is private;
---Purpose: Gets theLength bytes into theArray
inverseExtCharData (me : in out;
theIndex, theOffset, theSize : Integer from Standard)
is private;
---Purpose: Inverses bytes in the data addressed by the given values
inverseIntData (me : in out;
theIndex, theOffset, theSize : Integer from Standard)
is private;
---Purpose: Inverses bytes in the data addressed by the given values
inverseRealData (me : in out;
theIndex, theOffset, theSize : Integer from Standard)
is private;
---Purpose: Inverses bytes in the data addressed by the given values
inverseShortRealData (me : in out;
theIndex, theOffset, theSize : Integer from Standard)
is private;
---Purpose: Inverses bytes in the data addressed by the given values
fields
-- Sequence of pieces of data; the 1st piece is as follows:
-- (int) [0] the TypeId
-- (int) [1] the Id
-- (int) [2] the length of data of the object in bytes
-- the remainder is for data of the object
myData : SequenceOfAddress from TColStd;
-- Current position: the piece index (start from 1) and offset (start from 0)
myIndex : Integer from Standard;
myOffset : Integer from Standard;
-- The size of filled data
mySize : Integer from Standard;
myIsError : Boolean from Standard;
end Persistent;
|
