Storage_HeaderData Class Reference

#include <Storage_HeaderData.hxx>

Inheritance diagram for Storage_HeaderData:

Public Member Functions
	Storage_HeaderData ()
bool	Read (const occ::handle< Storage_BaseDriver > &theDriver)
TCollection_AsciiString	CreationDate () const
	return the creation date
TCollection_AsciiString	StorageVersion () const
	return the Storage package version
TCollection_AsciiString	SchemaVersion () const
	get the version of the schema
TCollection_AsciiString	SchemaName () const
	get the schema's name
void	SetApplicationVersion (const TCollection_AsciiString &aVersion)
	set the version of the application
TCollection_AsciiString	ApplicationVersion () const
	get the version of the application
void	SetApplicationName (const TCollection_ExtendedString &aName)
	set the name of the application
TCollection_ExtendedString	ApplicationName () const
	get the name of the application
void	SetDataType (const TCollection_ExtendedString &aType)
	set the data type
TCollection_ExtendedString	DataType () const
	returns data type
void	AddToUserInfo (const TCollection_AsciiString &theUserInfo)
	add <theUserInfo> to the user information
const NCollection_Sequence< TCollection_AsciiString > &	UserInfo () const
	return the user information
void	AddToComments (const TCollection_ExtendedString &aComment)
	add <theUserInfo> to the user information
const NCollection_Sequence< TCollection_ExtendedString > &	Comments () const
	return the user information
int	NumberOfObjects () const
	the number of persistent objects Return: the number of persistent objects readed
Storage_Error	ErrorStatus () const
TCollection_AsciiString	ErrorStatusExtension () const
void	ClearErrorStatus ()
void	SetNumberOfObjects (const int anObjectNumber)
void	SetStorageVersion (const TCollection_AsciiString &aVersion)
void	SetStorageVersion (const int theVersion)
void	SetCreationDate (const TCollection_AsciiString &aDate)
void	SetSchemaVersion (const TCollection_AsciiString &aVersion)
void	SetSchemaName (const TCollection_AsciiString &aName)
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.

Constructor & Destructor Documentation

Storage_HeaderData()

Storage_HeaderData::Storage_HeaderData

(

)

Member Function Documentation

AddToComments()

void Storage_HeaderData::AddToComments

(

const TCollection_ExtendedString &

aComment

)

add <theUserInfo> to the user information

AddToUserInfo()

void Storage_HeaderData::AddToUserInfo

(

const TCollection_AsciiString &

theUserInfo

)

add <theUserInfo> to the user information

ApplicationName()

TCollection_ExtendedString Storage_HeaderData::ApplicationName

(

)

const

get the name of the application

ApplicationVersion()

TCollection_AsciiString Storage_HeaderData::ApplicationVersion

(

)

const

get the version of the application

ClearErrorStatus()

void Storage_HeaderData::ClearErrorStatus

(

)

Comments()

const NCollection_Sequence< TCollection_ExtendedString > & Storage_HeaderData::Comments

(

)

const

return the user information

CreationDate()

TCollection_AsciiString Storage_HeaderData::CreationDate

(

)

const

return the creation date

DataType()

TCollection_ExtendedString Storage_HeaderData::DataType

(

)

const

returns data type

ErrorStatus()

Storage_Error Storage_HeaderData::ErrorStatus

(

)

const

ErrorStatusExtension()

TCollection_AsciiString Storage_HeaderData::ErrorStatusExtension

(

)

const

NumberOfObjects()

int Storage_HeaderData::NumberOfObjects

(

)

const

the number of persistent objects Return: the number of persistent objects readed

Read()

bool Storage_HeaderData::Read

(

const occ::handle< Storage_BaseDriver > &

theDriver

)

SchemaName()

TCollection_AsciiString Storage_HeaderData::SchemaName

(

)

const

get the schema's name

SchemaVersion()

TCollection_AsciiString Storage_HeaderData::SchemaVersion

(

)

const

get the version of the schema

SetApplicationName()

void Storage_HeaderData::SetApplicationName

(

const TCollection_ExtendedString &

aName

)

set the name of the application

SetApplicationVersion()

void Storage_HeaderData::SetApplicationVersion

(

const TCollection_AsciiString &

aVersion

)

set the version of the application

SetCreationDate()

void Storage_HeaderData::SetCreationDate

(

const TCollection_AsciiString &

aDate

)

SetDataType()

void Storage_HeaderData::SetDataType

(

const TCollection_ExtendedString &

aType

)

set the data type

SetNumberOfObjects()

void Storage_HeaderData::SetNumberOfObjects

(

const int

anObjectNumber

)

SetSchemaName()

void Storage_HeaderData::SetSchemaName

(

const TCollection_AsciiString &

aName

)

SetSchemaVersion()

void Storage_HeaderData::SetSchemaVersion

(

const TCollection_AsciiString &

aVersion

)

SetStorageVersion() [1/2]

void Storage_HeaderData::SetStorageVersion ( const int theVersion )

inline

SetStorageVersion() [2/2]

void Storage_HeaderData::SetStorageVersion

(

const TCollection_AsciiString &

aVersion

)

StorageVersion()

TCollection_AsciiString Storage_HeaderData::StorageVersion

(

)

const

return the Storage package version

UserInfo()

const NCollection_Sequence< TCollection_AsciiString > & Storage_HeaderData::UserInfo

(

)

const

return the user information

---

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

• Storage_HeaderData.hxx