FoundationClasses
TKernel
FSD

FSD_CmpFile Class Reference

#include <FSD_CmpFile.hxx>

Inheritance diagram for FSD_CmpFile:

[legend]


Public Member Functions
void *	operator new (size_t, void *anAddress)
void *	operator new (size_t size)
void	operator delete (void *anAddress)
Standard_EXPORT	FSD_CmpFile ()
Standard_EXPORT Storage_Error	Open (const TCollection_AsciiString &aName, const Storage_OpenMode aMode)
Standard_EXPORT Standard_Boolean	IsEnd ()
	returns True if we are at end of the stream
Standard_EXPORT Storage_Position	Tell ()
	return position in the file. Return -1 upon error.
Standard_EXPORT Storage_Error	BeginWriteInfoSection ()
Standard_EXPORT 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)
Standard_EXPORT Storage_Error	EndWriteInfoSection ()
Standard_EXPORT Storage_Error	BeginReadInfoSection ()
Standard_EXPORT 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)
Standard_EXPORT Storage_Error	EndReadInfoSection ()
Standard_EXPORT Storage_Error	BeginWriteCommentSection ()
Standard_EXPORT void	WriteComment (const TColStd_SequenceOfExtendedString &userComments)
Standard_EXPORT Storage_Error	EndWriteCommentSection ()
Standard_EXPORT Storage_Error	BeginReadCommentSection ()
Standard_EXPORT void	ReadComment (TColStd_SequenceOfExtendedString &userComments)
Standard_EXPORT Storage_Error	EndReadCommentSection ()
Standard_EXPORT Storage_Error	BeginWriteTypeSection ()
Standard_EXPORT void	SetTypeSectionSize (const Standard_Integer aSize)
Standard_EXPORT void	WriteTypeInformations (const Standard_Integer typeNum, const TCollection_AsciiString &typeName)
Standard_EXPORT Storage_Error	EndWriteTypeSection ()
Standard_EXPORT Storage_Error	BeginReadTypeSection ()
Standard_EXPORT Standard_Integer	TypeSectionSize ()
Standard_EXPORT void	ReadTypeInformations (Standard_Integer &typeNum, TCollection_AsciiString &typeName)
Standard_EXPORT Storage_Error	EndReadTypeSection ()
Standard_EXPORT Storage_Error	BeginWriteRootSection ()
Standard_EXPORT void	SetRootSectionSize (const Standard_Integer aSize)
Standard_EXPORT void	WriteRoot (const TCollection_AsciiString &rootName, const Standard_Integer aRef, const TCollection_AsciiString &aType)
Standard_EXPORT Storage_Error	EndWriteRootSection ()
Standard_EXPORT Storage_Error	BeginReadRootSection ()
Standard_EXPORT Standard_Integer	RootSectionSize ()
Standard_EXPORT void	ReadRoot (TCollection_AsciiString &rootName, Standard_Integer &aRef, TCollection_AsciiString &aType)
Standard_EXPORT Storage_Error	EndReadRootSection ()
Standard_EXPORT Storage_Error	BeginWriteRefSection ()
Standard_EXPORT void	SetRefSectionSize (const Standard_Integer aSize)
Standard_EXPORT void	WriteReferenceType (const Standard_Integer reference, const Standard_Integer typeNum)
Standard_EXPORT Storage_Error	EndWriteRefSection ()
Standard_EXPORT Storage_Error	BeginReadRefSection ()
Standard_EXPORT Standard_Integer	RefSectionSize ()
Standard_EXPORT void	ReadReferenceType (Standard_Integer &reference, Standard_Integer &typeNum)
Standard_EXPORT Storage_Error	EndReadRefSection ()
Standard_EXPORT Storage_Error	BeginWriteDataSection ()
Standard_EXPORT void	WritePersistentObjectHeader (const Standard_Integer aRef, const Standard_Integer aType)
Standard_EXPORT void	BeginWritePersistentObjectData ()
Standard_EXPORT void	BeginWriteObjectData ()
Standard_EXPORT void	EndWriteObjectData ()
Standard_EXPORT void	EndWritePersistentObjectData ()
Standard_EXPORT Storage_Error	EndWriteDataSection ()
Standard_EXPORT Storage_Error	BeginReadDataSection ()
Standard_EXPORT void	ReadPersistentObjectHeader (Standard_Integer &aRef, Standard_Integer &aType)
Standard_EXPORT void	BeginReadPersistentObjectData ()
Standard_EXPORT void	BeginReadObjectData ()
Standard_EXPORT void	EndReadObjectData ()
Standard_EXPORT void	EndReadPersistentObjectData ()
Standard_EXPORT Storage_Error	EndReadDataSection ()
Standard_EXPORT void	SkipObject ()
Standard_EXPORT Storage_BaseDriver &	PutReference (const Standard_Integer aValue)
Standard_EXPORT Storage_BaseDriver &	PutCharacter (const Standard_Character aValue)
Storage_BaseDriver &	operator<< (const Standard_Character aValue)
Standard_EXPORT Storage_BaseDriver &	PutExtCharacter (const Standard_ExtCharacter aValue)
Storage_BaseDriver &	operator<< (const Standard_ExtCharacter aValue)
Standard_EXPORT Storage_BaseDriver &	PutInteger (const Standard_Integer aValue)
Storage_BaseDriver &	operator<< (const Standard_Integer aValue)
Standard_EXPORT Storage_BaseDriver &	PutBoolean (const Standard_Boolean aValue)
Storage_BaseDriver &	operator<< (const Standard_Boolean aValue)
Standard_EXPORT Storage_BaseDriver &	PutReal (const Standard_Real aValue)
Storage_BaseDriver &	operator<< (const Standard_Real aValue)
Standard_EXPORT Storage_BaseDriver &	PutShortReal (const Standard_ShortReal aValue)
Storage_BaseDriver &	operator<< (const Standard_ShortReal aValue)
Standard_EXPORT Storage_BaseDriver &	GetReference (Standard_Integer &aValue)
Standard_EXPORT Storage_BaseDriver &	GetCharacter (Standard_Character &aValue)
Storage_BaseDriver &	operator>> (Standard_Character &aValue)
Standard_EXPORT Storage_BaseDriver &	GetExtCharacter (Standard_ExtCharacter &aValue)
Storage_BaseDriver &	operator>> (Standard_ExtCharacter &aValue)
Standard_EXPORT Storage_BaseDriver &	GetInteger (Standard_Integer &aValue)
Storage_BaseDriver &	operator>> (Standard_Integer &aValue)
Standard_EXPORT Storage_BaseDriver &	GetBoolean (Standard_Boolean &aValue)
Storage_BaseDriver &	operator>> (Standard_Boolean &aValue)
Standard_EXPORT Storage_BaseDriver &	GetReal (Standard_Real &aValue)
Storage_BaseDriver &	operator>> (Standard_Real &aValue)
Standard_EXPORT Storage_BaseDriver &	GetShortReal (Standard_ShortReal &aValue)
Storage_BaseDriver &	operator>> (Standard_ShortReal &aValue)
Standard_EXPORT Storage_Error	Close ()
Standard_EXPORT void	Destroy ()
	~FSD_CmpFile ()
Static Public Member Functions
static Standard_EXPORT Storage_Error	IsGoodFileType (const TCollection_AsciiString &aName)
Protected Member Functions
Standard_EXPORT void	ReadLine (TCollection_AsciiString &buffer)
	read from the current position to the end of line.
Standard_EXPORT void	ReadWord (TCollection_AsciiString &buffer)
	read from the current position to the next white space or end of line.
Standard_EXPORT void	ReadExtendedLine (TCollection_ExtendedString &buffer)
	read extended chars (unicode) from the current position to the end of line.
Standard_EXPORT void	WriteExtendedLine (const TCollection_ExtendedString &buffer)
	write from the current position to the end of line.
Standard_EXPORT void	ReadChar (TCollection_AsciiString &buffer, const Standard_Integer rsize)
	read <rsize> character from the current position.
Standard_EXPORT void	ReadString (TCollection_AsciiString &buffer)
	read from the first none space character position to the end of line.
Standard_EXPORT void	FlushEndOfLine ()
Standard_EXPORT Storage_Error	FindTag (const Standard_CString aTag)
Private Member Functions
Standard_EXPORT void	RaiseError (const Handle(Standard_Type)&theFailure)
Static Private Member Functions
static Standard_EXPORT const Standard_CString	MagicNumber ()
Private Attributes
FSD_FStream	myStream
OSD_Real2String	myRealConv

