Open CASCADE Technology  7.2.0
Public Member Functions | Static Public Member Functions | Protected Member Functions

Storage_BaseDriver Class Referenceabstract

Root class for drivers. A driver assigns a physical container to data to be stored or retrieved, for instance a file. The FSD package provides two derived concrete classes : More...

#include <Storage_BaseDriver.hxx>

Inheritance diagram for Storage_BaseDriver:
Inheritance graph
[legend]

Public Member Functions

virtual ~Storage_BaseDriver ()
 
virtual Storage_Error Open (const TCollection_AsciiString &aName, const Storage_OpenMode aMode)=0
 
TCollection_AsciiString Name () const
 
Storage_OpenMode OpenMode () const
 
virtual Standard_Boolean IsEnd ()=0
 returns True if we are at end of the stream More...
 
virtual Storage_Position Tell ()=0
 return position in the file. Return -1 upon error. More...
 
virtual Storage_Error BeginWriteInfoSection ()=0
 
virtual void WriteInfo (const Standard_Integer nbObj, const TCollection_AsciiString &dbVersion, const TCollection_AsciiString &date, const TCollection_AsciiString &schemaName, const TCollection_AsciiString &schemaVersion, const TCollection_ExtendedString &appName, const TCollection_AsciiString &appVersion, const TCollection_ExtendedString &objectType, const TColStd_SequenceOfAsciiString &userInfo)=0
 
virtual Storage_Error EndWriteInfoSection ()=0
 
virtual Storage_Error BeginReadInfoSection ()=0
 
virtual void ReadInfo (Standard_Integer &nbObj, TCollection_AsciiString &dbVersion, TCollection_AsciiString &date, TCollection_AsciiString &schemaName, TCollection_AsciiString &schemaVersion, TCollection_ExtendedString &appName, TCollection_AsciiString &appVersion, TCollection_ExtendedString &objectType, TColStd_SequenceOfAsciiString &userInfo)=0
 
virtual void ReadCompleteInfo (Standard_IStream &theIStream, Handle< Storage_Data > &theData)=0
 
virtual Storage_Error EndReadInfoSection ()=0
 
virtual Storage_Error BeginWriteCommentSection ()=0
 
virtual void WriteComment (const TColStd_SequenceOfExtendedString &userComments)=0
 
virtual Storage_Error EndWriteCommentSection ()=0
 
virtual Storage_Error BeginReadCommentSection ()=0
 
virtual void ReadComment (TColStd_SequenceOfExtendedString &userComments)=0
 
virtual Storage_Error EndReadCommentSection ()=0
 
virtual Storage_Error BeginWriteTypeSection ()=0
 
virtual void SetTypeSectionSize (const Standard_Integer aSize)=0
 
virtual void WriteTypeInformations (const Standard_Integer typeNum, const TCollection_AsciiString &typeName)=0
 
virtual Storage_Error EndWriteTypeSection ()=0
 
virtual Storage_Error BeginReadTypeSection ()=0
 
virtual Standard_Integer TypeSectionSize ()=0
 
virtual void ReadTypeInformations (Standard_Integer &typeNum, TCollection_AsciiString &typeName)=0
 
virtual Storage_Error EndReadTypeSection ()=0
 
virtual Storage_Error BeginWriteRootSection ()=0
 
virtual void SetRootSectionSize (const Standard_Integer aSize)=0
 
virtual void WriteRoot (const TCollection_AsciiString &rootName, const Standard_Integer aRef, const TCollection_AsciiString &aType)=0
 
virtual Storage_Error EndWriteRootSection ()=0
 
virtual Storage_Error BeginReadRootSection ()=0
 
virtual Standard_Integer RootSectionSize ()=0
 
virtual void ReadRoot (TCollection_AsciiString &rootName, Standard_Integer &aRef, TCollection_AsciiString &aType)=0
 
virtual Storage_Error EndReadRootSection ()=0
 
virtual Storage_Error BeginWriteRefSection ()=0
 
virtual void SetRefSectionSize (const Standard_Integer aSize)=0
 
virtual void WriteReferenceType (const Standard_Integer reference, const Standard_Integer typeNum)=0
 
virtual Storage_Error EndWriteRefSection ()=0
 
virtual Storage_Error BeginReadRefSection ()=0
 
virtual Standard_Integer RefSectionSize ()=0
 
virtual void ReadReferenceType (Standard_Integer &reference, Standard_Integer &typeNum)=0
 
