|
Open CASCADE Technology
6.7.1
|
All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
|
Open CASCADE Technology
6.7.1
|
A root object extracted from a Storage_Data object.
A Storage_Root encapsulates a persistent
object which is a root of a Storage_Data object.
It contains additional information: the name and
the data type of the persistent object.
When retrieving a Storage_Data object from a
container (for example, a file) you access its
roots with the function Roots which returns a
sequence of root objects. The provided functions
allow you to request information about each root of the sequence.
You do not create explicit roots: when inserting
data in a Storage_Data object, you just provide
the persistent object and optionally its name to the function AddRoot.
More...
#include <Storage_Root.hxx>
Public Member Functions | |
| Storage_Root () | |
| Storage_Root (const TCollection_AsciiString &aName, const Handle< Standard_Persistent > &anObject) | |
| void | SetName (const TCollection_AsciiString &aName) |
| TCollection_AsciiString | Name () const |
| Returns the name of this root object. The name may have been given explicitly when the root was inserted into the Storage_Data object. If not, the name is a reference number which was assigned automatically by the driver when writing the set of data into the container. When naming the roots, it is easier to retrieve objects by significant references rather than by references without any semantic values. Warning The returned string will be empty if you call this function before having named this root object, either explicitly, or when writing the set of data into the container. More... | |
| void | SetObject (const Handle< Standard_Persistent > &anObject) |
| Handle_Standard_Persistent | Object () const |
| Returns the persistent object encapsulated by this root. More... | |
| TCollection_AsciiString | Type () const |
| Returns the name of this root type. More... | |
 Public Member Functions inherited from MMgt_TShared | |
| virtual void | Delete () const |
| Memory deallocator for transient classes. More... | |
| Public Member Functions inherited from Standard_Transient | |
| Standard_Transient () | |
| Empty constructor. More... | |
| Standard_Transient (const Standard_Transient &) | |
| Copy constructor – does nothing. More... | |
| Standard_Transient & | operator= (const Standard_Transient &) |
| Assignment operator, needed to avoid copying reference counter. More... | |
| virtual | ~Standard_Transient () |
| Destructor must be virtual. More... | |
| virtual void | ShallowDump (Standard_OStream &) const |
| virtual const Handle_Standard_Type & | DynamicType () const |
| Returns a type information object about this object. More... | |
| Standard_Boolean | IsInstance (const Handle_Standard_Type &theType) const |
| Returns a true value if this is an instance of Type. More... | |
| Standard_Boolean | IsInstance (const Standard_CString theTypeName) const |
| Returns a true value if this is an instance of TypeName. More... | |
| Standard_Boolean | IsKind (const Handle_Standard_Type &theType) const |
| Returns true if this is an instance of Type or an instance of any class that inherits from Type. Note that multiple inheritance is not supported by OCCT RTTI mechanism. More... | |
| Standard_Boolean | IsKind (const Standard_CString theTypeName) const |
| Returns true if this is an instance of TypeName or an instance of any class that inherits from TypeName. Note that multiple inheritance is not supported by OCCT RTTI mechanism. More... | |
| virtual Handle_Standard_Transient | This () const |
| Returns a Handle which references this object. Must never be called to objects created in stack. More... | |
| Standard_Integer | GetRefCount () const |
| Get the reference counter of this object. More... | |
A root object extracted from a Storage_Data object.
A Storage_Root encapsulates a persistent
object which is a root of a Storage_Data object.
It contains additional information: the name and
the data type of the persistent object.
When retrieving a Storage_Data object from a
container (for example, a file) you access its
roots with the function Roots which returns a
sequence of root objects. The provided functions
allow you to request information about each root of the sequence.
You do not create explicit roots: when inserting
data in a Storage_Data object, you just provide
the persistent object and optionally its name to the function AddRoot.
| Storage_Root::Storage_Root | ( | ) |
| Storage_Root::Storage_Root | ( | const TCollection_AsciiString & | aName, |
| const Handle< Standard_Persistent > & | anObject | ||
| ) |
| TCollection_AsciiString Storage_Root::Name | ( | ) | const |
Returns the name of this root object.
The name may have been given explicitly when
the root was inserted into the Storage_Data
object. If not, the name is a reference number
which was assigned automatically by the driver
when writing the set of data into the container.
When naming the roots, it is easier to retrieve
objects by significant references rather than by
references without any semantic values.
Warning
The returned string will be empty if you call this
function before having named this root object,
either explicitly, or when writing the set of data
into the container.
| Handle_Standard_Persistent Storage_Root::Object | ( | ) | const |
Returns the persistent object encapsulated by this root.
| void Storage_Root::SetName | ( | const TCollection_AsciiString & | aName | ) |
| void Storage_Root::SetObject | ( | const Handle< Standard_Persistent > & | anObject | ) |
| TCollection_AsciiString Storage_Root::Type | ( | ) | const |
Returns the name of this root type.
1.8.5