Open CASCADE Technology 6.6.0
Public Member Functions | Static Public Member Functions | Protected Member Functions
FSD_BinaryFile Class Reference

#include <FSD_BinaryFile.hxx>

Inheritance diagram for FSD_BinaryFile:
Inheritance graph
[legend]

Public Member Functions

 FSD_BinaryFile ()
Storage_Error Open (const TCollection_AsciiString &aName, const Storage_OpenMode aMode)
Standard_Boolean IsEnd ()
 returns True if we are at end of the stream

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

Storage_Error BeginWriteInfoSection ()
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)
Storage_Error EndWriteInfoSection ()
Storage_Error BeginReadInfoSection ()
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)
Storage_Error EndReadInfoSection ()
Storage_Error BeginWriteCommentSection ()
void WriteComment (const TColStd_SequenceOfExtendedString &userComments)
Storage_Error EndWriteCommentSection ()
Storage_Error BeginReadCommentSection ()
void ReadComment (TColStd_SequenceOfExtendedString &userComments)
Storage_Error EndReadCommentSection ()
Storage_Error BeginWriteTypeSection ()
void SetTypeSectionSize (const Standard_Integer aSize)
void WriteTypeInformations (const Standard_Integer typeNum, const TCollection_AsciiString &typeName)
Storage_Error EndWriteTypeSection ()
Storage_Error BeginReadTypeSection ()
Standard_Integer TypeSectionSize ()
void ReadTypeInformations (Standard_Integer &typeNum, TCollection_AsciiString &typeName)
Storage_Error EndReadTypeSection ()
Storage_Error BeginWriteRootSection ()
void SetRootSectionSize (const Standard_Integer aSize)
void WriteRoot (const TCollection_AsciiString &rootName, const Standard_Integer aRef, const TCollection_AsciiString &aType)
Storage_Error EndWriteRootSection ()
Storage_Error BeginReadRootSection ()
Standard_Integer RootSectionSize ()
void ReadRoot (TCollection_AsciiString &rootName, Standard_Integer &aRef, TCollection_AsciiString &aType)
Storage_Error EndReadRootSection ()
Storage_Error BeginWriteRefSection ()
void SetRefSectionSize (const Standard_Integer aSize)
void WriteReferenceType (const Standard_Integer reference, const Standard_Integer typeNum)
Storage_Error EndWriteRefSection ()
Storage_Error BeginReadRefSection ()
Standard_Integer RefSectionSize ()
void ReadReferenceType (Standard_Integer &reference, Standard_Integer &typeNum)
Storage_Error EndReadRefSection ()
Storage_Error BeginWriteDataSection ()
void WritePersistentObjectHeader (const Standard_Integer aRef, const Standard_Integer aType)
void BeginWritePersistentObjectData ()
void BeginWriteObjectData ()
void EndWriteObjectData ()
void EndWritePersistentObjectData ()
Storage_Error EndWriteDataSection ()
Storage_Error BeginReadDataSection ()
void ReadPersistentObjectHeader (Standard_Integer &aRef, Standard_Integer &aType)
void BeginReadPersistentObjectData ()
void BeginReadObjectData ()
void EndReadObjectData ()
void EndReadPersistentObjectData ()
Storage_Error EndReadDataSection ()
void SkipObject ()
Storage_BaseDriverPutReference (const Standard_Integer aValue)
Storage_BaseDriverPutCharacter (const Standard_Character aValue)
Storage_BaseDriveroperator<< (const Standard_Character aValue)
Storage_BaseDriverPutExtCharacter (const Standard_ExtCharacter aValue)
Storage_BaseDriveroperator<< (const Standard_ExtCharacter aValue)
Storage_BaseDriverPutInteger (const Standard_Integer aValue)
Storage_BaseDriveroperator<< (const Standard_Integer aValue)
Storage_BaseDriverPutBoolean (const Standard_Boolean aValue)
Storage_BaseDriveroperator<< (const Standard_Boolean aValue)
Storage_BaseDriverPutReal (const Standard_Real aValue)
Storage_BaseDriveroperator<< (const Standard_Real aValue)
Storage_BaseDriverPutShortReal (const Standard_ShortReal aValue)
Storage_BaseDriveroperator<< (const Standard_ShortReal aValue)
Storage_BaseDriverGetReference (Standard_Integer &aValue)
Storage_BaseDriverGetCharacter (Standard_Character &aValue)
Storage_BaseDriveroperator>> (Standard_Character &aValue)
Storage_BaseDriverGetExtCharacter (Standard_ExtCharacter &aValue)
Storage_BaseDriveroperator>> (Standard_ExtCharacter &aValue)
Storage_BaseDriverGetInteger (Standard_Integer &aValue)
Storage_BaseDriveroperator>> (Standard_Integer &aValue)
Storage_BaseDriverGetBoolean (Standard_Boolean &aValue)
Storage_BaseDriveroperator>> (Standard_Boolean &aValue)
Storage_BaseDriverGetReal (Standard_Real &aValue)
Storage_BaseDriveroperator>> (Standard_Real &aValue)
Storage_BaseDriverGetShortReal (Standard_ShortReal &aValue)
Storage_BaseDriveroperator>> (Standard_ShortReal &aValue)
Storage_Error Close ()
void Destroy ()
 ~FSD_BinaryFile ()

