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:

Public Member Functions
bool	Read (const occ::handle< Storage_BaseDriver > &theDriver)
	Reads the type data section from the container defined by theDriver. Returns true in case of success. Otherwise, one need to get an error code and description using ErrorStatus and ErrorStatusExtension functions correspondingly.
bool	Write (const occ::handle< Storage_BaseDriver > &theDriver)
	Writes the type data section to the container defined by theDriver. Returns true in case of success. Otherwise, one need to get an error code and description using ErrorStatus and ErrorStatusExtension functions correspondingly.
int	NumberOfTypes () const
	Returns the number of registered types.
void	AddType (const TCollection_AsciiString &aTypeName, const int aTypeNum)
	Add a type to the list in case of reading data.
int	AddType (const occ::handle< StdObjMgt_Persistent > &aPObj)
	Add a type of the persistent object in case of writing data.
TCollection_AsciiString	Type (const int aTypeNum) const
	Returns the name of the type with number <aTypeNum>.
int	Type (const TCollection_AsciiString &aTypeName) const
	Returns the name of the type with number <aTypeNum>.
StdObjMgt_Persistent::Instantiator	Instantiator (const int aTypeNum) const
	Returns a persistent object instantiator of <aTypeName>.
bool	IsType (const TCollection_AsciiString &aName) const
	Checks if <aName> is a registered type.
occ::handle< NCollection_HSequence< TCollection_AsciiString > >	Types () const
	Returns a sequence of all registered types.
Storage_Error	ErrorStatus () const
	Returns a status of the latest call to Read / Write functions.
TCollection_AsciiString	ErrorStatusExtension () const
	Returns an error message if any of the latest call to Read / Write functions.
void	ClearErrorStatus ()
	Clears error status.
void	Clear ()
	Unregisters all types.
Public Member Functions inherited from Standard_Transient
	Standard_Transient ()
	Empty constructor.
	Standard_Transient (const Standard_Transient &)
	Copy constructor – does nothing.
Standard_Transient &	operator= (const Standard_Transient &)
	Assignment operator, needed to avoid copying reference counter.
virtual	~Standard_Transient ()=default
	Destructor must be virtual.
virtual const opencascade::handle< Standard_Type > &	DynamicType () const
	Returns a type descriptor about this object.
bool	IsInstance (const opencascade::handle< Standard_Type > &theType) const
	Returns a true value if this is an instance of Type.
bool	IsInstance (const char *const theTypeName) const
	Returns a true value if this is an instance of TypeName.
bool	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.
bool	IsKind (const char *const 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.
Standard_Transient *	This () 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.
int	GetRefCount () const noexcept
	Get the reference counter of this object.
void	IncrementRefCounter () noexcept
	Increments the reference counter of this object. Uses relaxed memory ordering since incrementing only requires atomicity, not synchronization with other memory operations.
int	DecrementRefCounter () noexcept
	Decrements the reference counter of this object; returns the decremented value. Uses release ordering for the decrement to ensure all writes to the object are visible before the count reaches zero. An acquire fence is added only when the count reaches zero, ensuring proper synchronization before deletion. This is more efficient than using acq_rel for every decrement.
virtual void	Delete () const
	Memory deallocator for transient classes.

Additional Inherited Members
typedef void	base_type
	Returns a type descriptor about this object.
static constexpr const char *	get_type_name ()
	Returns a type descriptor about this object.
static const opencascade::handle< Standard_Type > &	get_type_descriptor ()
	Returns type descriptor of Standard_Transient class.

Detailed Description

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

Member Function Documentation

AddType() [1/2]

int StdStorage_TypeData::AddType

(

const occ::handle< StdObjMgt_Persistent > &

aPObj

)

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

AddType() [2/2]

void StdStorage_TypeData::AddType	(	const TCollection_AsciiString &	aTypeName,
		const int	aTypeNum )

Add a type to the list in case of reading 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 int

aTypeNum

)

const

Returns a persistent object instantiator of <aTypeName>.

IsType()

bool StdStorage_TypeData::IsType

(

const TCollection_AsciiString &

aName

)

const

Checks if <aName> is a registered type.

NumberOfTypes()

int StdStorage_TypeData::NumberOfTypes

(

)

const

Returns the number of registered types.

Read()

bool StdStorage_TypeData::Read

(

const occ::handle< Storage_BaseDriver > &

theDriver

)

Reads the type data section from the container defined by theDriver. Returns 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 int

aTypeNum

)

const

Returns the name of the type with number <aTypeNum>.

Type() [2/2]

int StdStorage_TypeData::Type

(

const TCollection_AsciiString &

aTypeName

)

const

Returns the name of the type with number <aTypeNum>.

Types()

occ::handle< NCollection_HSequence< TCollection_AsciiString > > StdStorage_TypeData::Types

(

)

const

Returns a sequence of all registered types.

Write()

bool StdStorage_TypeData::Write

(

const occ::handle< Storage_BaseDriver > &

theDriver

)

Writes the type data section to the container defined by theDriver. Returns 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:

• StdStorage_TypeData.hxx