Open CASCADE Technology  7.3.0
Public Member Functions
StdStorage_TypeData Class Reference

Storage type data section keeps association between persistent textual types and their numbers. More...

#include <StdStorage_TypeData.hxx>

Inheritance diagram for StdStorage_TypeData:
Inheritance graph
[legend]

Public Member Functions

Standard_Boolean Read (Storage_BaseDriver &theDriver)
 Reads the type 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 (Storage_BaseDriver &theDriver)
 Writes the type 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 NumberOfTypes () const
 Returns the number of registered types. More...
 
void AddType (const TCollection_AsciiString &aTypeName, const Standard_Integer aTypeNum)
 Add a type to the list in case of reading data. More...
 
Standard_Integer AddType (const Handle< StdObjMgt_Persistent > &aPObj)
 Add a type of the persistent object in case of writing data. More...
 
TCollection_AsciiString Type (const Standard_Integer aTypeNum) const
 Returns the name of the type with number <aTypeNum> More...
 
Standard_Integer Type (const TCollection_AsciiString &aTypeName) const
 Returns the name of the type with number <aTypeNum> More...
 
StdObjMgt_Persistent::Instantiator Instantiator (const Standard_Integer aTypeNum) const
 Returns a persistent object instantiator of <aTypeName> More...
 
Standard_Boolean IsType (const TCollection_AsciiString &aName) const
 Checks if <aName> is a registered type. More...
 
Handle< TColStd_HSequenceOfAsciiString > Types () const
 Returns a sequence of all registered types. 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 ()
 Unregisters all types. 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 type data section keeps association between persistent textual types and their numbers.

Member Function Documentation

◆ AddType() [1/2]

void StdStorage_TypeData::AddType ( const TCollection_AsciiString aTypeName,
const Standard_Integer  aTypeNum 
)

Add a type to the list in case of reading data.

◆ AddType() [2/2]

Standard_Integer StdStorage_TypeData::AddType ( const Handle< StdObjMgt_Persistent > &  aPObj)

Add a type of the persistent object in case of writing data.

◆ Clear()

void StdStorage_TypeData::Clear ( )

Unregisters all types.

◆ ClearErrorStatus()

void StdStorage_TypeData::ClearErrorStatus ( )

Clears error status.

◆ ErrorStatus()

Storage_Error StdStorage_TypeData::ErrorStatus ( ) const

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

◆ ErrorStatusExtension()

TCollection_AsciiString StdStorage_TypeData::ErrorStatusExtension ( ) const

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

◆ Instantiator()

StdObjMgt_Persistent::Instantiator StdStorage_TypeData::Instantiator ( const Standard_Integer  aTypeNum) const

Returns a persistent object instantiator of <aTypeName>

◆ IsType()

Standard_Boolean StdStorage_TypeData::IsType ( const TCollection_AsciiString aName) const

Checks if <aName> is a registered type.

◆ NumberOfTypes()

Standard_Integer StdStorage_TypeData::NumberOfTypes ( ) const

Returns the number of registered types.

◆ Read()

Standard_Boolean StdStorage_TypeData::Read ( Storage_BaseDriver theDriver)

Reads the type 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.

◆ Type() [1/2]

TCollection_AsciiString StdStorage_TypeData::Type ( const Standard_Integer  aTypeNum) const

Returns the name of the type with number <aTypeNum>

◆ Type() [2/2]

Standard_Integer StdStorage_TypeData::Type ( const TCollection_AsciiString aTypeName) const

Returns the name of the type with number <aTypeNum>

◆ Types()

Handle< TColStd_HSequenceOfAsciiString > StdStorage_TypeData::Types ( ) const

Returns a sequence of all registered types.

◆ Write()

Standard_Boolean StdStorage_TypeData::Write ( Storage_BaseDriver theDriver)

Writes the type 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: