Root class for drivers. A driver assigns a physical container to data to be stored or retrieved, for instance a file. The FSD package provides two derived concrete classes : More...

#include <Storage_BaseDriver.hxx>

Inheritance diagram for Storage_BaseDriver:

[legend]

Public Member Functions
virtual	~Storage_BaseDriver ()

TCollection_AsciiString	Name () const

Storage_OpenMode	OpenMode () const

Virtual methods, to be provided by descendants
virtual Storage_Error	Open (const TCollection_AsciiString &aName, const Storage_OpenMode aMode)=0
	returns True if we are at end of the stream

virtual Standard_Boolean	IsEnd ()=0
	returns True if we are at end of the stream

virtual Storage_Position	Tell ()=0
	return position in the file. Return -1 upon error.

virtual Storage_Error	BeginWriteInfoSection ()=0
	returns True if we are at end of the stream

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)=0
	returns True if we are at end of the stream

virtual Storage_Error	EndWriteInfoSection ()=0
	returns True if we are at end of the stream

virtual Storage_Error	BeginReadInfoSection ()=0
	returns True if we are at end of the stream

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)=0
	returns True if we are at end of the stream

virtual void	ReadCompleteInfo (Standard_IStream &theIStream, Handle< Storage_Data > &theData)=0
	returns True if we are at end of the stream

virtual Storage_Error	EndReadInfoSection ()=0
	returns True if we are at end of the stream

virtual Storage_Error	BeginWriteCommentSection ()=0
	returns True if we are at end of the stream

virtual void	WriteComment (const TColStd_SequenceOfExtendedString &userComments)=0
	returns True if we are at end of the stream

virtual Storage_Error	EndWriteCommentSection ()=0
	returns True if we are at end of the stream

virtual Storage_Error	BeginReadCommentSection ()=0
	returns True if we are at end of the stream

virtual void	ReadComment (TColStd_SequenceOfExtendedString &userComments)=0
	returns True if we are at end of the stream

virtual Storage_Error	EndReadCommentSection ()=0
	returns True if we are at end of the stream

virtual Storage_Error	BeginWriteTypeSection ()=0
	returns True if we are at end of the stream

virtual void	SetTypeSectionSize (const Standard_Integer aSize)=0
	returns True if we are at end of the stream

virtual void	WriteTypeInformations (const Standard_Integer typeNum, const TCollection_AsciiString &typeName)=0
	returns True if we are at end of the stream

virtual Storage_Error	EndWriteTypeSection ()=0
	returns True if we are at end of the stream

virtual Storage_Error	BeginReadTypeSection ()=0
	returns True if we are at end of the stream

virtual Standard_Integer	TypeSectionSize ()=0
	returns True if we are at end of the stream

virtual void	ReadTypeInformations (Standard_Integer &typeNum, TCollection_AsciiString &typeName)=0
	returns True if we are at end of the stream

virtual Storage_Error	EndReadTypeSection ()=0
	returns True if we are at end of the stream

virtual Storage_Error	BeginWriteRootSection ()=0
	returns True if we are at end of the stream

virtual void	SetRootSectionSize (const Standard_Integer aSize)=0
	returns True if we are at end of the stream

virtual void	WriteRoot (const TCollection_AsciiString &rootName, const Standard_Integer aRef, const TCollection_AsciiString &aType)=0
	returns True if we are at end of the stream

virtual Storage_Error	EndWriteRootSection ()=0
	returns True if we are at end of the stream

virtual Storage_Error	BeginReadRootSection ()=0
	returns True if we are at end of the stream

virtual Standard_Integer	RootSectionSize ()=0
	returns True if we are at end of the stream

virtual void	ReadRoot (TCollection_AsciiString &rootName, Standard_Integer &aRef, TCollection_AsciiString &aType)=0
	returns True if we are at end of the stream

virtual Storage_Error	EndReadRootSection ()=0
	returns True if we are at end of the stream

virtual Storage_Error	BeginWriteRefSection ()=0
	returns True if we are at end of the stream

virtual void	SetRefSectionSize (const Standard_Integer aSize)=0
	returns True if we are at end of the stream

virtual void	WriteReferenceType (const Standard_Integer reference, const Standard_Integer typeNum)=0
	returns True if we are at end of the stream

virtual Storage_Error	EndWriteRefSection ()=0
	returns True if we are at end of the stream

virtual Storage_Error	BeginReadRefSection ()=0
	returns True if we are at end of the stream

virtual Standard_Integer	RefSectionSize ()=0
	returns True if we are at end of the stream

virtual void	ReadReferenceType (Standard_Integer &reference, Standard_Integer &typeNum)=0
	returns True if we are at end of the stream

virtual Storage_Error	EndReadRefSection ()=0
	returns True if we are at end of the stream

virtual Storage_Error	BeginWriteDataSection ()=0
	returns True if we are at end of the stream

virtual void	WritePersistentObjectHeader (const Standard_Integer aRef, const Standard_Integer aType)=0
	returns True if we are at end of the stream

virtual void	BeginWritePersistentObjectData ()=0
	returns True if we are at end of the stream

virtual void	BeginWriteObjectData ()=0
	returns True if we are at end of the stream

virtual void	EndWriteObjectData ()=0
	returns True if we are at end of the stream

virtual void	EndWritePersistentObjectData ()=0
	returns True if we are at end of the stream

virtual Storage_Error	EndWriteDataSection ()=0
	returns True if we are at end of the stream

virtual Storage_Error	BeginReadDataSection ()=0
	returns True if we are at end of the stream

virtual void	ReadPersistentObjectHeader (Standard_Integer &aRef, Standard_Integer &aType)=0
	returns True if we are at end of the stream

virtual void	BeginReadPersistentObjectData ()=0
	returns True if we are at end of the stream

virtual void	BeginReadObjectData ()=0
	returns True if we are at end of the stream

virtual void	EndReadObjectData ()=0
	returns True if we are at end of the stream

virtual void	EndReadPersistentObjectData ()=0
	returns True if we are at end of the stream

virtual Storage_Error	EndReadDataSection ()=0
	returns True if we are at end of the stream

virtual void	SkipObject ()=0
	returns True if we are at end of the stream

virtual Storage_Error	Close ()=0
	returns True if we are at end of the stream

Output methods
virtual Storage_BaseDriver &	PutReference (const Standard_Integer aValue)=0

virtual Storage_BaseDriver &	PutCharacter (const Standard_Character aValue)=0

Storage_BaseDriver &	operator<< (const Standard_Character aValue)

virtual Storage_BaseDriver &	PutExtCharacter (const Standard_ExtCharacter aValue)=0

Storage_BaseDriver &	operator<< (const Standard_ExtCharacter aValue)

virtual Storage_BaseDriver &	PutInteger (const Standard_Integer aValue)=0

Storage_BaseDriver &	operator<< (const Standard_Integer aValue)

virtual Storage_BaseDriver &	PutBoolean (const Standard_Boolean aValue)=0

Storage_BaseDriver &	operator<< (const Standard_Boolean aValue)

virtual Storage_BaseDriver &	PutReal (const Standard_Real aValue)=0

Storage_BaseDriver &	operator<< (const Standard_Real aValue)

virtual Storage_BaseDriver &	PutShortReal (const Standard_ShortReal aValue)=0

Storage_BaseDriver &	operator<< (const Standard_ShortReal aValue)

Public Member Functions inherited from Standard_Transient
	Standard_Transient ()
	Empty constructor.

	Standard_Transient (const Standard_Transient &)
	Copy constructor – does nothing.

Standard_Transient &	operator= (const Standard_Transient &)
	Assignment operator, needed to avoid copying reference counter.

virtual	~Standard_Transient ()
	Destructor must be virtual.

virtual const opencascade::handle< Standard_Type > &	DynamicType () const
	Returns a type descriptor about this object.

Standard_Boolean	IsInstance (const opencascade::handle< Standard_Type > &theType) const
	Returns a true value if this is an instance of Type.

Standard_Boolean	IsInstance (const Standard_CString theTypeName) const
	Returns a true value if this is an instance of TypeName.

Standard_Boolean	IsKind (const opencascade::handle< Standard_Type > &theType) const
	Returns true if this is an instance of Type or an instance of any class that inherits from Type. Note that multiple inheritance is not supported by OCCT RTTI mechanism.

Standard_Boolean	IsKind (const Standard_CString theTypeName) const
	Returns true if this is an instance of TypeName or an instance of any class that inherits from TypeName. Note that multiple inheritance is not supported by OCCT RTTI mechanism.

