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

FSD_File Class Reference

A general driver which defines as a file, the physical container for data to be stored or retrieved. More...

#include <FSD_File.hxx>

Inheritance diagram for FSD_File:
Inheritance graph
[legend]

Public Member Functions

 FSD_File ()
 Constructs a driver defining as a file, the physical container for data to be stored or retrieved. Use the function Open to give the name of the driven file. More...
 
Storage_Error Open (const TCollection_AsciiString &aName, const Storage_OpenMode aMode)
 Assigns as aName the name of the file to be driven by this driver. aMode precises if the file is opened in read or write mode. The function returns Storage_VSOk if the file is opened correctly, or any other value of the Storage_Error enumeration which specifies the problem encountered. More...
 
Standard_Boolean IsEnd ()
 returns True if we are at end of the stream More...
 
Storage_Position Tell ()
 return position in the file. Return -1 upon error. More...
 
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)
 
void ReadCompleteInfo (Standard_IStream &theIStream, Handle< Storage_Data > &theData)
 
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 ()
 Closes the file driven by this driver. This file was opened by the last call to the function Open. The function returns Storage_VSOk if the closure is correctly done, or any other value of the Storage_Error enumeration which specifies the problem encountered. More...
 
void Destroy ()
 
 ~FSD_File ()
 
- Public Member Functions inherited from Storage_BaseDriver
virtual ~Storage_BaseDriver ()
 
TCollection_AsciiString Name () const
 
Storage_OpenMode OpenMode () const
 
Storage_BaseDriveroperator<< (const Standard_Character aValue)
 
Storage_BaseDriveroperator<< (const Standard_ExtCharacter aValue)
 
Storage_BaseDriveroperator<< (const Standard_Integer aValue)
 
Storage_BaseDriveroperator<< (const Standard_Boolean aValue)
 
Storage_BaseDriveroperator<< (const Standard_Real aValue)
 
Storage_BaseDriveroperator<< (const Standard_ShortReal aValue)
 
Storage_BaseDriveroperator>> (Standard_Character &aValue)
 
Storage_BaseDriveroperator>> (Standard_ExtCharacter &aValue)
 
Storage_BaseDriveroperator>> (Standard_Integer &aValue)
 
Storage_BaseDriveroperator>> (Standard_Boolean &aValue)
 
Storage_BaseDriveroperator>> (Standard_Real &aValue)
 
Storage_BaseDriveroperator>> (Standard_ShortReal &aValue)
 

Static Public Member Functions

static Storage_Error IsGoodFileType (const TCollection_AsciiString &aName)
 
static Standard_CString MagicNumber ()
 
- Static Public Member Functions inherited from Storage_BaseDriver
static TCollection_AsciiString ReadMagicNumber (Standard_IStream &theIStream)
 

Protected Member Functions

void ReadLine (TCollection_AsciiString &buffer)
 read from the current position to the end of line. More...
 
void ReadWord (TCollection_AsciiString &buffer)
 read from the current position to the next white space or end of line. More...
 
void ReadExtendedLine (TCollection_ExtendedString &buffer)
 read extended chars (unicode) from the current position to the end of line. More...
 
void WriteExtendedLine (const TCollection_ExtendedString &buffer)
 write from the current position to the end of line. More...
 
void ReadChar (TCollection_AsciiString &buffer, const Standard_Size rsize)
 read <rsize> character from the current position. More...
 
void ReadString (TCollection_AsciiString &buffer)
 read from the first none space character position to the end of line. More...
 
void FlushEndOfLine ()
 
Storage_Error FindTag (const Standard_CString aTag)
 
- Protected Member Functions inherited from Storage_BaseDriver
 Storage_BaseDriver ()
 
void SetName (const TCollection_AsciiString &aName)
 
void SetOpenMode (const Storage_OpenMode aMode)
 

Detailed Description

A general driver which defines as a file, the physical container for data to be stored or retrieved.

Constructor & Destructor Documentation

◆ FSD_File()

FSD_File::FSD_File ( )