virtual Storage_Error EndReadRefSection ()=0
 
virtual Storage_Error BeginWriteDataSection ()=0
 
virtual void WritePersistentObjectHeader (const Standard_Integer aRef, const Standard_Integer aType)=0
 
virtual void BeginWritePersistentObjectData ()=0
 
virtual void BeginWriteObjectData ()=0
 
virtual void EndWriteObjectData ()=0
 
virtual void EndWritePersistentObjectData ()=0
 
virtual Storage_Error EndWriteDataSection ()=0
 
virtual Storage_Error BeginReadDataSection ()=0
 
virtual void ReadPersistentObjectHeader (Standard_Integer &aRef, Standard_Integer &aType)=0
 
virtual void BeginReadPersistentObjectData ()=0
 
virtual void BeginReadObjectData ()=0
 
virtual void EndReadObjectData ()=0
 
virtual void EndReadPersistentObjectData ()=0
 
virtual Storage_Error EndReadDataSection ()=0
 
virtual void SkipObject ()=0
 
virtual Storage_BaseDriverPutReference (const Standard_Integer aValue)=0
 
virtual Storage_BaseDriverPutCharacter (const Standard_Character aValue)=0
 
Storage_BaseDriveroperator<< (const Standard_Character aValue)
 
virtual Storage_BaseDriverPutExtCharacter (const Standard_ExtCharacter aValue)=0
 
Storage_BaseDriveroperator<< (const Standard_ExtCharacter aValue)
 
virtual Storage_BaseDriverPutInteger (const Standard_Integer aValue)=0
 
Storage_BaseDriveroperator<< (const Standard_Integer aValue)
 
virtual Storage_BaseDriverPutBoolean (const Standard_Boolean aValue)=0
 
Storage_BaseDriveroperator<< (const Standard_Boolean aValue)
 
virtual Storage_BaseDriverPutReal (const Standard_Real aValue)=0
 
Storage_BaseDriveroperator<< (const Standard_Real aValue)
 
virtual Storage_BaseDriverPutShortReal (const Standard_ShortReal aValue)=0
 
Storage_BaseDriveroperator<< (const Standard_ShortReal aValue)
 
virtual Storage_BaseDriverGetReference (Standard_Integer &aValue)=0
 
virtual Storage_BaseDriverGetCharacter (Standard_Character &aValue)=0
 
Storage_BaseDriveroperator>> (Standard_Character &aValue)
 
virtual Storage_BaseDriverGetExtCharacter (Standard_ExtCharacter &aValue)=0
 
Storage_BaseDriveroperator>> (Standard_ExtCharacter &aValue)
 
virtual Storage_BaseDriverGetInteger (Standard_Integer &aValue)=0
 
Storage_BaseDriveroperator>> (Standard_Integer &aValue)
 
virtual Storage_BaseDriverGetBoolean (Standard_Boolean &aValue)=0
 
Storage_BaseDriveroperator>> (Standard_Boolean &aValue)
 
virtual Storage_BaseDriverGetReal (Standard_Real &aValue)=0
 
Storage_BaseDriveroperator>> (Standard_Real &aValue)
 
virtual Storage_BaseDriverGetShortReal (Standard_ShortReal &aValue)=0
 
Storage_BaseDriveroperator>> (Standard_ShortReal &aValue)
 
virtual Storage_Error Close ()=0
 

Static Public Member Functions

static TCollection_AsciiString ReadMagicNumber (Standard_IStream &theIStream)
 

Protected Member Functions

 Storage_BaseDriver ()
 
void SetName (const TCollection_AsciiString &aName)
 
void SetOpenMode (const Storage_OpenMode aMode)
 

Detailed Description

Root class for drivers. A driver assigns a physical container to data to be stored or retrieved, for instance a file. The FSD package provides two derived concrete classes :

Constructor & Destructor Documentation

◆ ~Storage_BaseDriver()

virtual Storage_BaseDriver::~Storage_BaseDriver ( )
virtual

◆ Storage_BaseDriver()

Storage_BaseDriver::Storage_BaseDriver ( )
protected

Member Function Documentation

◆ BeginReadCommentSection()

virtual Storage_Error Storage_BaseDriver::BeginReadCommentSection ( )
pure virtual

◆ BeginReadDataSection()

virtual Storage_Error Storage_BaseDriver::BeginReadDataSection ( )
pure virtual

◆ BeginReadInfoSection()