Standard_Transient *	This () const
	Returns non-const pointer to this object (like const_cast). For protection against creating handle to objects allocated in stack or call from constructor, it will raise exception Standard_ProgramError if reference counter is zero.

Standard_Integer	GetRefCount () const noexcept
	Get the reference counter of this object.

void	IncrementRefCounter () noexcept
	Increments the reference counter of this object.

Standard_Integer	DecrementRefCounter () noexcept
	Decrements the reference counter of this object; returns the decremented value.

virtual void	Delete () const
	Memory deallocator for transient classes.

Static Public Member Functions
static TCollection_AsciiString	ReadMagicNumber (Standard_IStream &theIStream)

Static Public Member Functions inherited from Standard_Transient
static constexpr const char *	get_type_name ()
	Returns a type descriptor about this object.

static const opencascade::handle< Standard_Type > &	get_type_descriptor ()
	Returns type descriptor of Standard_Transient class.

Input methods
virtual Storage_BaseDriver &	GetReference (Standard_Integer &aValue)=0

virtual Storage_BaseDriver &	GetCharacter (Standard_Character &aValue)=0

Storage_BaseDriver &	operator>> (Standard_Character &aValue)

virtual Storage_BaseDriver &	GetExtCharacter (Standard_ExtCharacter &aValue)=0

Storage_BaseDriver &	operator>> (Standard_ExtCharacter &aValue)

virtual Storage_BaseDriver &	GetInteger (Standard_Integer &aValue)=0

Storage_BaseDriver &	operator>> (Standard_Integer &aValue)

virtual Storage_BaseDriver &	GetBoolean (Standard_Boolean &aValue)=0

Storage_BaseDriver &	operator>> (Standard_Boolean &aValue)

virtual Storage_BaseDriver &	GetReal (Standard_Real &aValue)=0

Storage_BaseDriver &	operator>> (Standard_Real &aValue)

virtual Storage_BaseDriver &	GetShortReal (Standard_ShortReal &aValue)=0

Storage_BaseDriver &	operator>> (Standard_ShortReal &aValue)

	Storage_BaseDriver ()

void	SetName (const TCollection_AsciiString &aName)

void	SetOpenMode (const Storage_OpenMode aMode)

Additional Inherited Members
Public Types inherited from Standard_Transient
typedef void	base_type
	Returns a type descriptor about this object.

Detailed Description

Root class for drivers. A driver assigns a physical container to data to be stored or retrieved, for instance a file. The FSD package provides two derived concrete classes :

FSD_File is a general driver which defines a file as the container of data.

Constructor & Destructor Documentation

◆ ~Storage_BaseDriver()

virtual Storage_BaseDriver::~Storage_BaseDriver ( )

virtual

◆ Storage_BaseDriver()

Storage_BaseDriver::Storage_BaseDriver ( )

protected

Member Function Documentation

◆ BeginReadCommentSection()

virtual Storage_Error Storage_BaseDriver::BeginReadCommentSection ( )

pure virtual

returns True if we are at end of the stream

Implemented in FSD_BinaryFile, and FSD_File.

◆ BeginReadDataSection()

virtual Storage_Error Storage_BaseDriver::BeginReadDataSection ( )

pure virtual

returns True if we are at end of the stream

Implemented in FSD_BinaryFile, and FSD_File.

◆ BeginReadInfoSection()

virtual Storage_Error Storage_BaseDriver::BeginReadInfoSection ( )

pure virtual

returns True if we are at end of the stream

Implemented in FSD_BinaryFile, FSD_CmpFile, and FSD_File.

◆ BeginReadObjectData()

virtual void Storage_BaseDriver::BeginReadObjectData ( )

pure virtual

returns True if we are at end of the stream

Implemented in FSD_BinaryFile, FSD_CmpFile, and FSD_File.

◆ BeginReadPersistentObjectData()

virtual void Storage_BaseDriver::BeginReadPersistentObjectData ( )

pure virtual

returns True if we are at end of the stream

Implemented in FSD_BinaryFile, FSD_CmpFile, and FSD_File.

◆ BeginReadRefSection()

virtual Storage_Error Storage_BaseDriver::BeginReadRefSection ( )

pure virtual

returns True if we are at end of the stream

