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

#include <Storage_HeaderData.hxx>

Inheritance diagram for Storage_HeaderData:
Inheritance graph
[legend]

Public Member Functions

 Storage_HeaderData ()
 
Standard_Boolean Read (const Handle< Storage_BaseDriver > &theDriver)
 
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...
 
TCollection_AsciiString SchemaName () const
 get the schema's name 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
 the the number of persistent objects Return: the number of persistent objects readed More...
 
Storage_Error ErrorStatus () const
 
TCollection_AsciiString ErrorStatusExtension () const
 
void ClearErrorStatus ()
 
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...
 

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 informations

◆ AddToUserInfo()

void Storage_HeaderData::AddToUserInfo ( const TCollection_AsciiString theUserInfo)

add <theUserInfo> to the user informations

◆ 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 TColStd_SequenceOfExtendedString& Storage_HeaderData::Comments ( ) const

return the user informations

◆ 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()

Standard_Integer Storage_HeaderData::NumberOfObjects ( ) const

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

◆ Read()

Standard_Boolean Storage_HeaderData::Read ( const 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 Standard_Integer  anObjectNumber)

◆ SetSchemaName()

void Storage_HeaderData::SetSchemaName ( const TCollection_AsciiString aName)

◆ SetSchemaVersion()

void Storage_HeaderData::SetSchemaVersion ( const TCollection_AsciiString aVersion)

◆ SetStorageVersion()

void Storage_HeaderData::SetStorageVersion ( const TCollection_AsciiString aVersion)

◆ StorageVersion()

TCollection_AsciiString Storage_HeaderData::StorageVersion ( ) const

return the Storage package version

◆ UserInfo()

const TColStd_SequenceOfAsciiString& Storage_HeaderData::UserInfo ( ) const

return the user informations


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