Static Public Member Functions

static Storage_Error IsGoodFileType (const TCollection_AsciiString &aName)

Protected Member Functions

void ReadChar (TCollection_AsciiString &buffer, const Standard_Size rsize)
 read <rsize> character from the current position.

void ReadString (TCollection_AsciiString &buffer)
 read string from the current position.

void WriteString (const TCollection_AsciiString &buffer)
 write string at the current position.

void ReadExtendedString (TCollection_ExtendedString &buffer)
 read string from the current position.

void WriteExtendedString (const TCollection_ExtendedString &buffer)
 write string at the current position.


Constructor & Destructor Documentation

FSD_BinaryFile::FSD_BinaryFile ( )
FSD_BinaryFile::~FSD_BinaryFile ( ) [inline]

Member Function Documentation

Storage_Error FSD_BinaryFile::BeginReadCommentSection ( ) [virtual]

Implements Storage_BaseDriver.

Storage_Error FSD_BinaryFile::BeginReadDataSection ( ) [virtual]

Implements Storage_BaseDriver.

Storage_Error FSD_BinaryFile::BeginReadInfoSection ( ) [virtual]

Implements Storage_BaseDriver.

void FSD_BinaryFile::BeginReadObjectData ( ) [virtual]

Implements Storage_BaseDriver.

void FSD_BinaryFile::BeginReadPersistentObjectData ( ) [virtual]

Implements Storage_BaseDriver.

Storage_Error FSD_BinaryFile::BeginReadRefSection ( ) [virtual]

Implements Storage_BaseDriver.

Storage_Error FSD_BinaryFile::BeginReadRootSection ( ) [virtual]

Implements Storage_BaseDriver.

Storage_Error FSD_BinaryFile::BeginReadTypeSection ( ) [virtual]

Implements Storage_BaseDriver.

Storage_Error FSD_BinaryFile::BeginWriteCommentSection ( ) [virtual]

Implements Storage_BaseDriver.

Storage_Error FSD_BinaryFile::BeginWriteDataSection ( ) [virtual]

Implements Storage_BaseDriver.

Storage_Error FSD_BinaryFile::BeginWriteInfoSection ( ) [virtual]

Implements Storage_BaseDriver.

void FSD_BinaryFile::BeginWriteObjectData ( ) [virtual]

Implements Storage_BaseDriver.

void FSD_BinaryFile::BeginWritePersistentObjectData ( ) [virtual]

Implements Storage_BaseDriver.

Storage_Error FSD_BinaryFile::BeginWriteRefSection ( ) [virtual]

Implements Storage_BaseDriver.

Storage_Error FSD_BinaryFile::BeginWriteRootSection ( ) [virtual]

Implements Storage_BaseDriver.

Storage_Error FSD_BinaryFile::BeginWriteTypeSection ( ) [virtual]

Implements Storage_BaseDriver.

Storage_Error FSD_BinaryFile::Close ( ) [virtual]

Implements Storage_BaseDriver.

void FSD_BinaryFile::Destroy ( )
Storage_Error FSD_BinaryFile::EndReadCommentSection ( ) [virtual]

Implements Storage_BaseDriver.

Storage_Error FSD_BinaryFile::EndReadDataSection ( ) [virtual]

Implements Storage_BaseDriver.

Storage_Error FSD_BinaryFile::EndReadInfoSection ( ) [virtual]