Constructor & Destructor Documentation

Standard_EXPORT FSD_CmpFile::FSD_CmpFile ( )

FSD_CmpFile::~FSD_CmpFile ( ) [inline]

Member Function Documentation

Standard_EXPORT Storage_Error FSD_CmpFile::BeginReadCommentSection ( ) [virtual]

Implements Storage_BaseDriver.

Standard_EXPORT Storage_Error FSD_CmpFile::BeginReadDataSection ( ) [virtual]

Implements Storage_BaseDriver.

Standard_EXPORT Storage_Error FSD_CmpFile::BeginReadInfoSection ( ) [virtual]

Implements Storage_BaseDriver.

Standard_EXPORT void FSD_CmpFile::BeginReadObjectData ( ) [virtual]

Implements Storage_BaseDriver.

Standard_EXPORT void FSD_CmpFile::BeginReadPersistentObjectData ( ) [virtual]

Implements Storage_BaseDriver.

Standard_EXPORT Storage_Error FSD_CmpFile::BeginReadRefSection ( ) [virtual]

Implements Storage_BaseDriver.

Standard_EXPORT Storage_Error FSD_CmpFile::BeginReadRootSection ( ) [virtual]

Implements Storage_BaseDriver.

Standard_EXPORT Storage_Error FSD_CmpFile::BeginReadTypeSection ( ) [virtual]

Implements Storage_BaseDriver.

Standard_EXPORT Storage_Error FSD_CmpFile::BeginWriteCommentSection ( ) [virtual]

Implements Storage_BaseDriver.

Standard_EXPORT Storage_Error FSD_CmpFile::BeginWriteDataSection ( ) [virtual]

Implements Storage_BaseDriver.

Standard_EXPORT Storage_Error FSD_CmpFile::BeginWriteInfoSection ( ) [virtual]

Implements Storage_BaseDriver.

Standard_EXPORT void FSD_CmpFile::BeginWriteObjectData ( ) [virtual]

Implements Storage_BaseDriver.

Standard_EXPORT void FSD_CmpFile::BeginWritePersistentObjectData ( ) [virtual]

Implements Storage_BaseDriver.

Standard_EXPORT Storage_Error FSD_CmpFile::BeginWriteRefSection ( ) [virtual]

Implements Storage_BaseDriver.

Standard_EXPORT Storage_Error FSD_CmpFile::BeginWriteRootSection ( ) [virtual]

Implements Storage_BaseDriver.

Standard_EXPORT Storage_Error FSD_CmpFile::BeginWriteTypeSection ( ) [virtual]

Implements Storage_BaseDriver.

Standard_EXPORT Storage_Error FSD_CmpFile::Close ( ) [virtual]

Implements Storage_BaseDriver.

Standard_EXPORT void FSD_CmpFile::Destroy ( )

Standard_EXPORT Storage_Error FSD_CmpFile::EndReadCommentSection ( ) [virtual]

Implements Storage_BaseDriver.

Standard_EXPORT Storage_Error FSD_CmpFile::EndReadDataSection ( ) [virtual]

Implements Storage_BaseDriver.

Standard_EXPORT Storage_Error FSD_CmpFile::EndReadInfoSection ( ) [virtual]

Implements Storage_BaseDriver.

Standard_EXPORT void FSD_CmpFile::EndReadObjectData ( ) [virtual]

Implements Storage_BaseDriver.

Standard_EXPORT void FSD_CmpFile::EndReadPersistentObjectData ( ) [virtual]

Implements Storage_BaseDriver.

Standard_EXPORT Storage_Error FSD_CmpFile::EndReadRefSection ( ) [virtual]

Implements Storage_BaseDriver.

Standard_EXPORT Storage_Error FSD_CmpFile::EndReadRootSection ( ) [virtual]

Implements Storage_BaseDriver.

Standard_EXPORT Storage_Error FSD_CmpFile::EndReadTypeSection ( ) [virtual]

Implements Storage_BaseDriver.

Standard_EXPORT Storage_Error FSD_CmpFile::EndWriteCommentSection ( ) [virtual]

Implements Storage_BaseDriver.