Implemented in FSD_BinaryFile, and FSD_File.

◆ BeginReadRootSection()

virtual Storage_Error Storage_BaseDriver::BeginReadRootSection ( )

pure virtual

returns True if we are at end of the stream

Implemented in FSD_BinaryFile, and FSD_File.

◆ BeginReadTypeSection()

virtual Storage_Error Storage_BaseDriver::BeginReadTypeSection ( )

pure virtual

returns True if we are at end of the stream

Implemented in FSD_BinaryFile, and FSD_File.

◆ BeginWriteCommentSection()

virtual Storage_Error Storage_BaseDriver::BeginWriteCommentSection ( )

pure virtual

returns True if we are at end of the stream

Implemented in FSD_BinaryFile, and FSD_File.

◆ BeginWriteDataSection()

virtual Storage_Error Storage_BaseDriver::BeginWriteDataSection ( )

pure virtual

returns True if we are at end of the stream

Implemented in FSD_BinaryFile, and FSD_File.

◆ BeginWriteInfoSection()

virtual Storage_Error Storage_BaseDriver::BeginWriteInfoSection ( )

pure virtual

returns True if we are at end of the stream

Implemented in FSD_BinaryFile, FSD_CmpFile, and FSD_File.

◆ BeginWriteObjectData()

virtual void Storage_BaseDriver::BeginWriteObjectData ( )

pure virtual

returns True if we are at end of the stream

Implemented in FSD_BinaryFile, FSD_CmpFile, and FSD_File.

◆ BeginWritePersistentObjectData()

virtual void Storage_BaseDriver::BeginWritePersistentObjectData ( )

pure virtual

returns True if we are at end of the stream

Implemented in FSD_BinaryFile, FSD_CmpFile, and FSD_File.

◆ BeginWriteRefSection()

virtual Storage_Error Storage_BaseDriver::BeginWriteRefSection ( )

pure virtual

returns True if we are at end of the stream

Implemented in FSD_BinaryFile, and FSD_File.

◆ BeginWriteRootSection()

virtual Storage_Error Storage_BaseDriver::BeginWriteRootSection ( )

pure virtual

returns True if we are at end of the stream

Implemented in FSD_BinaryFile, and FSD_File.

◆ BeginWriteTypeSection()

virtual Storage_Error Storage_BaseDriver::BeginWriteTypeSection ( )

pure virtual

returns True if we are at end of the stream

Implemented in FSD_BinaryFile, and FSD_File.

◆ Close()

virtual Storage_Error Storage_BaseDriver::Close ( )

pure virtual

returns True if we are at end of the stream

Implemented in FSD_BinaryFile, and FSD_File.

◆ EndReadCommentSection()

virtual Storage_Error Storage_BaseDriver::EndReadCommentSection ( )

pure virtual

returns True if we are at end of the stream

Implemented in FSD_BinaryFile, and FSD_File.

◆ EndReadDataSection()

virtual Storage_Error Storage_BaseDriver::EndReadDataSection ( )

pure virtual

returns True if we are at end of the stream

Implemented in FSD_BinaryFile, and FSD_File.

◆ EndReadInfoSection()

virtual Storage_Error Storage_BaseDriver::EndReadInfoSection ( )

pure virtual

returns True if we are at end of the stream

Implemented in FSD_BinaryFile, and FSD_File.

◆ EndReadObjectData()

virtual void Storage_BaseDriver::EndReadObjectData ( )

pure virtual

returns True if we are at end of the stream

Implemented in FSD_BinaryFile, FSD_CmpFile, and FSD_File.

◆ EndReadPersistentObjectData()

virtual void Storage_BaseDriver::EndReadPersistentObjectData ( )

pure virtual

returns True if we are at end of the stream

Implemented in FSD_BinaryFile, FSD_CmpFile, and FSD_File.

◆ EndReadRefSection()

virtual Storage_Error Storage_BaseDriver::EndReadRefSection ( )

pure virtual

returns True if we are at end of the stream

Implemented in FSD_BinaryFile, and FSD_File.

◆ EndReadRootSection()

virtual Storage_Error Storage_BaseDriver::EndReadRootSection ( )

pure virtual

returns True if we are at end of the stream

Implemented in FSD_BinaryFile, and FSD_File.

◆ EndReadTypeSection()

