Open CASCADE Technology  7.4.1.dev
Public Member Functions
StdStorage_Data Class Reference

A picture memorizing the stored in a container (for example, in a file). A StdStorage_Data object represents either: More...

#include <StdStorage_Data.hxx>

Inheritance diagram for StdStorage_Data:
Inheritance graph
[legend]

Public Member Functions

 StdStorage_Data ()
 Creates an empty set of data. You explicitly create a StdStorage_Data object when preparing the set of objects to be stored together in a container (for example, in a file). Then use the function StdStorage_RootData's AddRoot to add persistent objects to the set of data. A StdStorage_Data object is also returned by the Read function of a StdStorage algorithm. Use the StdStorage_RootData's functions NumberOfRoots and Roots to find the roots which were stored in the read container. More...
 
void Clear ()
 Makes the container empty. More...
 
Handle< StdStorage_HeaderDataHeaderData ()
 Returns the header data section. More...
 
Handle< StdStorage_TypeDataTypeData ()
 Returns the type data section. More...
 
Handle< StdStorage_RootDataRootData ()
 Returns the root data section. More...
 
- Public Member Functions inherited from Standard_Transient
 Standard_Transient ()
 Empty constructor. More...
 
 Standard_Transient (const Standard_Transient &)
 Copy constructor – does nothing. More...
 
Standard_Transientoperator= (const Standard_Transient &)
 Assignment operator, needed to avoid copying reference counter. More...
 
virtual ~Standard_Transient ()
 Destructor must be virtual. More...
 
virtual void Delete () const
 Memory deallocator for transient classes. More...
 
virtual const opencascade::handle< Standard_Type > & DynamicType () const
 Returns a type descriptor about this object. More...
 
Standard_Boolean IsInstance (const opencascade::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 opencascade::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...
 
Standard_TransientThis () const
 Returns non-const pointer to this object (like const_cast). For protection against creating handle to objects allocated in stack or call from constructor, it will raise exception Standard_ProgramError if reference counter is zero. More...
 
Standard_Integer GetRefCount () const
 Get the reference counter of this object. More...
 
void IncrementRefCounter () const
 Increments the reference counter of this object. More...
 
Standard_Integer DecrementRefCounter () const
 Decrements the reference counter of this object; returns the decremented value. More...
 

Additional Inherited Members

- Public Types inherited from Standard_Transient
typedef void base_type
 Returns a type descriptor about this object. More...
 
- Static Public Member Functions inherited from Standard_Transient
static const char * get_type_name ()
 Returns a type descriptor about this object. More...
 
static const opencascade::handle< Standard_Type > & get_type_descriptor ()
 Returns type descriptor of Standard_Transient class. More...
 

Detailed Description

A picture memorizing the stored in a container (for example, in a file). A StdStorage_Data object represents either:

Constructor & Destructor Documentation

◆ StdStorage_Data()

StdStorage_Data::StdStorage_Data ( )

Creates an empty set of data. You explicitly create a StdStorage_Data object when preparing the set of objects to be stored together in a container (for example, in a file). Then use the function StdStorage_RootData's AddRoot to add persistent objects to the set of data. A StdStorage_Data object is also returned by the Read function of a StdStorage algorithm. Use the StdStorage_RootData's functions NumberOfRoots and Roots to find the roots which were stored in the read container.

Member Function Documentation

◆ Clear()

void StdStorage_Data::Clear ( )

Makes the container empty.

◆ HeaderData()

Handle< StdStorage_HeaderData > StdStorage_Data::HeaderData ( )
inline

Returns the header data section.

◆ RootData()

Handle< StdStorage_RootData > StdStorage_Data::RootData ( )
inline

Returns the root data section.

◆ TypeData()

Handle< StdStorage_TypeData > StdStorage_Data::TypeData ( )
inline

Returns the type data section.


The documentation for this class was generated from the following file: