FoundationClasses
TKernel
FSD

FSD_BinaryFile Class Reference

#include <FSD_BinaryFile.hxx>

Inheritance diagram for FSD_BinaryFile:

[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_BinaryFile ()
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_BinaryFile ()
Static Public Member Functions
static Standard_EXPORT Storage_Error	IsGoodFileType (const TCollection_AsciiString &aName)
Protected Member Functions
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 string from the current position.
Standard_EXPORT void	WriteString (const TCollection_AsciiString &buffer)
	write string at the current position.
Standard_EXPORT void	ReadExtendedString (TCollection_ExtendedString &buffer)
	read string from the current position.
Standard_EXPORT void	WriteExtendedString (const TCollection_ExtendedString &buffer)
	write string at the current position.
Private Member Functions
Standard_EXPORT void	WriteHeader ()
Standard_EXPORT void	ReadHeader ()
Static Private Member Functions
static Standard_EXPORT const Standard_CString	MagicNumber ()
Private Attributes
FSD_BStream	myStream
FSD_FileHeader	myHeader

Constructor & Destructor Documentation

Standard_EXPORT FSD_BinaryFile::FSD_BinaryFile ( )

FSD_BinaryFile::~FSD_BinaryFile ( ) [inline]

Member Function Documentation

Standard_EXPORT Storage_Error FSD_BinaryFile::BeginReadCommentSection ( ) [virtual]

Implements Storage_BaseDriver.

Standard_EXPORT Storage_Error FSD_BinaryFile::BeginReadDataSection ( ) [virtual]

Implements Storage_BaseDriver.

Standard_EXPORT Storage_Error FSD_BinaryFile::BeginReadInfoSection ( ) [virtual]

Implements Storage_BaseDriver.

Standard_EXPORT void FSD_BinaryFile::BeginReadObjectData ( ) [virtual]

Implements Storage_BaseDriver.

Standard_EXPORT void FSD_BinaryFile::BeginReadPersistentObjectData ( ) [virtual]

Implements Storage_BaseDriver.

Standard_EXPORT Storage_Error FSD_BinaryFile::BeginReadRefSection ( ) [virtual]

Implements Storage_BaseDriver.

Standard_EXPORT Storage_Error FSD_BinaryFile::BeginReadRootSection ( ) [virtual]

Implements Storage_BaseDriver.

Standard_EXPORT Storage_Error FSD_BinaryFile::BeginReadTypeSection ( ) [virtual]

Implements Storage_BaseDriver.

Standard_EXPORT Storage_Error FSD_BinaryFile::BeginWriteCommentSection ( ) [virtual]

Implements Storage_BaseDriver.

Standard_EXPORT Storage_Error FSD_BinaryFile::BeginWriteDataSection ( ) [virtual]

Implements Storage_BaseDriver.

Standard_EXPORT Storage_Error FSD_BinaryFile::BeginWriteInfoSection ( ) [virtual]

Implements Storage_BaseDriver.

Standard_EXPORT void FSD_BinaryFile::BeginWriteObjectData ( ) [virtual]

Implements Storage_BaseDriver.

Standard_EXPORT void FSD_BinaryFile::BeginWritePersistentObjectData ( ) [virtual]

Implements Storage_BaseDriver.

Standard_EXPORT Storage_Error FSD_BinaryFile::BeginWriteRefSection ( ) [virtual]

Implements Storage_BaseDriver.

Standard_EXPORT Storage_Error FSD_BinaryFile::BeginWriteRootSection ( ) [virtual]

Implements Storage_BaseDriver.

Standard_EXPORT Storage_Error FSD_BinaryFile::BeginWriteTypeSection ( ) [virtual]

Implements Storage_BaseDriver.

Standard_EXPORT Storage_Error FSD_BinaryFile::Close ( ) [virtual]

Implements Storage_BaseDriver.

Standard_EXPORT void FSD_BinaryFile::Destroy ( )

Standard_EXPORT Storage_Error FSD_BinaryFile::EndReadCommentSection ( ) [virtual]

Implements Storage_BaseDriver.

Standard_EXPORT Storage_Error FSD_BinaryFile::EndReadDataSection ( ) [virtual]

Implements Storage_BaseDriver.

Standard_EXPORT Storage_Error FSD_BinaryFile::EndReadInfoSection ( ) [virtual]

Implements Storage_BaseDriver.

Standard_EXPORT void FSD_BinaryFile::EndReadObjectData ( ) [virtual]

Implements Storage_BaseDriver.

Standard_EXPORT void FSD_BinaryFile::EndReadPersistentObjectData ( ) [virtual]

Implements Storage_BaseDriver.

Standard_EXPORT Storage_Error FSD_BinaryFile::EndReadRefSection ( ) [virtual]

Implements Storage_BaseDriver.

Standard_EXPORT Storage_Error FSD_BinaryFile::EndReadRootSection ( ) [virtual]

Implements Storage_BaseDriver.

Standard_EXPORT Storage_Error FSD_BinaryFile::EndReadTypeSection ( ) [virtual]

Implements Storage_BaseDriver.

Standard_EXPORT Storage_Error FSD_BinaryFile::EndWriteCommentSection ( ) [virtual]

Implements Storage_BaseDriver.

Standard_EXPORT Storage_Error FSD_BinaryFile::EndWriteDataSection ( ) [virtual]

Implements Storage_BaseDriver.

Standard_EXPORT Storage_Error FSD_BinaryFile::EndWriteInfoSection ( ) [virtual]

Implements Storage_BaseDriver.

Standard_EXPORT void FSD_BinaryFile::EndWriteObjectData ( ) [virtual]

Implements Storage_BaseDriver.

Standard_EXPORT void FSD_BinaryFile::EndWritePersistentObjectData ( ) [virtual]

Implements Storage_BaseDriver.

Standard_EXPORT Storage_Error FSD_BinaryFile::EndWriteRefSection ( ) [virtual]

Implements Storage_BaseDriver.

Standard_EXPORT Storage_Error FSD_BinaryFile::EndWriteRootSection ( ) [virtual]

Implements Storage_BaseDriver.

Standard_EXPORT Storage_Error FSD_BinaryFile::EndWriteTypeSection ( ) [virtual]

Implements Storage_BaseDriver.

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

Implements Storage_BaseDriver.

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

Implements Storage_BaseDriver.

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

Implements Storage_BaseDriver.

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

Implements Storage_BaseDriver.

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

Implements Storage_BaseDriver.

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

Implements Storage_BaseDriver.

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

Implements Storage_BaseDriver.

Standard_EXPORT Standard_Boolean FSD_BinaryFile::IsEnd ( ) [virtual]

Implements Storage_BaseDriver.

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

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

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

const Storage_OpenMode aMode

) [virtual]