virtual Storage_Error Storage_BaseDriver::EndReadTypeSection ( )

pure virtual

returns True if we are at end of the stream

Implemented in FSD_BinaryFile, and FSD_File.

◆ EndWriteCommentSection()

virtual Storage_Error Storage_BaseDriver::EndWriteCommentSection ( )

pure virtual

returns True if we are at end of the stream

Implemented in FSD_BinaryFile, and FSD_File.

◆ EndWriteDataSection()

virtual Storage_Error Storage_BaseDriver::EndWriteDataSection ( )

pure virtual

returns True if we are at end of the stream

Implemented in FSD_BinaryFile, and FSD_File.

◆ EndWriteInfoSection()

virtual Storage_Error Storage_BaseDriver::EndWriteInfoSection ( )

pure virtual

returns True if we are at end of the stream

Implemented in FSD_BinaryFile, and FSD_File.

◆ EndWriteObjectData()

virtual void Storage_BaseDriver::EndWriteObjectData ( )

pure virtual

returns True if we are at end of the stream

Implemented in FSD_BinaryFile, FSD_CmpFile, and FSD_File.

◆ EndWritePersistentObjectData()

virtual void Storage_BaseDriver::EndWritePersistentObjectData ( )

pure virtual

returns True if we are at end of the stream

Implemented in FSD_BinaryFile, FSD_CmpFile, and FSD_File.

◆ EndWriteRefSection()

virtual Storage_Error Storage_BaseDriver::EndWriteRefSection ( )

pure virtual

returns True if we are at end of the stream

Implemented in FSD_BinaryFile, and FSD_File.

◆ EndWriteRootSection()

virtual Storage_Error Storage_BaseDriver::EndWriteRootSection ( )

pure virtual

returns True if we are at end of the stream

Implemented in FSD_BinaryFile, and FSD_File.

◆ EndWriteTypeSection()

virtual Storage_Error Storage_BaseDriver::EndWriteTypeSection ( )

pure virtual

returns True if we are at end of the stream

Implemented in FSD_BinaryFile, and FSD_File.

◆ GetBoolean()

virtual Storage_BaseDriver & Storage_BaseDriver::GetBoolean ( Standard_Boolean & aValue )

pure virtual

Implemented in FSD_BinaryFile, and FSD_File.

◆ GetCharacter()

virtual Storage_BaseDriver & Storage_BaseDriver::GetCharacter ( Standard_Character & aValue )

pure virtual

Implemented in FSD_BinaryFile, and FSD_File.

◆ GetExtCharacter()

virtual Storage_BaseDriver & Storage_BaseDriver::GetExtCharacter ( Standard_ExtCharacter & aValue )

pure virtual

Implemented in FSD_BinaryFile, and FSD_File.

◆ GetInteger()

virtual Storage_BaseDriver & Storage_BaseDriver::GetInteger ( Standard_Integer & aValue )

pure virtual

Implemented in FSD_BinaryFile, and FSD_File.

◆ GetReal()

virtual Storage_BaseDriver & Storage_BaseDriver::GetReal ( Standard_Real & aValue )

pure virtual

Implemented in FSD_BinaryFile, and FSD_File.

◆ GetReference()

virtual Storage_BaseDriver & Storage_BaseDriver::GetReference ( Standard_Integer & aValue )

pure virtual

Implemented in FSD_BinaryFile, and FSD_File.

◆ GetShortReal()

virtual Storage_BaseDriver & Storage_BaseDriver::GetShortReal ( Standard_ShortReal & aValue )

pure virtual

Implemented in FSD_BinaryFile, and FSD_File.

◆ IsEnd()

virtual Standard_Boolean Storage_BaseDriver::IsEnd ( )

pure virtual

returns True if we are at end of the stream

Implemented in FSD_BinaryFile, and FSD_File.

◆ Name()

TCollection_AsciiString Storage_BaseDriver::Name ( ) const

inline

◆ Open()

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

pure virtual

returns True if we are at end of the stream

Implemented in FSD_BinaryFile, FSD_CmpFile, and FSD_File.

◆ OpenMode()

Storage_OpenMode Storage_BaseDriver::OpenMode ( ) const

inline

◆ operator<<() [1/6]

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

inline

◆ operator<<() [2/6]

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

inline

◆ operator<<() [3/6]

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

inline

