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

FSD_CmpFile Class Reference

#include <FSD_CmpFile.hxx>

Inheritance diagram for FSD_CmpFile:
Inheritance graph
[legend]

Public Member Functions

 FSD_CmpFile ()
 
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...
 
Storage_Error BeginWriteInfoSection ()
 
Storage_Error BeginReadInfoSection ()
 
void WritePersistentObjectHeader (const Standard_Integer aRef, const Standard_Integer aType)
 
void BeginWritePersistentObjectData ()
 
void BeginWriteObjectData ()
 
void EndWriteObjectData ()
 
void EndWritePersistentObjectData ()
 
void ReadPersistentObjectHeader (Standard_Integer &aRef, Standard_Integer &aType)
 
void BeginReadPersistentObjectData ()
 
void BeginReadObjectData ()
 
void EndReadObjectData ()
 
void EndReadPersistentObjectData ()
 
void Destroy ()
 
 ~FSD_CmpFile ()
 
- Public Member Functions inherited from 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. More...
 
virtual Standard_Boolean IsEnd ()
 returns True if we are at end of the stream More...
 
virtual Storage_Position Tell ()
 return position in the file. Return -1 upon error. More...
 
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)
 
virtual Storage_Error EndWriteInfoSection ()
 
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)
 
virtual void ReadCompleteInfo (Standard_IStream &theIStream, Handle< Storage_Data > &theData)
 
virtual Storage_Error EndReadInfoSection ()
 
virtual Storage_Error BeginWriteCommentSection ()
 
virtual void WriteComment (const TColStd_SequenceOfExtendedString &userComments)
 
virtual Storage_Error EndWriteCommentSection ()
 
virtual Storage_Error BeginReadCommentSection ()
 
virtual void ReadComment (TColStd_SequenceOfExtendedString &userComments)
 
virtual Storage_Error EndReadCommentSection ()
 
virtual Storage_Error BeginWriteTypeSection ()
 
virtual void SetTypeSectionSize (const Standard_Integer aSize)
 
virtual void WriteTypeInformations (const Standard_Integer typeNum, const TCollection_AsciiString &typeName)
 
virtual Storage_Error EndWriteTypeSection ()
 
virtual Storage_Error BeginReadTypeSection ()
 
virtual Standard_Integer TypeSectionSize ()
 
virtual void ReadTypeInformations (Standard_Integer &typeNum, TCollection_AsciiString &typeName)
 
virtual Storage_Error EndReadTypeSection ()
 
virtual Storage_Error BeginWriteRootSection ()
 
virtual void SetRootSectionSize (const Standard_Integer aSize)
 
virtual void WriteRoot (const TCollection_AsciiString &rootName, const Standard_Integer aRef, const TCollection_AsciiString &aType)
 
virtual Storage_Error EndWriteRootSection ()
 
virtual Storage_Error BeginReadRootSection ()
 
virtual Standard_Integer RootSectionSize ()
 
virtual void ReadRoot (TCollection_AsciiString &rootName, Standard_Integer &aRef, TCollection_AsciiString &aType)
 
virtual Storage_Error EndReadRootSection ()
 
virtual Storage_Error BeginWriteRefSection ()
 
virtual void SetRefSectionSize (const Standard_Integer aSize)
 
virtual void WriteReferenceType (const Standard_Integer reference, const Standard_Integer typeNum)
 
virtual Storage_Error EndWriteRefSection ()
 
virtual Storage_Error BeginReadRefSection ()
 
virtual Standard_Integer RefSectionSize ()
 
virtual void ReadReferenceType (Standard_Integer &reference, Standard_Integer &typeNum)
 
virtual Storage_Error EndReadRefSection ()
 
virtual Storage_Error BeginWriteDataSection ()
 
virtual Storage_Error EndWriteDataSection ()
 
virtual Storage_Error BeginReadDataSection ()
 
virtual Storage_Error EndReadDataSection ()
 
virtual void SkipObject ()
 
virtual Storage_BaseDriverPutReference (const Standard_Integer aValue)
 
virtual Storage_BaseDriverPutCharacter (const Standard_Character aValue)
 
Storage_BaseDriveroperator<< (const Standard_Character aValue)
 
virtual Storage_BaseDriverPutExtCharacter (const Standard_ExtCharacter aValue)
 
Storage_BaseDriveroperator<< (const Standard_ExtCharacter aValue)
 
virtual Storage_BaseDriverPutInteger (const Standard_Integer aValue)
 
Storage_BaseDriveroperator<< (const Standard_Integer aValue)
 
virtual Storage_BaseDriverPutBoolean (const Standard_Boolean aValue)
 
Storage_BaseDriveroperator<< (const Standard_Boolean aValue)
 
virtual Storage_BaseDriverPutReal (const Standard_Real aValue)
 
Storage_BaseDriveroperator<< (const Standard_Real aValue)
 
