blob: cbf0e293909af8056dd1952a8d4af8ef9b261af4 (
plain)
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
|
// 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_Root_HeaderFile
#define _Storage_Root_HeaderFile
#ifndef _Standard_HeaderFile
#include <Standard.hxx>
#endif
#ifndef _Standard_DefineHandle_HeaderFile
#include <Standard_DefineHandle.hxx>
#endif
#ifndef _Handle_Storage_Root_HeaderFile
#include <Handle_Storage_Root.hxx>
#endif
#ifndef _TCollection_AsciiString_HeaderFile
#include <TCollection_AsciiString.hxx>
#endif
#ifndef _Handle_Standard_Persistent_HeaderFile
#include <Handle_Standard_Persistent.hxx>
#endif
#ifndef _Standard_Integer_HeaderFile
#include <Standard_Integer.hxx>
#endif
#ifndef _MMgt_TShared_HeaderFile
#include <MMgt_TShared.hxx>
#endif
class Standard_Persistent;
class Storage_Schema;
class TCollection_AsciiString;
//! A root object extracted from a Storage_Data object. <br>
//! A Storage_Root encapsulates a persistent <br>
//! object which is a root of a Storage_Data object. <br>
//! It contains additional information: the name and <br>
//! the data type of the persistent object. <br>
//! When retrieving a Storage_Data object from a <br>
//! container (for example, a file) you access its <br>
//! roots with the function Roots which returns a <br>
//! sequence of root objects. The provided functions <br>
//! allow you to request information about each root of the sequence. <br>
//! You do not create explicit roots: when inserting <br>
//! data in a Storage_Data object, you just provide <br>
//! the persistent object and optionally its name to the function AddRoot. <br>
class Storage_Root : public MMgt_TShared {
public:
Standard_EXPORT Storage_Root();
Standard_EXPORT Storage_Root(const TCollection_AsciiString& aName,const Handle(Standard_Persistent)& anObject);
Standard_EXPORT void SetName(const TCollection_AsciiString& aName) ;
//! Returns the name of this root object. <br>
//! The name may have been given explicitly when <br>
//! the root was inserted into the Storage_Data <br>
//! object. If not, the name is a reference number <br>
//! which was assigned automatically 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>
//! Warning <br>
//! The returned string will be empty if you call this <br>
//! function before having named this root object, <br>
//! either explicitly, or when writing the set of data <br>
//! into the container. <br>
Standard_EXPORT TCollection_AsciiString Name() const;
Standard_EXPORT void SetObject(const Handle(Standard_Persistent)& anObject) ;
//! Returns the persistent object encapsulated by this root. <br>
Standard_EXPORT Handle_Standard_Persistent Object() const;
//! Returns the name of this root type. <br>
Standard_EXPORT TCollection_AsciiString Type() const;
friend class Storage_Schema;
DEFINE_STANDARD_RTTI(Storage_Root)
protected:
private:
Standard_EXPORT void SetReference(const Standard_Integer aRef) ;
Standard_EXPORT Standard_Integer Reference() const;
Standard_EXPORT void SetType(const TCollection_AsciiString& aType) ;
TCollection_AsciiString myName;
TCollection_AsciiString myType;
Handle_Standard_Persistent myObject;
Standard_Integer myRef;
};
// other Inline functions and methods (like "C++: function call" methods)
#endif
|
