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
|
// This file is generated by WOK (CPPExt).
// Please do not edit this file; modify original file instead.
// The copyright and license terms as defined for the original file apply to
// this header file considered to be the "object code" form of the original source.
#ifndef _Storage_Data_HeaderFile
#define _Storage_Data_HeaderFile
#ifndef _Standard_HeaderFile
#include <Standard.hxx>
#endif
#ifndef _Standard_DefineHandle_HeaderFile
#include <Standard_DefineHandle.hxx>
#endif
#ifndef _Handle_Storage_Data_HeaderFile
#include <Handle_Storage_Data.hxx>
#endif
#ifndef _Handle_Storage_HeaderData_HeaderFile
#include <Handle_Storage_HeaderData.hxx>
#endif
#ifndef _Handle_Storage_RootData_HeaderFile
#include <Handle_Storage_RootData.hxx>
#endif
#ifndef _Handle_Storage_TypeData_HeaderFile
#include <Handle_Storage_TypeData.hxx>
#endif
#ifndef _Handle_Storage_InternalData_HeaderFile
#include <Handle_Storage_InternalData.hxx>
#endif
#ifndef _Storage_Error_HeaderFile
#include <Storage_Error.hxx>
#endif
#ifndef _TCollection_AsciiString_HeaderFile
#include <TCollection_AsciiString.hxx>
#endif
#ifndef _MMgt_TShared_HeaderFile
#include <MMgt_TShared.hxx>
#endif
#ifndef _Standard_Integer_HeaderFile
#include <Standard_Integer.hxx>
#endif
#ifndef _Handle_Standard_Persistent_HeaderFile
#include <Handle_Standard_Persistent.hxx>
#endif
#ifndef _Handle_Storage_HSeqOfRoot_HeaderFile
#include <Handle_Storage_HSeqOfRoot.hxx>
#endif
#ifndef _Handle_Storage_Root_HeaderFile
#include <Handle_Storage_Root.hxx>
#endif
#ifndef _Standard_Boolean_HeaderFile
#include <Standard_Boolean.hxx>
#endif
#ifndef _Handle_TColStd_HSequenceOfAsciiString_HeaderFile
#include <Handle_TColStd_HSequenceOfAsciiString.hxx>
#endif
class Storage_HeaderData;
class Storage_RootData;
class Storage_TypeData;
class Storage_InternalData;
class Storage_Schema;
class TCollection_AsciiString;
class TCollection_ExtendedString;
class TColStd_SequenceOfAsciiString;
class TColStd_SequenceOfExtendedString;
class Standard_Persistent;
class Storage_HSeqOfRoot;
class Storage_Root;
class TColStd_HSequenceOfAsciiString;
//! A picture memorizing the data stored in a <br>
//! container (for example, in a file). <br>
//! A Storage_Data object represents either: <br>
//! - persistent data to be written into a container, <br>
//! or <br>
//! - persistent data which are read from a container. <br>
//! A Storage_Data object is used in both the <br>
//! storage and retrieval operations: <br>
//! - Storage mechanism: create an empty <br>
//! Storage_Data object, then add successively <br>
//! persistent objects (roots) to be stored using <br>
//! the function AddRoot. When the set of data is <br>
//! complete, write it to a container using the <br>
//! function Write in your Storage_Schema <br>
//! storage/retrieval algorithm. <br>
//! - Retrieval mechanism: a Storage_Data <br>
//! object is returned by the Read function from <br>
//! your Storage_Schema storage/retrieval <br>
//! algorithm. Use the functions NumberOfRoots <br>
//! and Roots to find the roots which were stored <br>
//! in the read container. <br>
//! The roots of a Storage_Data object may share <br>
//! references on objects. The shared internal <br>
//! references of a Storage_Data object are <br>
//! maintained by the storage/retrieval mechanism. <br>
//! Note: References shared by objects which are <br>
//! contained in two distinct Storage_Data objects <br>
//! are not maintained by the storage/retrieval <br>
//! mechanism: external references are not <br>
//! supported by Storage_Schema algorithm <br>
class Storage_Data : public MMgt_TShared {
public:
//! Creates an empty set of data. <br>
//! You explicitly create a Storage_Data object <br>
//! when preparing the set of objects to be stored <br>
//! together in a container (for example, in a file). <br>
//! Then use the function AddRoot to add <br>
//! persistent objects to the set of data. <br>
//! A Storage_Data object is also returned by the <br>
//! Read function of a Storage_Schema <br>
//! storage/retrieval algorithm. Use the functions <br>
//! NumberOfRoots and Roots to find the roots <br>
//! which were stored in the read container. <br>
Standard_EXPORT Storage_Data();
//! Returns Storage_VSOk if <br>
//! - the last storage operation performed with the <br>
//! function Read, or <br>
//! - the last retrieval operation performed with the function Write <br>
//! by a Storage_Schema algorithm, on this set of data was successful. <br>
//! If the storage or retrieval operation was not <br>
//! performed, the returned error status indicates the <br>
//! reason why the operation failed. The algorithm <br>
//! stops its analysis at the first detected error <br>
Standard_EXPORT Storage_Error ErrorStatus() const;
//! Clears the error status positioned either by: <br>
//! - the last storage operation performed with the <br>
//! Read function, or <br>
//! - the last retrieval operation performed with the Write function <br>
//! by a Storage_Schema algorithm, on this set of data. <br>
//! This error status may be read by the function ErrorStatus. <br>
Standard_EXPORT void ClearErrorStatus() ;
Standard_EXPORT TCollection_AsciiString ErrorStatusExtension() const;
//! return the creation date <br>
Standard_EXPORT TCollection_AsciiString CreationDate() const;
//! return the Storage package version <br>
Standard_EXPORT TCollection_AsciiString StorageVersion() const;
//! get the version of the schema <br>
Standard_EXPORT TCollection_AsciiString SchemaVersion() const;
//! get the schema's name <br>
Standard_EXPORT TCollection_AsciiString SchemaName() const;
//! set the version of the application <br>
Standard_EXPORT void SetApplicationVersion(const TCollection_AsciiString& aVersion) ;
//! get the version of the application <br>
Standard_EXPORT TCollection_AsciiString ApplicationVersion() const;
//! set the name of the application <br>
Standard_EXPORT void SetApplicationName(const TCollection_ExtendedString& aName) ;
//! get the name of the application <br>
Standard_EXPORT TCollection_ExtendedString ApplicationName() const;
//! set the data type <br>
Standard_EXPORT void SetDataType(const TCollection_ExtendedString& aType) ;
//! returns data type <br>
Standard_EXPORT TCollection_ExtendedString DataType() const;
//! add <theUserInfo> to the user informations <br>
Standard_EXPORT void AddToUserInfo(const TCollection_AsciiString& anInfo) ;
//! return the user informations <br>
Standard_EXPORT const TColStd_SequenceOfAsciiString& UserInfo() const;
//! add <theUserInfo> to the user informations <br>
Standard_EXPORT void AddToComments(const TCollection_ExtendedString& aComment) ;
//! return the user informations <br>
Standard_EXPORT const TColStd_SequenceOfExtendedString& Comments() const;
//! the the number of persistent objects <br>
//! Return: <br>
//! the number of persistent objects readed <br>
Standard_EXPORT Standard_Integer NumberOfObjects() const;
//! Returns the number of root objects in this set of data. <br>
//! - When preparing a storage operation, the <br>
//! result is the number of roots inserted into this <br>
//! set of data with the function AddRoot. <br>
//! - When retrieving an object, the result is the <br>
//! number of roots stored in the read container. <br>
//! Use the Roots function to get these roots in a sequence. <br>
Standard_EXPORT Standard_Integer NumberOfRoots() const;
//! add a persistent root to write. the name of the root <br>
//! is a driver reference number. <br>
Standard_EXPORT void AddRoot(const Handle(Standard_Persistent)& anObject) const;
//! Adds the root anObject to this set of data. <br>
//! The name of the root is aName if given; if not, it <br>
//! will be a reference number assigned by the driver <br>
//! when writing the set of data into the container. <br>
//! When naming the roots, it is easier to retrieve <br>
//! objects by significant references rather than by <br>
//! references without any semantic values. <br>
Standard_EXPORT void AddRoot(const TCollection_AsciiString& aName,const Handle(Standard_Persistent)& anObject) const;
//! Removes from this set of data the root object named aName. <br>
//! Warning <br>
//! Nothing is done if there is no root object whose <br>
//! name is aName in this set of data. <br>
Standard_EXPORT void RemoveRoot(const TCollection_AsciiString& aName) ;
//! Returns the roots of this set of data in a sequence. <br>
//! - When preparing a storage operation, the <br>
//! sequence contains the roots inserted into this <br>
//! set of data with the function AddRoot. <br>
//! - When retrieving an object, the sequence <br>
//! contains the roots stored in the container read. <br>
//! - An empty sequence is returned if there is no root in this set of data. <br>
Standard_EXPORT Handle_Storage_HSeqOfRoot Roots() const;
//! Gives the root object whose name is aName in <br>
//! this set of data. The returned object is a <br>
//! Storage_Root object, from which the object it <br>
//! encapsulates may be extracted. <br>
//! Warning <br>
//! A null handle is returned if there is no root object <br>
//! whose name is aName in this set of data. <br>
Standard_EXPORT Handle_Storage_Root Find(const TCollection_AsciiString& aName) const;
//! returns Standard_True if <me> contains a root named <aName> <br>
Standard_EXPORT Standard_Boolean IsRoot(const TCollection_AsciiString& aName) const;
//! Returns the number of types of objects used in this set of data. <br>
Standard_EXPORT Standard_Integer NumberOfTypes() const;
//! Returns true if this set of data contains an object of type aName. <br>
//! Persistent objects from this set of data must <br>
//! have types which are recognized by the <br>
//! Storage_Schema algorithm used to store or retrieve them. <br>
Standard_EXPORT Standard_Boolean IsType(const TCollection_AsciiString& aName) const;
//! Gives the list of types of objects used in this set of data in a sequence. <br>
Standard_EXPORT Handle_TColStd_HSequenceOfAsciiString Types() const;
friend class Storage_Schema;
DEFINE_STANDARD_RTTI(Storage_Data)
protected:
private:
Standard_EXPORT Handle_Storage_HeaderData HeaderData() const;
Standard_EXPORT Handle_Storage_RootData RootData() const;
Standard_EXPORT Handle_Storage_TypeData TypeData() const;
Standard_EXPORT Handle_Storage_InternalData InternalData() const;
Standard_EXPORT void Clear() const;
Standard_EXPORT void SetErrorStatus(const Storage_Error anError) ;
Standard_EXPORT void SetErrorStatusExtension(const TCollection_AsciiString& anErrorExt) ;
Handle_Storage_HeaderData myHeaderData;
Handle_Storage_RootData myRootData;
Handle_Storage_TypeData myTypeData;
Handle_Storage_InternalData myInternal;
Storage_Error myErrorStatus;
TCollection_AsciiString myErrorStatusExt;
};
// other Inline functions and methods (like "C++: function call" methods)
#endif
|