Implements Storage_BaseDriver.

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

Reimplemented from Storage_BaseDriver.

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

Reimplemented from Storage_BaseDriver.

void* FSD_BinaryFile::operator new ( size_t ,

void * anAddress

) [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_Real aValue ) [inline]

Reimplemented from Storage_BaseDriver.

Storage_BaseDriver& FSD_BinaryFile::operator<< ( const Standard_Boolean 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<< ( const Standard_ExtCharacter 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>> ( Standard_ShortReal & 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_Boolean & aValue ) [inline]

Reimplemented from Storage_BaseDriver.

Storage_BaseDriver& FSD_BinaryFile::operator>> ( Standard_Integer & 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_Character & aValue ) [inline]

Reimplemented from Storage_BaseDriver.

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

Implements Storage_BaseDriver.

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

Implements Storage_BaseDriver.

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

Implements Storage_BaseDriver.

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

Implements Storage_BaseDriver.

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

Implements Storage_BaseDriver.

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

Implements Storage_BaseDriver.

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

Implements Storage_BaseDriver.

Standard_EXPORT void FSD_BinaryFile::ReadChar ( TCollection_AsciiString & buffer,

const Standard_Integer rsize

) [protected]

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

Implements Storage_BaseDriver.

Standard_EXPORT void FSD_BinaryFile::ReadExtendedString ( TCollection_ExtendedString & buffer ) [protected]

Standard_EXPORT void FSD_BinaryFile::ReadHeader ( ) [private]

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

Standard_EXPORT void FSD_BinaryFile::ReadPersistentObjectHeader ( Standard_Integer & aRef,

Standard_Integer & aType

) [virtual]

Implements Storage_BaseDriver.

Standard_EXPORT void FSD_BinaryFile::ReadReferenceType ( Standard_Integer & reference,

Standard_Integer & typeNum

) [virtual]

Implements Storage_BaseDriver.

Standard_EXPORT void FSD_BinaryFile::ReadRoot ( TCollection_AsciiString & rootName,

Standard_Integer & aRef,

TCollection_AsciiString & aType

) [virtual]

Implements Storage_BaseDriver.

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

Standard_EXPORT void FSD_BinaryFile::ReadTypeInformations ( Standard_Integer & typeNum,

TCollection_AsciiString & typeName

) [virtual]

Implements Storage_BaseDriver.

Standard_EXPORT Standard_Integer FSD_BinaryFile::RefSectionSize ( ) [virtual]

Implements Storage_BaseDriver.

Standard_EXPORT Standard_Integer FSD_BinaryFile::RootSectionSize ( ) [virtual]

Implements Storage_BaseDriver.

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

Implements Storage_BaseDriver.

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

Implements Storage_BaseDriver.

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

Implements Storage_BaseDriver.

Standard_EXPORT void FSD_BinaryFile::SkipObject ( ) [virtual]

Implements Storage_BaseDriver.

Standard_EXPORT Storage_Position FSD_BinaryFile::Tell ( ) [virtual]

Implements Storage_BaseDriver.

Standard_EXPORT Standard_Integer FSD_BinaryFile::TypeSectionSize ( ) [virtual]

Implements Storage_BaseDriver.

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

Implements Storage_BaseDriver.

Standard_EXPORT void FSD_BinaryFile::WriteExtendedString ( const TCollection_ExtendedString & buffer ) [protected]

Standard_EXPORT void FSD_BinaryFile::WriteHeader ( ) [private]

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

Standard_EXPORT void FSD_BinaryFile::WritePersistentObjectHeader ( const Standard_Integer aRef,

const Standard_Integer aType

) [virtual]

Implements Storage_BaseDriver.

Standard_EXPORT void FSD_BinaryFile::WriteReferenceType ( const Standard_Integer reference,

const Standard_Integer typeNum

) [virtual]

Implements Storage_BaseDriver.

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

const Standard_Integer aRef,

const TCollection_AsciiString & aType

) [virtual]

Implements Storage_BaseDriver.

Standard_EXPORT void FSD_BinaryFile::WriteString ( const TCollection_AsciiString & buffer ) [protected]

Standard_EXPORT void FSD_BinaryFile::WriteTypeInformations ( const Standard_Integer typeNum,

const TCollection_AsciiString & typeName

) [virtual]

Implements Storage_BaseDriver.