Implements Storage_BaseDriver.

void FSD_BinaryFile::EndReadObjectData ( ) [virtual]

Implements Storage_BaseDriver.

void FSD_BinaryFile::EndReadPersistentObjectData ( ) [virtual]

Implements Storage_BaseDriver.

Storage_Error FSD_BinaryFile::EndReadRefSection ( ) [virtual]

Implements Storage_BaseDriver.

Storage_Error FSD_BinaryFile::EndReadRootSection ( ) [virtual]

Implements Storage_BaseDriver.

Storage_Error FSD_BinaryFile::EndReadTypeSection ( ) [virtual]

Implements Storage_BaseDriver.

Storage_Error FSD_BinaryFile::EndWriteCommentSection ( ) [virtual]

Implements Storage_BaseDriver.

Storage_Error FSD_BinaryFile::EndWriteDataSection ( ) [virtual]

Implements Storage_BaseDriver.

Storage_Error FSD_BinaryFile::EndWriteInfoSection ( ) [virtual]

Implements Storage_BaseDriver.

void FSD_BinaryFile::EndWriteObjectData ( ) [virtual]

Implements Storage_BaseDriver.

void FSD_BinaryFile::EndWritePersistentObjectData ( ) [virtual]

Implements Storage_BaseDriver.

Storage_Error FSD_BinaryFile::EndWriteRefSection ( ) [virtual]

Implements Storage_BaseDriver.

Storage_Error FSD_BinaryFile::EndWriteRootSection ( ) [virtual]

Implements Storage_BaseDriver.

Storage_Error FSD_BinaryFile::EndWriteTypeSection ( ) [virtual]

Implements Storage_BaseDriver.

Storage_BaseDriver& FSD_BinaryFile::GetBoolean ( Standard_Boolean aValue) [virtual]

Implements Storage_BaseDriver.

Storage_BaseDriver& FSD_BinaryFile::GetCharacter ( Standard_Character aValue) [virtual]

Implements Storage_BaseDriver.

Storage_BaseDriver& FSD_BinaryFile::GetExtCharacter ( Standard_ExtCharacter aValue) [virtual]

Implements Storage_BaseDriver.

Storage_BaseDriver& FSD_BinaryFile::GetInteger ( Standard_Integer aValue) [virtual]

Implements Storage_BaseDriver.

Storage_BaseDriver& FSD_BinaryFile::GetReal ( Standard_Real aValue) [virtual]

Implements Storage_BaseDriver.

Storage_BaseDriver& FSD_BinaryFile::GetReference ( Standard_Integer aValue) [virtual]

Implements Storage_BaseDriver.

Storage_BaseDriver& FSD_BinaryFile::GetShortReal ( Standard_ShortReal aValue) [virtual]

Implements Storage_BaseDriver.

Standard_Boolean FSD_BinaryFile::IsEnd ( ) [virtual]

Implements Storage_BaseDriver.

static Storage_Error FSD_BinaryFile::IsGoodFileType ( const TCollection_AsciiString aName) [static]
Storage_Error FSD_BinaryFile::Open ( const TCollection_AsciiString aName,
const Storage_OpenMode  aMode 
) [virtual]

Implements Storage_BaseDriver.

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

Reimplemented from Storage_BaseDriver.

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

Reimplemented from Storage_BaseDriver.

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

Reimplemented from Storage_BaseDriver.

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

Reimplemented from Storage_BaseDriver.

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

Reimplemented from Storage_BaseDriver.

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

Reimplemented from Storage_BaseDriver.

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

Reimplemented from Storage_BaseDriver.

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

Reimplemented from Storage_BaseDriver.

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

Reimplemented from Storage_BaseDriver.

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

Reimplemented from Storage_BaseDriver.

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

Reimplemented from Storage_BaseDriver.

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

Reimplemented from Storage_BaseDriver.

Storage_BaseDriver& FSD_BinaryFile::PutBoolean ( const Standard_Boolean  aValue) [virtual]

Implements Storage_BaseDriver.

Storage_BaseDriver& FSD_BinaryFile::PutCharacter ( const Standard_Character  aValue) [virtual]

Implements Storage_BaseDriver.

Storage_BaseDriver& FSD_BinaryFile::PutExtCharacter ( const Standard_ExtCharacter  aValue) [virtual]