virtual Storage_Error Storage_BaseDriver::BeginReadInfoSection ( )
pure virtual

◆ BeginReadObjectData()

virtual void Storage_BaseDriver::BeginReadObjectData ( )
pure virtual

◆ BeginReadPersistentObjectData()

virtual void Storage_BaseDriver::BeginReadPersistentObjectData ( )
pure virtual

◆ BeginReadRefSection()

virtual Storage_Error Storage_BaseDriver::BeginReadRefSection ( )
pure virtual

◆ BeginReadRootSection()

virtual Storage_Error Storage_BaseDriver::BeginReadRootSection ( )
pure virtual

◆ BeginReadTypeSection()

virtual Storage_Error Storage_BaseDriver::BeginReadTypeSection ( )
pure virtual

◆ BeginWriteCommentSection()

virtual Storage_Error Storage_BaseDriver::BeginWriteCommentSection ( )
pure virtual

◆ BeginWriteDataSection()

virtual Storage_Error Storage_BaseDriver::BeginWriteDataSection ( )
pure virtual

◆ BeginWriteInfoSection()

virtual Storage_Error Storage_BaseDriver::BeginWriteInfoSection ( )
pure virtual

◆ BeginWriteObjectData()

virtual void Storage_BaseDriver::BeginWriteObjectData ( )
pure virtual

◆ BeginWritePersistentObjectData()

virtual void Storage_BaseDriver::BeginWritePersistentObjectData ( )
pure virtual

◆ BeginWriteRefSection()

virtual Storage_Error Storage_BaseDriver::BeginWriteRefSection ( )
pure virtual

◆ BeginWriteRootSection()

virtual Storage_Error Storage_BaseDriver::BeginWriteRootSection ( )
pure virtual

◆ BeginWriteTypeSection()

virtual Storage_Error Storage_BaseDriver::BeginWriteTypeSection ( )
pure virtual

◆ Close()

virtual Storage_Error Storage_BaseDriver::Close ( )
pure virtual

◆ EndReadCommentSection()

virtual Storage_Error Storage_BaseDriver::EndReadCommentSection ( )
pure virtual

◆ EndReadDataSection()

virtual Storage_Error Storage_BaseDriver::EndReadDataSection ( )
pure virtual

◆ EndReadInfoSection()

virtual Storage_Error Storage_BaseDriver::EndReadInfoSection ( )
pure virtual

◆ EndReadObjectData()

virtual void Storage_BaseDriver::EndReadObjectData ( )
pure virtual

◆ EndReadPersistentObjectData()

virtual void Storage_BaseDriver::EndReadPersistentObjectData ( )
pure virtual

◆ EndReadRefSection()

virtual Storage_Error Storage_BaseDriver::EndReadRefSection ( )
pure virtual

◆ EndReadRootSection()

virtual Storage_Error Storage_BaseDriver::EndReadRootSection ( )
pure virtual

◆ EndReadTypeSection()

virtual Storage_Error Storage_BaseDriver::EndReadTypeSection ( )
pure virtual

◆ EndWriteCommentSection()

virtual Storage_Error Storage_BaseDriver::EndWriteCommentSection ( )
pure virtual

◆ EndWriteDataSection()

virtual Storage_Error Storage_BaseDriver::EndWriteDataSection ( )
pure virtual

◆ EndWriteInfoSection()

virtual Storage_Error Storage_BaseDriver::EndWriteInfoSection ( )
pure virtual

◆ EndWriteObjectData()

virtual void Storage_BaseDriver::EndWriteObjectData ( )
pure virtual

◆ EndWritePersistentObjectData()

virtual void Storage_BaseDriver::EndWritePersistentObjectData ( )
pure virtual

◆ EndWriteRefSection()

virtual Storage_Error Storage_BaseDriver::EndWriteRefSection ( )
pure virtual

◆ EndWriteRootSection()

virtual Storage_Error Storage_BaseDriver::EndWriteRootSection ( )
pure virtual

◆ EndWriteTypeSection()

virtual Storage_Error Storage_BaseDriver::EndWriteTypeSection ( )
pure virtual

◆ GetBoolean()

virtual Storage_BaseDriver& Storage_BaseDriver::GetBoolean ( Standard_Boolean aValue)
pure virtual

◆ GetCharacter()

virtual Storage_BaseDriver& Storage_BaseDriver::GetCharacter ( Standard_Character aValue)
pure virtual

◆ GetExtCharacter()

