Storage header data section that contains some auxiliary information (application name, schema version, creation date, comments and so on...) More...

#include <StdStorage_HeaderData.hxx>

Inheritance diagram for StdStorage_HeaderData:

[legend]

Public Member Functions
Standard_Boolean	Read (const Handle< Storage_BaseDriver > &theDriver)
	Reads the header 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.

Standard_Boolean	Write (const Handle< Storage_BaseDriver > &theDriver)
	Writes the header 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.

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.

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 TColStd_SequenceOfAsciiString &	UserInfo () const
	Return the user information.

void	AddToComments (const TCollection_ExtendedString &aComment)
	Add <theUserInfo> to the user information.

const TColStd_SequenceOfExtendedString &	Comments () const
	Return the user information.

Standard_Integer	NumberOfObjects () const
	Returns the number of persistent objects.

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	SetNumberOfObjects (const Standard_Integer anObjectNumber)

void	SetStorageVersion (const TCollection_AsciiString &aVersion)

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 ()
	Destructor must be virtual.

virtual const opencascade::handle< Standard_Type > &	DynamicType () const
	Returns a type descriptor about this object.

Standard_Boolean	IsInstance (const opencascade::handle< Standard_Type > &theType) const
	Returns a true value if this is an instance of Type.

Standard_Boolean	IsInstance (const Standard_CString theTypeName) const
	Returns a true value if this is an instance of TypeName.

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.

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.

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.

Standard_Integer	GetRefCount () const noexcept
	Get the reference counter of this object.

void	IncrementRefCounter () noexcept
	Increments the reference counter of this object.

Standard_Integer	DecrementRefCounter () noexcept
	Decrements the reference counter of this object; returns the decremented value.

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 header data section that contains some auxiliary information (application name, schema version, creation date, comments and so on...)

Member Function Documentation

◆ AddToComments()

void StdStorage_HeaderData::AddToComments ( const TCollection_ExtendedString & aComment )

Add <theUserInfo> to the user information.

◆ AddToUserInfo()

void StdStorage_HeaderData::AddToUserInfo ( const TCollection_AsciiString & theUserInfo )

Add <theUserInfo> to the user information.

◆ ApplicationName()

TCollection_ExtendedString StdStorage_HeaderData::ApplicationName ( ) const

Get the name of the application.

◆ ApplicationVersion()

TCollection_AsciiString StdStorage_HeaderData::ApplicationVersion ( ) const

Get the version of the application.

◆ ClearErrorStatus()

void StdStorage_HeaderData::ClearErrorStatus ( )

Clears error status.

◆ Comments()

const TColStd_SequenceOfExtendedString & StdStorage_HeaderData::Comments ( ) const

Return the user information.

◆ CreationDate()

TCollection_AsciiString StdStorage_HeaderData::CreationDate ( ) const

Return the creation date.

◆ DataType()

TCollection_ExtendedString StdStorage_HeaderData::DataType ( ) const

Returns data type.

◆ ErrorStatus()

Storage_Error StdStorage_HeaderData::ErrorStatus ( ) const

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

◆ ErrorStatusExtension()

TCollection_AsciiString StdStorage_HeaderData::ErrorStatusExtension ( ) const

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

◆ NumberOfObjects()

Standard_Integer StdStorage_HeaderData::NumberOfObjects ( ) const

Returns the number of persistent objects.

◆ Read()

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

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

◆ SchemaVersion()

TCollection_AsciiString StdStorage_HeaderData::SchemaVersion ( ) const

Get the version of the schema.

◆ SetApplicationName()

void StdStorage_HeaderData::SetApplicationName ( const TCollection_ExtendedString & aName )

Set the name of the application.

◆ SetApplicationVersion()

void StdStorage_HeaderData::SetApplicationVersion ( const TCollection_AsciiString & aVersion )

Set the version of the application.

◆ SetCreationDate()

void StdStorage_HeaderData::SetCreationDate ( const TCollection_AsciiString & aDate )

◆ SetDataType()

void StdStorage_HeaderData::SetDataType ( const TCollection_ExtendedString & aType )

Set the data type.

◆ SetNumberOfObjects()

void StdStorage_HeaderData::SetNumberOfObjects ( const Standard_Integer anObjectNumber )

◆ SetSchemaName()

void StdStorage_HeaderData::SetSchemaName ( const TCollection_AsciiString & aName )

◆ SetSchemaVersion()

void StdStorage_HeaderData::SetSchemaVersion ( const TCollection_AsciiString & aVersion )

◆ SetStorageVersion()

void StdStorage_HeaderData::SetStorageVersion ( const TCollection_AsciiString & aVersion )

◆ StorageVersion()

TCollection_AsciiString StdStorage_HeaderData::StorageVersion ( ) const

Return the Storage package version.

◆ UserInfo()

const TColStd_SequenceOfAsciiString & StdStorage_HeaderData::UserInfo ( ) const