◆ operator<<() [4/6]

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

inline

◆ operator<<() [5/6]

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

inline

◆ operator<<() [6/6]

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

inline

◆ operator>>() [1/6]

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

inline

◆ operator>>() [2/6]

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

inline

◆ operator>>() [3/6]

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

inline

◆ operator>>() [4/6]

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

inline

◆ operator>>() [5/6]

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

inline

◆ operator>>() [6/6]

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

inline

◆ PutBoolean()

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

pure virtual

Implemented in FSD_BinaryFile, and FSD_File.

◆ PutCharacter()

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

pure virtual

Implemented in FSD_BinaryFile, and FSD_File.

◆ PutExtCharacter()

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

pure virtual

Implemented in FSD_BinaryFile, and FSD_File.

◆ PutInteger()

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

pure virtual

Implemented in FSD_BinaryFile, and FSD_File.

◆ PutReal()

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

pure virtual

Implemented in FSD_BinaryFile, and FSD_File.

◆ PutReference()

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

pure virtual

Implemented in FSD_BinaryFile, and FSD_File.

◆ PutShortReal()

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

pure virtual

Implemented in FSD_BinaryFile, and FSD_File.

◆ ReadComment()

virtual void Storage_BaseDriver::ReadComment ( TColStd_SequenceOfExtendedString & userComments )

pure virtual

returns True if we are at end of the stream

Implemented in FSD_BinaryFile, and FSD_File.

◆ ReadCompleteInfo()

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

pure virtual

returns True if we are at end of the stream

Implemented in FSD_BinaryFile, and FSD_File.

◆ ReadInfo()

virtual void Storage_BaseDriver::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
	)

pure virtual

returns True if we are at end of the stream

Implemented in FSD_BinaryFile, and FSD_File.

◆ ReadMagicNumber()

static TCollection_AsciiString Storage_BaseDriver::ReadMagicNumber ( Standard_IStream & theIStream )

static

◆ ReadPersistentObjectHeader()

virtual void Storage_BaseDriver::ReadPersistentObjectHeader	(	Standard_Integer &	aRef,
		Standard_Integer &	aType
	)

pure virtual

returns True if we are at end of the stream

Implemented in FSD_BinaryFile, FSD_CmpFile, and FSD_File.

◆ ReadReferenceType()

virtual void Storage_BaseDriver::ReadReferenceType	(	Standard_Integer &	reference,
		Standard_Integer &	typeNum
	)

pure virtual

returns True if we are at end of the stream

Implemented in FSD_BinaryFile, and FSD_File.

◆ ReadRoot()

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

pure virtual

returns True if we are at end of the stream

Implemented in FSD_BinaryFile, and FSD_File.

◆ ReadTypeInformations()

virtual void Storage_BaseDriver::ReadTypeInformations	(	Standard_Integer &	typeNum,
		TCollection_AsciiString &	typeName
	)

pure virtual

returns True if we are at end of the stream

Implemented in FSD_BinaryFile, and FSD_File.

◆ RefSectionSize()

virtual Standard_Integer Storage_BaseDriver::RefSectionSize ( )

pure virtual

returns True if we are at end of the stream

Implemented in FSD_BinaryFile, and FSD_File.

◆ RootSectionSize()

virtual Standard_Integer Storage_BaseDriver::RootSectionSize ( )

pure virtual

returns True if we are at end of the stream

Implemented in FSD_BinaryFile, and FSD_File.

◆ SetName()

void Storage_BaseDriver::SetName ( const TCollection_AsciiString & aName )

inlineprotected

◆ SetOpenMode()

void Storage_BaseDriver::SetOpenMode ( const Storage_OpenMode aMode )

inlineprotected

◆ SetRefSectionSize()

virtual void Storage_BaseDriver::SetRefSectionSize ( const Standard_Integer aSize )

pure virtual

returns True if we are at end of the stream

Implemented in FSD_BinaryFile, and FSD_File.

◆ SetRootSectionSize()

virtual void Storage_BaseDriver::SetRootSectionSize ( const Standard_Integer aSize )

pure virtual

returns True if we are at end of the stream

Implemented in FSD_BinaryFile, and FSD_File.

◆ SetTypeSectionSize()

virtual void Storage_BaseDriver::SetTypeSectionSize ( const Standard_Integer aSize )