Standard_EXPORT Storage_Error FSD_CmpFile::EndWriteDataSection ( ) [virtual]

Implements Storage_BaseDriver.

Standard_EXPORT Storage_Error FSD_CmpFile::EndWriteInfoSection ( ) [virtual]

Implements Storage_BaseDriver.

Standard_EXPORT void FSD_CmpFile::EndWriteObjectData ( ) [virtual]

Implements Storage_BaseDriver.

Standard_EXPORT void FSD_CmpFile::EndWritePersistentObjectData ( ) [virtual]

Implements Storage_BaseDriver.

Standard_EXPORT Storage_Error FSD_CmpFile::EndWriteRefSection ( ) [virtual]

Implements Storage_BaseDriver.

Standard_EXPORT Storage_Error FSD_CmpFile::EndWriteRootSection ( ) [virtual]

Implements Storage_BaseDriver.

Standard_EXPORT Storage_Error FSD_CmpFile::EndWriteTypeSection ( ) [virtual]

Implements Storage_BaseDriver.

Standard_EXPORT Storage_Error FSD_CmpFile::FindTag ( const Standard_CString aTag ) [protected]

Standard_EXPORT void FSD_CmpFile::FlushEndOfLine ( ) [protected]

Standard_EXPORT Storage_BaseDriver& FSD_CmpFile::GetBoolean ( Standard_Boolean & aValue ) [virtual]

Implements Storage_BaseDriver.

Standard_EXPORT Storage_BaseDriver& FSD_CmpFile::GetCharacter ( Standard_Character & aValue ) [virtual]

Implements Storage_BaseDriver.

Standard_EXPORT Storage_BaseDriver& FSD_CmpFile::GetExtCharacter ( Standard_ExtCharacter & aValue ) [virtual]

Implements Storage_BaseDriver.

Standard_EXPORT Storage_BaseDriver& FSD_CmpFile::GetInteger ( Standard_Integer & aValue ) [virtual]

Implements Storage_BaseDriver.

Standard_EXPORT Storage_BaseDriver& FSD_CmpFile::GetReal ( Standard_Real & aValue ) [virtual]

Implements Storage_BaseDriver.

Standard_EXPORT Storage_BaseDriver& FSD_CmpFile::GetReference ( Standard_Integer & aValue ) [virtual]

Implements Storage_BaseDriver.

Standard_EXPORT Storage_BaseDriver& FSD_CmpFile::GetShortReal ( Standard_ShortReal & aValue ) [virtual]

Implements Storage_BaseDriver.

Standard_EXPORT Standard_Boolean FSD_CmpFile::IsEnd ( ) [virtual]

Implements Storage_BaseDriver.

static Standard_EXPORT Storage_Error FSD_CmpFile::IsGoodFileType ( const TCollection_AsciiString & aName ) [static]

static Standard_EXPORT const Standard_CString FSD_CmpFile::MagicNumber ( ) [static, private]

Standard_EXPORT Storage_Error FSD_CmpFile::Open ( const TCollection_AsciiString & aName,

const Storage_OpenMode aMode

) [virtual]

Implements Storage_BaseDriver.

void FSD_CmpFile::operator delete ( void * anAddress ) [inline]

Reimplemented from Storage_BaseDriver.

void* FSD_CmpFile::operator new ( size_t size ) [inline]

Reimplemented from Storage_BaseDriver.

void* FSD_CmpFile::operator new ( size_t ,

void * anAddress

) [inline]

Reimplemented from Storage_BaseDriver.

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

Reimplemented from Storage_BaseDriver.

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

Reimplemented from Storage_BaseDriver.

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

Reimplemented from Storage_BaseDriver.

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

Reimplemented from Storage_BaseDriver.

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

Reimplemented from Storage_BaseDriver.

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

Reimplemented from Storage_BaseDriver.

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

Reimplemented from Storage_BaseDriver.

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

Reimplemented from Storage_BaseDriver.

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

Reimplemented from Storage_BaseDriver.

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

Reimplemented from Storage_BaseDriver.

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

Reimplemented from Storage_BaseDriver.

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

Reimplemented from Storage_BaseDriver.

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

Implements Storage_BaseDriver.

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

Implements Storage_BaseDriver.

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

Implements Storage_BaseDriver.

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

Implements Storage_BaseDriver.

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