Constructs a driver defining as a file, the physical container for data to be stored or retrieved. Use the function Open to give the name of the driven file.

◆ ~FSD_File()

FSD_File::~FSD_File ( )
inline

Member Function Documentation

◆ BeginReadCommentSection()

Storage_Error FSD_File::BeginReadCommentSection ( )
virtual

Implements Storage_BaseDriver.

◆ BeginReadDataSection()

Storage_Error FSD_File::BeginReadDataSection ( )
virtual

Implements Storage_BaseDriver.

◆ BeginReadInfoSection()

Storage_Error FSD_File::BeginReadInfoSection ( )
virtual

Implements Storage_BaseDriver.

◆ BeginReadObjectData()

void FSD_File::BeginReadObjectData ( )
virtual

Implements Storage_BaseDriver.

◆ BeginReadPersistentObjectData()

void FSD_File::BeginReadPersistentObjectData ( )
virtual

Implements Storage_BaseDriver.

◆ BeginReadRefSection()

Storage_Error FSD_File::BeginReadRefSection ( )
virtual

Implements Storage_BaseDriver.

◆ BeginReadRootSection()

Storage_Error FSD_File::BeginReadRootSection ( )
virtual

Implements Storage_BaseDriver.

◆ BeginReadTypeSection()

Storage_Error FSD_File::BeginReadTypeSection ( )
virtual

Implements Storage_BaseDriver.

◆ BeginWriteCommentSection()

Storage_Error FSD_File::BeginWriteCommentSection ( )
virtual

Implements Storage_BaseDriver.

◆ BeginWriteDataSection()

Storage_Error FSD_File::BeginWriteDataSection ( )
virtual

Implements Storage_BaseDriver.

◆ BeginWriteInfoSection()

Storage_Error FSD_File::BeginWriteInfoSection ( )
virtual

Implements Storage_BaseDriver.

◆ BeginWriteObjectData()

void FSD_File::BeginWriteObjectData ( )
virtual

Implements Storage_BaseDriver.

◆ BeginWritePersistentObjectData()

void FSD_File::BeginWritePersistentObjectData ( )
virtual

Implements Storage_BaseDriver.

◆ BeginWriteRefSection()

Storage_Error FSD_File::BeginWriteRefSection ( )
virtual

Implements Storage_BaseDriver.

◆ BeginWriteRootSection()

Storage_Error FSD_File::BeginWriteRootSection ( )
virtual

Implements Storage_BaseDriver.

◆ BeginWriteTypeSection()

Storage_Error FSD_File::BeginWriteTypeSection ( )
virtual

Implements Storage_BaseDriver.

◆ Close()

Storage_Error FSD_File::Close ( )
virtual

Closes the file driven by this driver. This file was opened by the last call to the function Open. The function returns Storage_VSOk if the closure is correctly done, or any other value of the Storage_Error enumeration which specifies the problem encountered.

Implements Storage_BaseDriver.

◆ Destroy()

void FSD_File::Destroy ( )

◆ EndReadCommentSection()

Storage_Error FSD_File::EndReadCommentSection ( )
virtual

Implements Storage_BaseDriver.

◆ EndReadDataSection()

Storage_Error FSD_File::EndReadDataSection ( )
virtual

Implements Storage_BaseDriver.

◆ EndReadInfoSection()

Storage_Error FSD_File::EndReadInfoSection ( )
virtual

Implements Storage_BaseDriver.

◆ EndReadObjectData()

void FSD_File::EndReadObjectData ( )
virtual

Implements Storage_BaseDriver.

◆ EndReadPersistentObjectData()

void FSD_File::EndReadPersistentObjectData ( )
virtual

Implements Storage_BaseDriver.

◆ EndReadRefSection()

Storage_Error FSD_File::EndReadRefSection ( )
virtual

Implements Storage_BaseDriver.

◆ EndReadRootSection()

Storage_Error FSD_File::EndReadRootSection ( )
virtual

Implements Storage_BaseDriver.

◆ EndReadTypeSection()

Storage_Error FSD_File::EndReadTypeSection ( )
virtual

