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

Storage root data section contains root persistent objects. More...

#include <StdStorage_RootData.hxx>

Inheritance diagram for StdStorage_RootData:
Inheritance graph
[legend]

Public Member Functions

Standard_Boolean Read (const Handle< Storage_BaseDriver > &theDriver)
 Reads the root data section from the container defined by theDriver. Returns Standard_True in case of success. Otherwise, one need to get an error code and description using ErrorStatus and ErrorStatusExtension functions correspondingly. More...
 
Standard_Boolean Write (const Handle< Storage_BaseDriver > &theDriver)
 Writes the root data section to the container defined by theDriver. Returns Standard_True in case of success. Otherwise, one need to get an error code and description using ErrorStatus and ErrorStatusExtension functions correspondingly. More...
 
Standard_Integer NumberOfRoots () const
 Returns the number of roots. More...
 
void AddRoot (const Handle< StdStorage_Root > &aRoot)
 Add a root to <me>. If a root with same name is present, it will be replaced by <aRoot>. More...
 
Handle< StdStorage_HSequenceOfRoots > Roots () const
 Returns a sequence of all roots. More...
 
Handle< StdStorage_RootFind (const TCollection_AsciiString &aName) const
 Finds a root with name <aName>. More...
 
Standard_Boolean IsRoot (const TCollection_AsciiString &aName) const
 Returns Standard_True if <me> contains a root named <aName> More...
 
void RemoveRoot (const TCollection_AsciiString &aName)
 Removes the root named <aName>. More...
 
Storage_Error ErrorStatus () const
 Returns a status of the latest call to Read / Write functions. More...
 
TCollection_AsciiString ErrorStatusExtension () const
 Returns an error message if any of the latest call to Read / Write functions. More...
 
void ClearErrorStatus ()
 Clears error status. More...
 
void Clear ()
 Removes all persistent root objects. 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

Storage root data section contains root persistent objects.

Member Function Documentation

◆ AddRoot()

void StdStorage_RootData::AddRoot ( const Handle< StdStorage_Root > &  aRoot)

Add a root to <me>. If a root with same name is present, it will be replaced by <aRoot>.

◆ Clear()

void StdStorage_RootData::Clear ( )

Removes all persistent root objects.

◆ ClearErrorStatus()

void StdStorage_RootData::ClearErrorStatus ( )

Clears error status.

◆ ErrorStatus()

Storage_Error StdStorage_RootData::ErrorStatus ( ) const

Returns a status of the latest call to Read / Write functions.

◆ ErrorStatusExtension()

TCollection_AsciiString StdStorage_RootData::ErrorStatusExtension ( ) const

Returns an error message if any of the latest call to Read / Write functions.

◆ Find()

Handle< StdStorage_Root > StdStorage_RootData::Find ( const TCollection_AsciiString aName) const

Finds a root with name <aName>.

◆ IsRoot()

Standard_Boolean StdStorage_RootData::IsRoot ( const TCollection_AsciiString aName) const

Returns Standard_True if <me> contains a root named <aName>

◆ NumberOfRoots()

Standard_Integer StdStorage_RootData::NumberOfRoots ( ) const

Returns the number of roots.

◆ Read()

Standard_Boolean StdStorage_RootData::Read ( const Handle< Storage_BaseDriver > &  theDriver)

Reads the root data section from the container defined by theDriver. Returns Standard_True in case of success. Otherwise, one need to get an error code and description using ErrorStatus and ErrorStatusExtension functions correspondingly.

◆ RemoveRoot()

void StdStorage_RootData::RemoveRoot ( const TCollection_AsciiString aName)

Removes the root named <aName>.

◆ Roots()

Handle< StdStorage_HSequenceOfRoots > StdStorage_RootData::Roots ( ) const

Returns a sequence of all roots.

◆ Write()

Standard_Boolean StdStorage_RootData::Write ( const Handle< Storage_BaseDriver > &  theDriver)

Writes the root data section to the container defined by theDriver. Returns Standard_True in case of success. Otherwise, one need to get an error code and description using ErrorStatus and ErrorStatusExtension functions correspondingly.


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