pure virtual

returns True if we are at end of the stream

Implemented in FSD_BinaryFile, and FSD_File.

◆ SkipObject()

virtual void Storage_BaseDriver::SkipObject ( )

pure virtual

returns True if we are at end of the stream

Implemented in FSD_BinaryFile, and FSD_File.

◆ Tell()

virtual Storage_Position Storage_BaseDriver::Tell ( )

pure virtual

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

Implemented in FSD_BinaryFile, and FSD_File.

◆ TypeSectionSize()

virtual Standard_Integer Storage_BaseDriver::TypeSectionSize ( )

pure virtual

returns True if we are at end of the stream

Implemented in FSD_BinaryFile, and FSD_File.

◆ WriteComment()

virtual void Storage_BaseDriver::WriteComment ( const TColStd_SequenceOfExtendedString & userComments )

pure virtual

returns True if we are at end of the stream

Implemented in FSD_BinaryFile, and FSD_File.

◆ WriteInfo()

virtual void Storage_BaseDriver::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
	)

pure virtual

returns True if we are at end of the stream

Implemented in FSD_BinaryFile, and FSD_File.

◆ WritePersistentObjectHeader()

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

pure virtual

returns True if we are at end of the stream

Implemented in FSD_BinaryFile, FSD_CmpFile, and FSD_File.

◆ WriteReferenceType()

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

pure virtual

returns True if we are at end of the stream

Implemented in FSD_BinaryFile, and FSD_File.

◆ WriteRoot()

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

pure virtual

returns True if we are at end of the stream

Implemented in FSD_BinaryFile, and FSD_File.

◆ WriteTypeInformations()

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

pure virtual

returns True if we are at end of the stream

Implemented in FSD_BinaryFile, and FSD_File.

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

Storage_BaseDriver.hxx

Public Member Functions

Static Public Member Functions

Input methods

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ~Storage_BaseDriver()

◆ Storage_BaseDriver()

Member Function Documentation

◆ BeginReadCommentSection()

◆ BeginReadDataSection()

◆ BeginReadInfoSection()

◆ BeginReadObjectData()

◆ BeginReadPersistentObjectData()

◆ BeginReadRefSection()

◆ BeginReadRootSection()

◆ BeginReadTypeSection()

◆ BeginWriteCommentSection()

◆ BeginWriteDataSection()

◆ BeginWriteInfoSection()

◆ BeginWriteObjectData()

◆ BeginWritePersistentObjectData()

◆ BeginWriteRefSection()

◆ BeginWriteRootSection()

◆ BeginWriteTypeSection()

◆ Close()

◆ EndReadCommentSection()

◆ EndReadDataSection()

◆ EndReadInfoSection()

◆ EndReadObjectData()

◆ EndReadPersistentObjectData()

◆ EndReadRefSection()

◆ EndReadRootSection()

◆ EndReadTypeSection()

◆ EndWriteCommentSection()

◆ EndWriteDataSection()

◆ EndWriteInfoSection()

◆ EndWriteObjectData()

◆ EndWritePersistentObjectData()

◆ EndWriteRefSection()

◆ EndWriteRootSection()

◆ EndWriteTypeSection()

◆ GetBoolean()

◆ GetCharacter()

◆ GetExtCharacter()

◆ GetInteger()

◆ GetReal()

◆ GetReference()

◆ GetShortReal()

◆ IsEnd()

◆ Name()

◆ Open()

◆ OpenMode()

◆ operator<<() [1/6]

◆ operator<<() [2/6]

◆ operator<<() [3/6]

◆ operator<<() [4/6]

◆ operator<<() [5/6]

◆ operator<<() [6/6]

◆ operator>>() [1/6]

◆ operator>>() [2/6]

◆ operator>>() [3/6]

◆ operator>>() [4/6]

◆ operator>>() [5/6]

◆ operator>>() [6/6]

◆ PutBoolean()

◆ PutCharacter()

◆ PutExtCharacter()

◆ PutInteger()

◆ PutReal()

◆ PutReference()

◆ PutShortReal()

◆ ReadComment()

◆ ReadCompleteInfo()

◆ ReadInfo()

◆ ReadMagicNumber()

◆ ReadPersistentObjectHeader()

◆ ReadReferenceType()

◆ ReadRoot()

◆ ReadTypeInformations()