Implements Storage_BaseDriver.

◆ EndWriteCommentSection()

Storage_Error FSD_File::EndWriteCommentSection ( )
virtual

Implements Storage_BaseDriver.

◆ EndWriteDataSection()

Storage_Error FSD_File::EndWriteDataSection ( )
virtual

Implements Storage_BaseDriver.

◆ EndWriteInfoSection()

Storage_Error FSD_File::EndWriteInfoSection ( )
virtual

Implements Storage_BaseDriver.

◆ EndWriteObjectData()

void FSD_File::EndWriteObjectData ( )
virtual

Implements Storage_BaseDriver.

◆ EndWritePersistentObjectData()

void FSD_File::EndWritePersistentObjectData ( )
virtual

Implements Storage_BaseDriver.

◆ EndWriteRefSection()

Storage_Error FSD_File::EndWriteRefSection ( )
virtual

Implements Storage_BaseDriver.

◆ EndWriteRootSection()

Storage_Error FSD_File::EndWriteRootSection ( )
virtual

Implements Storage_BaseDriver.

◆ EndWriteTypeSection()

Storage_Error FSD_File::EndWriteTypeSection ( )
virtual

Implements Storage_BaseDriver.

◆ FindTag()

Storage_Error FSD_File::FindTag ( const Standard_CString  aTag)
protected

◆ FlushEndOfLine()

void FSD_File::FlushEndOfLine ( )
protected

◆ GetBoolean()

Storage_BaseDriver& FSD_File::GetBoolean ( Standard_Boolean aValue)
virtual

Implements Storage_BaseDriver.

◆ GetCharacter()

Storage_BaseDriver& FSD_File::GetCharacter ( Standard_Character aValue)
virtual

Implements Storage_BaseDriver.

◆ GetExtCharacter()

Storage_BaseDriver& FSD_File::GetExtCharacter ( Standard_ExtCharacter aValue)
virtual

Implements Storage_BaseDriver.

◆ GetInteger()

Storage_BaseDriver& FSD_File::GetInteger ( Standard_Integer aValue)
virtual

Implements Storage_BaseDriver.

◆ GetReal()

Storage_BaseDriver& FSD_File::GetReal ( Standard_Real aValue)
virtual

Implements Storage_BaseDriver.

◆ GetReference()

Storage_BaseDriver& FSD_File::GetReference ( Standard_Integer aValue)
virtual

Implements Storage_BaseDriver.

◆ GetShortReal()

Storage_BaseDriver& FSD_File::GetShortReal ( Standard_ShortReal aValue)
virtual

Implements Storage_BaseDriver.

◆ IsEnd()

Standard_Boolean FSD_File::IsEnd ( )
virtual

returns True if we are at end of the stream

Implements Storage_BaseDriver.

◆ IsGoodFileType()

static Storage_Error FSD_File::IsGoodFileType ( const TCollection_AsciiString aName)
static

◆ MagicNumber()

static Standard_CString FSD_File::MagicNumber ( )
static

◆ Open()

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

Assigns as aName the name of the file to be driven by this driver. aMode precises if the file is opened in read or write mode. The function returns Storage_VSOk if the file is opened correctly, or any other value of the Storage_Error enumeration which specifies the problem encountered.

Implements Storage_BaseDriver.

◆ operator<<() [1/6]

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

◆ operator<<() [2/6]

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

◆ operator<<() [3/6]

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

◆ operator<<() [4/6]

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

◆ operator<<() [5/6]

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

◆ operator<<() [6/6]

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

◆ operator>>() [1/6]

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

◆ operator>>() [2/6]

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

◆ operator>>() [3/6]

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

◆ operator>>() [4/6]

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

◆ operator>>() [5/6]

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

◆ operator>>() [6/6]

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

◆ PutBoolean()

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

Implements Storage_BaseDriver.

◆ PutCharacter()

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

Implements Storage_BaseDriver.

◆ PutExtCharacter()

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

Implements Storage_BaseDriver.

◆ PutInteger()

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

Implements Storage_BaseDriver.

