Open CASCADE Technology  6.5.4
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
Public Member Functions | Protected Member Functions
Storage_BaseDriver Class Reference

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

DEFINE_STANDARD_ALLOC void Delete ()
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

virtual Storage_Position Tell ()=0
 return position in the file. Return -1 upon error.

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 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

Protected Member Functions

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

Detailed Description


Constructor & Destructor Documentation

virtual Storage_BaseDriver::~Storage_BaseDriver ( ) [inline, virtual]

Member Function Documentation

virtual void Storage_BaseDriver::BeginReadObjectData ( ) [pure virtual]
virtual void Storage_BaseDriver::BeginWriteObjectData ( ) [pure virtual]
virtual Storage_Error Storage_BaseDriver::Close ( ) [pure virtual]
virtual void Storage_BaseDriver::EndReadObjectData ( ) [pure virtual]
virtual void Storage_BaseDriver::EndWriteObjectData ( ) [pure virtual]
virtual Storage_BaseDriver& Storage_BaseDriver::GetReal ( Standard_Real aValue) [pure virtual]
virtual Standard_Boolean Storage_BaseDriver::IsEnd ( ) [pure virtual]
Storage_BaseDriver& Storage_BaseDriver::operator<< ( const Standard_Character  aValue) [inline]

Reimplemented in FSD_File, FSD_CmpFile, FSD_BinaryFile, and DDF_IOStream.

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

Reimplemented in FSD_File, FSD_CmpFile, FSD_BinaryFile, and DDF_IOStream.

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

Reimplemented in FSD_File, FSD_CmpFile, FSD_BinaryFile, and DDF_IOStream.

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

Reimplemented in FSD_File, FSD_CmpFile, FSD_BinaryFile, and DDF_IOStream.

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

Reimplemented in FSD_File, FSD_CmpFile, FSD_BinaryFile, and DDF_IOStream.

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

Reimplemented in FSD_File, FSD_CmpFile, FSD_BinaryFile, and DDF_IOStream.

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

Reimplemented in FSD_File, FSD_CmpFile, FSD_BinaryFile, and DDF_IOStream.

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

Reimplemented in FSD_File, FSD_CmpFile, FSD_BinaryFile, and DDF_IOStream.

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

Reimplemented in FSD_File, FSD_CmpFile, FSD_BinaryFile, and DDF_IOStream.

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

Reimplemented in FSD_File, FSD_CmpFile, FSD_BinaryFile, and DDF_IOStream.

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

Reimplemented in FSD_File, FSD_CmpFile, FSD_BinaryFile, and DDF_IOStream.

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

Reimplemented in FSD_File, FSD_CmpFile, FSD_BinaryFile, and DDF_IOStream.

virtual void Storage_BaseDriver::ReadComment ( TColStd_SequenceOfExtendedString userComments) [pure virtual]
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]
virtual void Storage_BaseDriver::ReadReferenceType ( Standard_Integer reference,
Standard_Integer typeNum 
) [pure virtual]
virtual void Storage_BaseDriver::ReadRoot ( TCollection_AsciiString rootName,
Standard_Integer aRef,
TCollection_AsciiString aType 
) [pure virtual]
virtual void Storage_BaseDriver::ReadTypeInformations ( Standard_Integer typeNum,
TCollection_AsciiString typeName 
) [pure virtual]
virtual void Storage_BaseDriver::SkipObject ( ) [pure virtual]
virtual Storage_Position Storage_BaseDriver::Tell ( ) [pure virtual]
virtual void Storage_BaseDriver::WriteReferenceType ( const Standard_Integer  reference,
const Standard_Integer  typeNum 
) [pure virtual]

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