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

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:
Inheritance graph
[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. More...
 
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. More...
 
TCollection_AsciiString CreationDate () const
 Return the creation date. More...
 
TCollection_AsciiString StorageVersion () const
 Return the Storage package version. More...
 
TCollection_AsciiString SchemaVersion () const
 Get the version of the schema. More...
 
void SetApplicationVersion (const TCollection_AsciiString &aVersion)
 Set the version of the application. More...
 
TCollection_AsciiString ApplicationVersion () const
 Get the version of the application. More...
 
void SetApplicationName (const TCollection_ExtendedString &aName)
 Set the name of the application. More...
 
TCollection_ExtendedString ApplicationName () const
 Get the name of the application. More...
 
void SetDataType (const TCollection_ExtendedString &aType)
 Set the data type. More...
 
TCollection_ExtendedString DataType () const
 Returns data type. More...
 
void AddToUserInfo (const TCollection_AsciiString &theUserInfo)
 Add <theUserInfo> to the user informations. More...
 
const TColStd_SequenceOfAsciiStringUserInfo () const
 Return the user informations. More...
 
void AddToComments (const TCollection_ExtendedString &aComment)
 Add <theUserInfo> to the user informations. More...
 
const TColStd_SequenceOfExtendedStringComments () const
 Return the user informations. More...
 
Standard_Integer NumberOfObjects () const
 Returns the number of persistent objects. 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 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. 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 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 informations.

◆ AddToUserInfo()

void StdStorage_HeaderData::AddToUserInfo ( const TCollection_AsciiString theUserInfo)

Add <theUserInfo> to the user informations.

◆ 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 informations.

◆ 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

Return the user informations.

◆ Write()

Standard_Boolean StdStorage_HeaderData::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.


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