Implements Storage_BaseDriver.

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

Implements Storage_BaseDriver.

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

Implements Storage_BaseDriver.

Standard_EXPORT void FSD_CmpFile::RaiseError ( const Handle(Standard_Type)& theFailure ) [private]

Standard_EXPORT void FSD_CmpFile::ReadChar ( TCollection_AsciiString & buffer,

const Standard_Integer rsize

) [protected]

Standard_EXPORT void FSD_CmpFile::ReadComment ( TColStd_SequenceOfExtendedString & userComments ) [virtual]

Implements Storage_BaseDriver.

Standard_EXPORT void FSD_CmpFile::ReadExtendedLine ( TCollection_ExtendedString & buffer ) [protected]

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

Standard_EXPORT void FSD_CmpFile::ReadLine ( TCollection_AsciiString & buffer ) [protected]

Standard_EXPORT void FSD_CmpFile::ReadPersistentObjectHeader ( Standard_Integer & aRef,

Standard_Integer & aType

) [virtual]

Implements Storage_BaseDriver.

Standard_EXPORT void FSD_CmpFile::ReadReferenceType ( Standard_Integer & reference,

Standard_Integer & typeNum

) [virtual]

Implements Storage_BaseDriver.

Standard_EXPORT void FSD_CmpFile::ReadRoot ( TCollection_AsciiString & rootName,

Standard_Integer & aRef,

TCollection_AsciiString & aType

) [virtual]

Implements Storage_BaseDriver.

Standard_EXPORT void FSD_CmpFile::ReadString ( TCollection_AsciiString & buffer ) [protected]

Standard_EXPORT void FSD_CmpFile::ReadTypeInformations ( Standard_Integer & typeNum,

TCollection_AsciiString & typeName

) [virtual]

Implements Storage_BaseDriver.

Standard_EXPORT void FSD_CmpFile::ReadWord ( TCollection_AsciiString & buffer ) [protected]

Standard_EXPORT Standard_Integer FSD_CmpFile::RefSectionSize ( ) [virtual]

Implements Storage_BaseDriver.

Standard_EXPORT Standard_Integer FSD_CmpFile::RootSectionSize ( ) [virtual]

Implements Storage_BaseDriver.

Standard_EXPORT void FSD_CmpFile::SetRefSectionSize ( const Standard_Integer aSize ) [virtual]

Implements Storage_BaseDriver.

Standard_EXPORT void FSD_CmpFile::SetRootSectionSize ( const Standard_Integer aSize ) [virtual]

Implements Storage_BaseDriver.

Standard_EXPORT void FSD_CmpFile::SetTypeSectionSize ( const Standard_Integer aSize ) [virtual]

Implements Storage_BaseDriver.

Standard_EXPORT void FSD_CmpFile::SkipObject ( ) [virtual]

Implements Storage_BaseDriver.

Standard_EXPORT Storage_Position FSD_CmpFile::Tell ( ) [virtual]

Implements Storage_BaseDriver.

Standard_EXPORT Standard_Integer FSD_CmpFile::TypeSectionSize ( ) [virtual]

Implements Storage_BaseDriver.

Standard_EXPORT void FSD_CmpFile::WriteComment ( const TColStd_SequenceOfExtendedString & userComments ) [virtual]

Implements Storage_BaseDriver.

Standard_EXPORT void FSD_CmpFile::WriteExtendedLine ( const TCollection_ExtendedString & buffer ) [protected]

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

Standard_EXPORT void FSD_CmpFile::WritePersistentObjectHeader ( const Standard_Integer aRef,

const Standard_Integer aType

) [virtual]

Implements Storage_BaseDriver.

Standard_EXPORT void FSD_CmpFile::WriteReferenceType ( const Standard_Integer reference,

const Standard_Integer typeNum

) [virtual]

Implements Storage_BaseDriver.

Standard_EXPORT void FSD_CmpFile::WriteRoot ( const TCollection_AsciiString & rootName,

const Standard_Integer aRef,

const TCollection_AsciiString & aType

) [virtual]

Implements Storage_BaseDriver.

Standard_EXPORT void FSD_CmpFile::WriteTypeInformations ( const Standard_Integer typeNum,

const TCollection_AsciiString & typeName

) [virtual]

Implements Storage_BaseDriver.