Implements Storage_BaseDriver.

Storage_BaseDriver& FSD_BinaryFile::PutInteger ( const Standard_Integer  aValue) [virtual]

Implements Storage_BaseDriver.

Storage_BaseDriver& FSD_BinaryFile::PutReal ( const Standard_Real  aValue) [virtual]

Implements Storage_BaseDriver.

Storage_BaseDriver& FSD_BinaryFile::PutReference ( const Standard_Integer  aValue) [virtual]

Implements Storage_BaseDriver.

Storage_BaseDriver& FSD_BinaryFile::PutShortReal ( const Standard_ShortReal  aValue) [virtual]

Implements Storage_BaseDriver.

void FSD_BinaryFile::ReadChar ( TCollection_AsciiString buffer,
const Standard_Size  rsize 
) [protected]
void FSD_BinaryFile::ReadComment ( TColStd_SequenceOfExtendedString userComments) [virtual]

Implements Storage_BaseDriver.

void FSD_BinaryFile::ReadExtendedString ( TCollection_ExtendedString buffer) [protected]
void FSD_BinaryFile::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 
) [virtual]

Implements Storage_BaseDriver.

void FSD_BinaryFile::ReadPersistentObjectHeader ( Standard_Integer aRef,
Standard_Integer aType 
) [virtual]

Implements Storage_BaseDriver.

void FSD_BinaryFile::ReadReferenceType ( Standard_Integer reference,
Standard_Integer typeNum 
) [virtual]

Implements Storage_BaseDriver.

void FSD_BinaryFile::ReadRoot ( TCollection_AsciiString rootName,
Standard_Integer aRef,
TCollection_AsciiString aType 
) [virtual]

Implements Storage_BaseDriver.

void FSD_BinaryFile::ReadString ( TCollection_AsciiString buffer) [protected]
void FSD_BinaryFile::ReadTypeInformations ( Standard_Integer typeNum,
TCollection_AsciiString typeName 
) [virtual]

Implements Storage_BaseDriver.

Standard_Integer FSD_BinaryFile::RefSectionSize ( ) [virtual]

Implements Storage_BaseDriver.

Standard_Integer FSD_BinaryFile::RootSectionSize ( ) [virtual]

Implements Storage_BaseDriver.

void FSD_BinaryFile::SetRefSectionSize ( const Standard_Integer  aSize) [virtual]

Implements Storage_BaseDriver.

void FSD_BinaryFile::SetRootSectionSize ( const Standard_Integer  aSize) [virtual]

Implements Storage_BaseDriver.

void FSD_BinaryFile::SetTypeSectionSize ( const Standard_Integer  aSize) [virtual]

Implements Storage_BaseDriver.

void FSD_BinaryFile::SkipObject ( ) [virtual]

Implements Storage_BaseDriver.

Storage_Position FSD_BinaryFile::Tell ( ) [virtual]

Implements Storage_BaseDriver.

Standard_Integer FSD_BinaryFile::TypeSectionSize ( ) [virtual]

Implements Storage_BaseDriver.

void FSD_BinaryFile::WriteComment ( const TColStd_SequenceOfExtendedString userComments) [virtual]

Implements Storage_BaseDriver.

void FSD_BinaryFile::WriteExtendedString ( const TCollection_ExtendedString buffer) [protected]
void FSD_BinaryFile::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 
) [virtual]

Implements Storage_BaseDriver.

void FSD_BinaryFile::WritePersistentObjectHeader ( const Standard_Integer  aRef,
const Standard_Integer  aType 
) [virtual]

Implements Storage_BaseDriver.

void FSD_BinaryFile::WriteReferenceType ( const Standard_Integer  reference,
const Standard_Integer  typeNum 
) [virtual]

Implements Storage_BaseDriver.

void FSD_BinaryFile::WriteRoot ( const TCollection_AsciiString rootName,
const Standard_Integer  aRef,
const TCollection_AsciiString aType 
) [virtual]

Implements Storage_BaseDriver.

void FSD_BinaryFile::WriteString ( const TCollection_AsciiString buffer) [protected]
void FSD_BinaryFile::WriteTypeInformations ( const Standard_Integer  typeNum,
const TCollection_AsciiString typeName 
) [virtual]

Implements Storage_BaseDriver.


The documentation for this class was generated from the following file:
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines