FSD_CmpFile Class Reference

#include <FSD_CmpFile.hxx>

Inheritance diagram for FSD_CmpFile:

Public Member Functions
	FSD_CmpFile ()
Storage_Error	Open (const TCollection_AsciiString &aName, const Storage_OpenMode aMode)
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_BaseDriver &	PutReference (const Standard_Integer aValue)
Storage_BaseDriver &	PutCharacter (const Standard_Character aValue)
Storage_BaseDriver &	operator<< (const Standard_Character aValue)
Storage_BaseDriver &	PutExtCharacter (const Standard_ExtCharacter aValue)
Storage_BaseDriver &	operator<< (const Standard_ExtCharacter aValue)
Storage_BaseDriver &	PutInteger (const Standard_Integer aValue)
Storage_BaseDriver &	operator<< (const Standard_Integer aValue)
Storage_BaseDriver &	PutBoolean (const Standard_Boolean aValue)
Storage_BaseDriver &	operator<< (const Standard_Boolean aValue)
Storage_BaseDriver &	PutReal (const Standard_Real aValue)
Storage_BaseDriver &	operator<< (const Standard_Real aValue)
Storage_BaseDriver &	PutShortReal (const Standard_ShortReal aValue)
Storage_BaseDriver &	operator<< (const Standard_ShortReal aValue)
Storage_BaseDriver &	GetReference (Standard_Integer &aValue)
Storage_BaseDriver &	GetCharacter (Standard_Character &aValue)
Storage_BaseDriver &	operator>> (Standard_Character &aValue)
Storage_BaseDriver &	GetExtCharacter (Standard_ExtCharacter &aValue)
Storage_BaseDriver &	operator>> (Standard_ExtCharacter &aValue)
Storage_BaseDriver &	GetInteger (Standard_Integer &aValue)
Storage_BaseDriver &	operator>> (Standard_Integer &aValue)
Storage_BaseDriver &	GetBoolean (Standard_Boolean &aValue)
Storage_BaseDriver &	operator>> (Standard_Boolean &aValue)
Storage_BaseDriver &	GetReal (Standard_Real &aValue)
Storage_BaseDriver &	operator>> (Standard_Real &aValue)
Storage_BaseDriver &	GetShortReal (Standard_ShortReal &aValue)
Storage_BaseDriver &	operator>> (Standard_ShortReal &aValue)
Storage_Error	Close ()
void	Destroy ()
	~FSD_CmpFile ()
Public Member Functions inherited from Storage_BaseDriver
virtual	~Storage_BaseDriver ()
TCollection_AsciiString	Name () const
Storage_OpenMode	OpenMode () const
Storage_BaseDriver &	operator<< (const Standard_Character aValue)
Storage_BaseDriver &	operator<< (const Standard_ExtCharacter aValue)
Storage_BaseDriver &	operator<< (const Standard_Integer aValue)
Storage_BaseDriver &	operator<< (const Standard_Boolean aValue)
Storage_BaseDriver &	operator<< (const Standard_Real aValue)
Storage_BaseDriver &	operator<< (const Standard_ShortReal aValue)
Storage_BaseDriver &	operator>> (Standard_Character &aValue)
Storage_BaseDriver &	operator>> (Standard_ExtCharacter &aValue)
Storage_BaseDriver &	operator>> (Standard_Integer &aValue)
Storage_BaseDriver &	operator>> (Standard_Boolean &aValue)
Storage_BaseDriver &	operator>> (Standard_Real &aValue)
Storage_BaseDriver &	operator>> (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)

Constructor & Destructor Documentation

FSD_CmpFile::FSD_CmpFile

(

)

FSD_CmpFile::~FSD_CmpFile ( )

inline

Member Function Documentation

Storage_Error FSD_CmpFile::BeginReadCommentSection ( )

virtual

Implements Storage_BaseDriver.

Storage_Error FSD_CmpFile::BeginReadDataSection ( )

virtual

Implements Storage_BaseDriver.

Storage_Error FSD_CmpFile::BeginReadInfoSection ( )

virtual

Implements Storage_BaseDriver.

void FSD_CmpFile::BeginReadObjectData ( )

virtual

Implements Storage_BaseDriver.

void FSD_CmpFile::BeginReadPersistentObjectData ( )

virtual

Implements Storage_BaseDriver.

Storage_Error FSD_CmpFile::BeginReadRefSection ( )

virtual

Implements Storage_BaseDriver.

Storage_Error FSD_CmpFile::BeginReadRootSection ( )

virtual

Implements Storage_BaseDriver.

Storage_Error FSD_CmpFile::BeginReadTypeSection ( )

virtual

Implements Storage_BaseDriver.

Storage_Error FSD_CmpFile::BeginWriteCommentSection ( )

virtual

Implements Storage_BaseDriver.

Storage_Error FSD_CmpFile::BeginWriteDataSection ( )

virtual

Implements Storage_BaseDriver.

Storage_Error FSD_CmpFile::BeginWriteInfoSection ( )

virtual

Implements Storage_BaseDriver.

void FSD_CmpFile::BeginWriteObjectData ( )

virtual

Implements Storage_BaseDriver.

void FSD_CmpFile::BeginWritePersistentObjectData ( )

virtual

Implements Storage_BaseDriver.

Storage_Error FSD_CmpFile::BeginWriteRefSection ( )

virtual

Implements Storage_BaseDriver.

Storage_Error FSD_CmpFile::BeginWriteRootSection ( )

virtual

Implements Storage_BaseDriver.

Storage_Error FSD_CmpFile::BeginWriteTypeSection ( )

virtual

Implements Storage_BaseDriver.

Storage_Error FSD_CmpFile::Close ( )

virtual

Implements Storage_BaseDriver.

void FSD_CmpFile::Destroy

(

)

Storage_Error FSD_CmpFile::EndReadCommentSection ( )

virtual

Implements Storage_BaseDriver.

Storage_Error FSD_CmpFile::EndReadDataSection ( )

virtual

Implements Storage_BaseDriver.

Storage_Error FSD_CmpFile::EndReadInfoSection ( )

virtual

Implements Storage_BaseDriver.

void FSD_CmpFile::EndReadObjectData ( )

virtual

Implements Storage_BaseDriver.

void FSD_CmpFile::EndReadPersistentObjectData ( )

virtual

Implements Storage_BaseDriver.

Storage_Error FSD_CmpFile::EndReadRefSection ( )

virtual

Implements Storage_BaseDriver.

Storage_Error FSD_CmpFile::EndReadRootSection ( )

virtual

Implements Storage_BaseDriver.

Storage_Error FSD_CmpFile::EndReadTypeSection ( )

virtual

Implements Storage_BaseDriver.

Storage_Error FSD_CmpFile::EndWriteCommentSection ( )

virtual

Implements Storage_BaseDriver.

Storage_Error FSD_CmpFile::EndWriteDataSection ( )

virtual

Implements Storage_BaseDriver.

Storage_Error FSD_CmpFile::EndWriteInfoSection ( )

virtual

Implements Storage_BaseDriver.

void FSD_CmpFile::EndWriteObjectData ( )

virtual

Implements Storage_BaseDriver.

void FSD_CmpFile::EndWritePersistentObjectData ( )

virtual

Implements Storage_BaseDriver.

Storage_Error FSD_CmpFile::EndWriteRefSection ( )

virtual

Implements Storage_BaseDriver.

Storage_Error FSD_CmpFile::EndWriteRootSection ( )

virtual

Implements Storage_BaseDriver.

Storage_Error FSD_CmpFile::EndWriteTypeSection ( )

virtual

Implements Storage_BaseDriver.

Storage_Error FSD_CmpFile::FindTag ( const Standard_CString  aTag )

protected

void FSD_CmpFile::FlushEndOfLine ( )

protected

Storage_BaseDriver& FSD_CmpFile::GetBoolean ( Standard_Boolean &  aValue )

virtual

Implements Storage_BaseDriver.

Storage_BaseDriver& FSD_CmpFile::GetCharacter ( Standard_Character &  aValue )

virtual

Implements Storage_BaseDriver.

Storage_BaseDriver& FSD_CmpFile::GetExtCharacter ( Standard_ExtCharacter &  aValue )

virtual

Implements Storage_BaseDriver.

Storage_BaseDriver& FSD_CmpFile::GetInteger ( Standard_Integer &  aValue )

virtual

Implements Storage_BaseDriver.

Storage_BaseDriver& FSD_CmpFile::GetReal ( Standard_Real &  aValue )

virtual

Implements Storage_BaseDriver.

Storage_BaseDriver& FSD_CmpFile::GetReference ( Standard_Integer &  aValue )

virtual

Implements Storage_BaseDriver.

Storage_BaseDriver& FSD_CmpFile::GetShortReal ( Standard_ShortReal &  aValue )

virtual

Implements Storage_BaseDriver.

Standard_Boolean FSD_CmpFile::IsEnd ( )

virtual

returns True if we are at end of the stream

Implements Storage_BaseDriver.

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

static

static Standard_CString FSD_CmpFile::MagicNumber ( )

static

Storage_Error FSD_CmpFile::Open ( const TCollection_AsciiString &  aName, const Storage_OpenMode  aMode  )

virtual

Implements Storage_BaseDriver.

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

inline

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

inline

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

inline

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

inline

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

inline

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

inline

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

inline

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

inline

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

inline

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

inline

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

inline

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

inline

Storage_BaseDriver& FSD_CmpFile::PutBoolean ( const Standard_Boolean  aValue )

virtual

Implements Storage_BaseDriver.

Storage_BaseDriver& FSD_CmpFile::PutCharacter ( const Standard_Character  aValue )

virtual

Implements Storage_BaseDriver.

Storage_BaseDriver& FSD_CmpFile::PutExtCharacter ( const Standard_ExtCharacter  aValue )

virtual

Implements Storage_BaseDriver.

Storage_BaseDriver& FSD_CmpFile::PutInteger ( const Standard_Integer  aValue )

virtual

Implements Storage_BaseDriver.

Storage_BaseDriver& FSD_CmpFile::PutReal ( const Standard_Real  aValue )

virtual

Implements Storage_BaseDriver.

Storage_BaseDriver& FSD_CmpFile::PutReference ( const Standard_Integer  aValue )

virtual

Implements Storage_BaseDriver.

Storage_BaseDriver& FSD_CmpFile::PutShortReal ( const Standard_ShortReal  aValue )

virtual

Implements Storage_BaseDriver.

void FSD_CmpFile::ReadChar ( TCollection_AsciiString &  buffer, const Standard_Size  rsize  )

protected

read <rsize> character from the current position.

void FSD_CmpFile::ReadComment ( TColStd_SequenceOfExtendedString &  userComments )

virtual

Implements Storage_BaseDriver.

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

virtual

Implements Storage_BaseDriver.

void FSD_CmpFile::ReadExtendedLine ( TCollection_ExtendedString &  buffer )

protected

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

void FSD_CmpFile::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_CmpFile::ReadLine ( TCollection_AsciiString &  buffer )

protected

read from the current position to the end of line.

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

virtual

Implements Storage_BaseDriver.

void FSD_CmpFile::ReadReferenceType ( Standard_Integer &  reference, Standard_Integer &  typeNum  )

virtual

Implements Storage_BaseDriver.

void FSD_CmpFile::ReadRoot ( TCollection_AsciiString &  rootName, Standard_Integer &  aRef, TCollection_AsciiString &  aType  )

virtual

Implements Storage_BaseDriver.

void FSD_CmpFile::ReadString ( TCollection_AsciiString &  buffer )

protected

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

void FSD_CmpFile::ReadTypeInformations ( Standard_Integer &  typeNum, TCollection_AsciiString &  typeName  )

virtual

Implements Storage_BaseDriver.

void FSD_CmpFile::ReadWord ( TCollection_AsciiString &  buffer )

protected

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

Standard_Integer FSD_CmpFile::RefSectionSize ( )

virtual

Implements Storage_BaseDriver.

Standard_Integer FSD_CmpFile::RootSectionSize ( )

virtual

Implements Storage_BaseDriver.

void FSD_CmpFile::SetRefSectionSize ( const Standard_Integer  aSize )

virtual

Implements Storage_BaseDriver.

void FSD_CmpFile::SetRootSectionSize ( const Standard_Integer  aSize )

virtual

Implements Storage_BaseDriver.

void FSD_CmpFile::SetTypeSectionSize ( const Standard_Integer  aSize )

virtual

Implements Storage_BaseDriver.

void FSD_CmpFile::SkipObject ( )

virtual

Implements Storage_BaseDriver.

Storage_Position FSD_CmpFile::Tell ( )

virtual

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

Implements Storage_BaseDriver.

Standard_Integer FSD_CmpFile::TypeSectionSize ( )

virtual

Implements Storage_BaseDriver.

void FSD_CmpFile::WriteComment ( const TColStd_SequenceOfExtendedString &  userComments )

virtual

Implements Storage_BaseDriver.

void FSD_CmpFile::WriteExtendedLine ( const TCollection_ExtendedString &  buffer )

protected

write from the current position to the end of line.

void FSD_CmpFile::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_CmpFile::WritePersistentObjectHeader ( const Standard_Integer  aRef, const Standard_Integer  aType  )

virtual

Implements Storage_BaseDriver.

void FSD_CmpFile::WriteReferenceType ( const Standard_Integer  reference, const Standard_Integer  typeNum  )

virtual

Implements Storage_BaseDriver.

void FSD_CmpFile::WriteRoot ( const TCollection_AsciiString &  rootName, const Standard_Integer  aRef, const TCollection_AsciiString &  aType  )

virtual

Implements Storage_BaseDriver.

void FSD_CmpFile::WriteTypeInformations ( const Standard_Integer  typeNum, const TCollection_AsciiString &  typeName  )

virtual

Implements Storage_BaseDriver.

---

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

• FSD_CmpFile.hxx