virtual Storage_BaseDriver& Storage_BaseDriver::GetExtCharacter ( Standard_ExtCharacter aValue)
pure virtual

◆ GetInteger()

virtual Storage_BaseDriver& Storage_BaseDriver::GetInteger ( Standard_Integer aValue)
pure virtual

◆ GetReal()

virtual Storage_BaseDriver& Storage_BaseDriver::GetReal ( Standard_Real aValue)
pure virtual

◆ GetReference()

virtual Storage_BaseDriver& Storage_BaseDriver::GetReference ( Standard_Integer aValue)
pure virtual

◆ GetShortReal()

virtual Storage_BaseDriver& Storage_BaseDriver::GetShortReal ( Standard_ShortReal aValue)
pure virtual

◆ IsEnd()

virtual Standard_Boolean Storage_BaseDriver::IsEnd ( )
pure virtual

returns True if we are at end of the stream

Implemented in FSD_BinaryFile, FSD_File, FSD_CmpFile, and DDF_IOStream.

◆ Name()

TCollection_AsciiString Storage_BaseDriver::Name ( ) const

◆ Open()

virtual Storage_Error Storage_BaseDriver::Open ( const TCollection_AsciiString aName,
const Storage_OpenMode  aMode 
)
pure virtual

◆ OpenMode()

Storage_OpenMode Storage_BaseDriver::OpenMode ( ) const

◆ operator<<() [1/6]

Storage_BaseDriver& Storage_BaseDriver::operator<< ( const Standard_Character  aValue)
inline

◆ operator<<() [2/6]

Storage_BaseDriver& Storage_BaseDriver::operator<< ( const Standard_ExtCharacter  aValue)
inline

◆ operator<<() [3/6]

Storage_BaseDriver& Storage_BaseDriver::operator<< ( const Standard_Integer  aValue)
inline

◆ operator<<() [4/6]

Storage_BaseDriver& Storage_BaseDriver::operator<< ( const Standard_Boolean  aValue)
inline

◆ operator<<() [5/6]

Storage_BaseDriver& Storage_BaseDriver::operator<< ( const Standard_Real  aValue)
inline

◆ operator<<() [6/6]

Storage_BaseDriver& Storage_BaseDriver::operator<< ( const Standard_ShortReal  aValue)
inline

◆ operator>>() [1/6]

Storage_BaseDriver& Storage_BaseDriver::operator>> ( Standard_Character aValue)
inline

◆ operator>>() [2/6]

Storage_BaseDriver& Storage_BaseDriver::operator>> ( Standard_ExtCharacter aValue)
inline

◆ operator>>() [3/6]

Storage_BaseDriver& Storage_BaseDriver::operator>> ( Standard_Integer aValue)
inline

◆ operator>>() [4/6]

Storage_BaseDriver& Storage_BaseDriver::operator>> ( Standard_Boolean aValue)
inline

◆ operator>>() [5/6]

Storage_BaseDriver& Storage_BaseDriver::operator>> ( Standard_Real aValue)
inline

◆ operator>>() [6/6]

Storage_BaseDriver& Storage_BaseDriver::operator>> ( Standard_ShortReal aValue)
inline

◆ PutBoolean()

virtual Storage_BaseDriver& Storage_BaseDriver::PutBoolean ( const Standard_Boolean  aValue)
pure virtual

◆ PutCharacter()

virtual Storage_BaseDriver& Storage_BaseDriver::PutCharacter ( const Standard_Character  aValue)
pure virtual

◆ PutExtCharacter()

virtual Storage_BaseDriver& Storage_BaseDriver::PutExtCharacter ( const Standard_ExtCharacter  aValue)
pure virtual

◆ PutInteger()

virtual Storage_BaseDriver& Storage_BaseDriver::PutInteger ( const Standard_Integer  aValue)
pure virtual

◆ PutReal()

virtual Storage_BaseDriver& Storage_BaseDriver::PutReal ( const Standard_Real  aValue)
pure virtual

◆ PutReference()

virtual Storage_BaseDriver& Storage_BaseDriver::PutReference ( const Standard_Integer  aValue)
pure virtual

◆ PutShortReal()

virtual Storage_BaseDriver& Storage_BaseDriver::PutShortReal ( const Standard_ShortReal  aValue)
pure virtual

◆ ReadComment()

virtual void Storage_BaseDriver::ReadComment ( TColStd_SequenceOfExtendedString userComments)
pure virtual

◆ ReadCompleteInfo()