virtual Storage_BaseDriverPutShortReal (const Standard_ShortReal aValue)
 
Storage_BaseDriveroperator<< (const Standard_ShortReal aValue)
 
virtual Storage_BaseDriverGetReference (Standard_Integer &aValue)
 
virtual Storage_BaseDriverGetCharacter (Standard_Character &aValue)
 
Storage_BaseDriveroperator>> (Standard_Character &aValue)
 
virtual Storage_BaseDriverGetExtCharacter (Standard_ExtCharacter &aValue)
 
Storage_BaseDriveroperator>> (Standard_ExtCharacter &aValue)
 
virtual Storage_BaseDriverGetInteger (Standard_Integer &aValue)
 
Storage_BaseDriveroperator>> (Standard_Integer &aValue)
 
virtual Storage_BaseDriverGetBoolean (Standard_Boolean &aValue)
 
Storage_BaseDriveroperator>> (Standard_Boolean &aValue)
 
virtual Storage_BaseDriverGetReal (Standard_Real &aValue)
 
Storage_BaseDriveroperator>> (Standard_Real &aValue)
 
virtual Storage_BaseDriverGetShortReal (Standard_ShortReal &aValue)
 
Storage_BaseDriveroperator>> (Standard_ShortReal &aValue)
 
virtual 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 FSD_File
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 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 ReadString (TCollection_AsciiString &buffer)
 read from the first none space character position to the end of line. More...
 
- Protected Member Functions inherited from FSD_File
virtual void ReadWord (TCollection_AsciiString &buffer)
 read from the current position to the next white space or end of line. More...
 
virtual void ReadChar (TCollection_AsciiString &buffer, const Standard_Size rsize)
 read <rsize> character from the current position. More...
 
virtual void FlushEndOfLine ()
 
virtual 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)
 

Additional Inherited Members

- Protected Attributes inherited from FSD_File
FSD_FStream myStream
 

Constructor & Destructor Documentation

◆ FSD_CmpFile()

FSD_CmpFile::FSD_CmpFile ( )

◆ ~FSD_CmpFile()

FSD_CmpFile::~FSD_CmpFile ( )
inline

Member Function Documentation

◆ BeginReadInfoSection()

Storage_Error FSD_CmpFile::BeginReadInfoSection ( )
virtual

Reimplemented from FSD_File.

◆ BeginReadObjectData()

void FSD_CmpFile::BeginReadObjectData ( )
virtual

Reimplemented from FSD_File.

◆ BeginReadPersistentObjectData()

void FSD_CmpFile::BeginReadPersistentObjectData ( )
virtual

Reimplemented from FSD_File.

◆ BeginWriteInfoSection()

Storage_Error FSD_CmpFile::BeginWriteInfoSection ( )
virtual

Reimplemented from FSD_File.

◆ BeginWriteObjectData()

void FSD_CmpFile::BeginWriteObjectData ( )
virtual

Reimplemented from FSD_File.

◆ BeginWritePersistentObjectData()

void FSD_CmpFile::BeginWritePersistentObjectData ( )
virtual

Reimplemented from FSD_File.

◆ Destroy()

void FSD_CmpFile::Destroy ( )

◆ EndReadObjectData()

void FSD_CmpFile::EndReadObjectData ( )
virtual

Reimplemented from FSD_File.

◆ EndReadPersistentObjectData()

void FSD_CmpFile::EndReadPersistentObjectData ( )
virtual

Reimplemented from FSD_File.

◆ EndWriteObjectData()

void FSD_CmpFile::EndWriteObjectData ( )
virtual

Reimplemented from FSD_File.

◆ EndWritePersistentObjectData()

void FSD_CmpFile::EndWritePersistentObjectData ( )
virtual

Reimplemented from FSD_File.

◆ IsGoodFileType()

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

◆ MagicNumber()

static Standard_CString FSD_CmpFile::MagicNumber ( )
static

◆ Open()

Storage_Error FSD_CmpFile::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.

Reimplemented from FSD_File.

◆ ReadExtendedLine()

void FSD_CmpFile::ReadExtendedLine ( TCollection_ExtendedString buffer)
protectedvirtual

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

Reimplemented from FSD_File.

◆ ReadLine()

void FSD_CmpFile::ReadLine ( TCollection_AsciiString buffer)
protectedvirtual

read from the current position to the end of line.

Reimplemented from FSD_File.

◆ ReadPersistentObjectHeader()

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

Reimplemented from FSD_File.

◆ ReadString()

void FSD_CmpFile::ReadString ( TCollection_AsciiString buffer)
protectedvirtual

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

Reimplemented from FSD_File.

◆ WriteExtendedLine()

void FSD_CmpFile::WriteExtendedLine ( const TCollection_ExtendedString buffer)
protectedvirtual

write from the current position to the end of line.

Reimplemented from FSD_File.

◆ WritePersistentObjectHeader()

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

Reimplemented from FSD_File.


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