◆ PutReal()

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

Implements Storage_BaseDriver.

◆ PutReference()

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

Implements Storage_BaseDriver.

◆ PutShortReal()

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

Implements Storage_BaseDriver.

◆ ReadChar()

void FSD_File::ReadChar ( TCollection_AsciiString buffer,
const Standard_Size  rsize 
)
protected

read <rsize> character from the current position.

◆ ReadComment()

void FSD_File::ReadComment ( TColStd_SequenceOfExtendedString userComments)
virtual

Implements Storage_BaseDriver.

◆ ReadCompleteInfo()

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

Implements Storage_BaseDriver.

◆ ReadExtendedLine()

void FSD_File::ReadExtendedLine ( TCollection_ExtendedString buffer)
protected

read extended chars (unicode) from the current position to the end of line.

◆ ReadInfo()

void FSD_File::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.

◆ ReadLine()

void FSD_File::ReadLine ( TCollection_AsciiString buffer)
protected

read from the current position to the end of line.

◆ ReadPersistentObjectHeader()

void FSD_File::ReadPersistentObjectHeader ( Standard_Integer aRef,
Standard_Integer aType 
)
virtual

Implements Storage_BaseDriver.

◆ ReadReferenceType()

void FSD_File::ReadReferenceType ( Standard_Integer reference,
Standard_Integer typeNum 
)
virtual

Implements Storage_BaseDriver.

◆ ReadRoot()

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

Implements Storage_BaseDriver.

◆ ReadString()

void FSD_File::ReadString ( TCollection_AsciiString buffer)
protected

read from the first none space character position to the end of line.

◆ ReadTypeInformations()

void FSD_File::ReadTypeInformations ( Standard_Integer typeNum,
TCollection_AsciiString typeName 
)
virtual

Implements Storage_BaseDriver.

◆ ReadWord()

void FSD_File::ReadWord ( TCollection_AsciiString buffer)
protected

read from the current position to the next white space or end of line.

◆ RefSectionSize()

Standard_Integer FSD_File::RefSectionSize ( )
virtual

Implements Storage_BaseDriver.

◆ RootSectionSize()

Standard_Integer FSD_File::RootSectionSize ( )
virtual

Implements Storage_BaseDriver.

◆ SetRefSectionSize()

void FSD_File::SetRefSectionSize ( const Standard_Integer  aSize)
virtual

Implements Storage_BaseDriver.

◆ SetRootSectionSize()

void FSD_File::SetRootSectionSize ( const Standard_Integer  aSize)
virtual

Implements Storage_BaseDriver.

◆ SetTypeSectionSize()

void FSD_File::SetTypeSectionSize ( const Standard_Integer  aSize)
virtual

Implements Storage_BaseDriver.

◆ SkipObject()

void FSD_File::SkipObject ( )
virtual

Implements Storage_BaseDriver.

◆ Tell()

Storage_Position FSD_File::Tell ( )
virtual

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

Implements Storage_BaseDriver.

◆ TypeSectionSize()

Standard_Integer FSD_File::TypeSectionSize ( )
virtual

Implements Storage_BaseDriver.

◆ WriteComment()

void FSD_File::WriteComment ( const TColStd_SequenceOfExtendedString userComments)
virtual

Implements Storage_BaseDriver.

◆ WriteExtendedLine()

void FSD_File::WriteExtendedLine ( const TCollection_ExtendedString buffer)
protected

write from the current position to the end of line.

◆ WriteInfo()

void FSD_File::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.

◆ WritePersistentObjectHeader()

void FSD_File::WritePersistentObjectHeader ( const Standard_Integer  aRef,
const Standard_Integer  aType 
)
virtual

Implements Storage_BaseDriver.

◆ WriteReferenceType()

void FSD_File::WriteReferenceType ( const Standard_Integer  reference,
const Standard_Integer  typeNum 
)
virtual

Implements Storage_BaseDriver.

◆ WriteRoot()

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

Implements Storage_BaseDriver.

◆ WriteTypeInformations()

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

Implements Storage_BaseDriver.


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