virtual void Storage_BaseDriver::ReadCompleteInfo ( Standard_IStream theIStream,
Handle< Storage_Data > &  theData 
)
pure virtual

◆ ReadInfo()

virtual void Storage_BaseDriver::ReadInfo ( Standard_Integer nbObj,
TCollection_AsciiString dbVersion,
TCollection_AsciiString date,
TCollection_AsciiString schemaName,
TCollection_AsciiString schemaVersion,
TCollection_ExtendedString appName,
TCollection_AsciiString appVersion,
TCollection_ExtendedString objectType,
TColStd_SequenceOfAsciiString userInfo 
)
pure virtual

◆ ReadMagicNumber()

static TCollection_AsciiString Storage_BaseDriver::ReadMagicNumber ( Standard_IStream theIStream)
static

◆ ReadPersistentObjectHeader()

virtual void Storage_BaseDriver::ReadPersistentObjectHeader ( Standard_Integer aRef,
Standard_Integer aType 
)
pure virtual

◆ ReadReferenceType()

virtual void Storage_BaseDriver::ReadReferenceType ( Standard_Integer reference,
Standard_Integer typeNum 
)
pure virtual

◆ ReadRoot()

virtual void Storage_BaseDriver::ReadRoot ( TCollection_AsciiString rootName,
Standard_Integer aRef,
TCollection_AsciiString aType 
)
pure virtual

◆ ReadTypeInformations()

virtual void Storage_BaseDriver::ReadTypeInformations ( Standard_Integer typeNum,
TCollection_AsciiString typeName 
)
pure virtual

◆ RefSectionSize()

virtual Standard_Integer Storage_BaseDriver::RefSectionSize ( )
pure virtual

◆ RootSectionSize()

virtual Standard_Integer Storage_BaseDriver::RootSectionSize ( )
pure virtual

◆ SetName()

void Storage_BaseDriver::SetName ( const TCollection_AsciiString aName)
protected

◆ SetOpenMode()

void Storage_BaseDriver::SetOpenMode ( const Storage_OpenMode  aMode)
protected

◆ SetRefSectionSize()

virtual void Storage_BaseDriver::SetRefSectionSize ( const Standard_Integer  aSize)
pure virtual

◆ SetRootSectionSize()

virtual void Storage_BaseDriver::SetRootSectionSize ( const Standard_Integer  aSize)
pure virtual

◆ SetTypeSectionSize()

virtual void Storage_BaseDriver::SetTypeSectionSize ( const Standard_Integer  aSize)
pure virtual

◆ SkipObject()

virtual void Storage_BaseDriver::SkipObject ( )
pure virtual

◆ Tell()

virtual Storage_Position Storage_BaseDriver::Tell ( )
pure virtual

return position in the file. Return -1 upon error.

Implemented in FSD_BinaryFile, FSD_File, FSD_CmpFile, and DDF_IOStream.

◆ TypeSectionSize()

virtual Standard_Integer Storage_BaseDriver::TypeSectionSize ( )
pure virtual

◆ WriteComment()

virtual void Storage_BaseDriver::WriteComment ( const TColStd_SequenceOfExtendedString userComments)
pure virtual

◆ WriteInfo()

virtual void Storage_BaseDriver::WriteInfo ( const Standard_Integer  nbObj,
const TCollection_AsciiString dbVersion,
const TCollection_AsciiString date,
const TCollection_AsciiString schemaName,
const TCollection_AsciiString schemaVersion,
const TCollection_ExtendedString appName,
const TCollection_AsciiString appVersion,
const TCollection_ExtendedString objectType,
const TColStd_SequenceOfAsciiString userInfo 
)
pure virtual

◆ WritePersistentObjectHeader()

virtual void Storage_BaseDriver::WritePersistentObjectHeader ( const Standard_Integer  aRef,
const Standard_Integer  aType 
)
pure virtual

◆ WriteReferenceType()

virtual void Storage_BaseDriver::WriteReferenceType ( const Standard_Integer  reference,
const Standard_Integer  typeNum 
)
pure virtual

◆ WriteRoot()

virtual void Storage_BaseDriver::WriteRoot ( const TCollection_AsciiString rootName,
const Standard_Integer  aRef,
const TCollection_AsciiString aType 
)
pure virtual

◆ WriteTypeInformations()

virtual void Storage_BaseDriver::WriteTypeInformations ( const Standard_Integer  typeNum,
const TCollection_AsciiString typeName 
)
pure virtual

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