Open CASCADE Technology  7.7.0.dev
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes

FSD_File Class Reference

A general driver which defines as a file, the physical container for data to be stored or retrieved. More...

#include <FSD_File.hxx>

Inheritance diagram for FSD_File:
Inheritance graph
[legend]

Public Member Functions

 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 Storage_Error Open (const TCollection_AsciiString &aName, const Storage_OpenMode aMode) override
 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...
 
virtual Standard_Boolean IsEnd () override
 returns True if we are at end of the stream More...
 
virtual Storage_Position Tell () override
 return position in the file. Return -1 upon error. More...
 
virtual Storage_Error BeginWriteInfoSection () override
 returns True if we are at end of the stream 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) override
 returns True if we are at end of the stream More...
 
virtual Storage_Error EndWriteInfoSection () override
 returns True if we are at end of the stream More...
 
virtual Storage_Error BeginReadInfoSection () override
 returns True if we are at end of the stream More...
 
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) override
 returns True if we are at end of the stream More...
 
virtual void ReadCompleteInfo (Standard_IStream &theIStream, Handle< Storage_Data > &theData) override
 returns True if we are at end of the stream More...
 
virtual Storage_Error EndReadInfoSection () override
 returns True if we are at end of the stream More...
 
virtual Storage_Error BeginWriteCommentSection () override
 returns True if we are at end of the stream More...
 
virtual void WriteComment (const TColStd_SequenceOfExtendedString &userComments) override
 returns True if we are at end of the stream More...
 
virtual Storage_Error EndWriteCommentSection () override
 returns True if we are at end of the stream More...
 
virtual Storage_Error BeginReadCommentSection () override
 returns True if we are at end of the stream More...
 
virtual void ReadComment (TColStd_SequenceOfExtendedString &userComments) override
 returns True if we are at end of the stream More...
 
virtual Storage_Error EndReadCommentSection () override
 returns True if we are at end of the stream More...
 
virtual Storage_Error BeginWriteTypeSection () override
 returns True if we are at end of the stream More...
 
virtual void SetTypeSectionSize (const Standard_Integer aSize) override
 returns True if we are at end of the stream More...
 
virtual void WriteTypeInformations (const Standard_Integer typeNum, const TCollection_AsciiString &typeName) override
 returns True if we are at end of the stream More...
 
virtual Storage_Error EndWriteTypeSection () override
 returns True if we are at end of the stream More...
 
virtual Storage_Error BeginReadTypeSection () override
 returns True if we are at end of the stream More...
 
virtual Standard_Integer TypeSectionSize () override
 returns True if we are at end of the stream More...
 
virtual void ReadTypeInformations (Standard_Integer &typeNum, TCollection_AsciiString &typeName) override
 returns True if we are at end of the stream More...
 
virtual Storage_Error EndReadTypeSection () override
 returns True if we are at end of the stream More...
 
virtual Storage_Error BeginWriteRootSection () override
 returns True if we are at end of the stream More...
 
virtual void SetRootSectionSize (const Standard_Integer aSize) override
 returns True if we are at end of the stream More...
 
virtual void WriteRoot (const TCollection_AsciiString &rootName, const Standard_Integer aRef, const TCollection_AsciiString &aType) override
 returns True if we are at end of the stream More...
 
virtual Storage_Error EndWriteRootSection () override
 returns True if we are at end of the stream More...
 
virtual Storage_Error BeginReadRootSection () override
 returns True if we are at end of the stream More...
 
virtual Standard_Integer RootSectionSize () override
 returns True if we are at end of the stream More...
 
virtual void ReadRoot (TCollection_AsciiString &rootName, Standard_Integer &aRef, TCollection_AsciiString &aType) override
 returns True if we are at end of the stream More...
 
virtual Storage_Error EndReadRootSection () override
 returns True if we are at end of the stream More...
 
virtual Storage_Error BeginWriteRefSection () override
 returns True if we are at end of the stream More...
 
virtual void SetRefSectionSize (const Standard_Integer aSize) override
 returns True if we are at end of the stream More...
 
virtual void WriteReferenceType (const Standard_Integer reference, const Standard_Integer typeNum) override
 returns True if we are at end of the stream More...
 
virtual Storage_Error EndWriteRefSection () override
 returns True if we are at end of the stream More...
 
virtual Storage_Error BeginReadRefSection () override
 returns True if we are at end of the stream More...
 
virtual Standard_Integer RefSectionSize () override
 returns True if we are at end of the stream More...
 
virtual void ReadReferenceType (Standard_Integer &reference, Standard_Integer &typeNum) override
 returns True if we are at end of the stream More...
 
virtual Storage_Error EndReadRefSection () override
 returns True if we are at end of the stream More...
 
virtual Storage_Error BeginWriteDataSection () override
 returns True if we are at end of the stream More...
 
virtual void WritePersistentObjectHeader (const Standard_Integer aRef, const Standard_Integer aType) override
 returns True if we are at end of the stream More...
 
virtual void BeginWritePersistentObjectData () override
 returns True if we are at end of the stream More...
 
virtual void BeginWriteObjectData () override
 returns True if we are at end of the stream More...
 
virtual void EndWriteObjectData () override
 returns True if we are at end of the stream More...
 
virtual void EndWritePersistentObjectData () override
 returns True if we are at end of the stream More...
 
virtual Storage_Error EndWriteDataSection () override
 returns True if we are at end of the stream More...
 
virtual Storage_Error BeginReadDataSection () override
 returns True if we are at end of the stream More...
 
virtual void ReadPersistentObjectHeader (Standard_Integer &aRef, Standard_Integer &aType) override
 returns True if we are at end of the stream More...
 
virtual void BeginReadPersistentObjectData () override
 returns True if we are at end of the stream More...
 
virtual void BeginReadObjectData () override
 returns True if we are at end of the stream More...
 
virtual void EndReadObjectData () override
 returns True if we are at end of the stream More...
 
virtual void EndReadPersistentObjectData () override
 returns True if we are at end of the stream More...
 
virtual Storage_Error EndReadDataSection () override
 returns True if we are at end of the stream More...
 
virtual void SkipObject () override
 returns True if we are at end of the stream More...
 
virtual Storage_BaseDriverPutReference (const Standard_Integer aValue) override
 
virtual Storage_BaseDriverPutCharacter (const Standard_Character aValue) override
 
virtual Storage_BaseDriverPutExtCharacter (const Standard_ExtCharacter aValue) override
 
virtual Storage_BaseDriverPutInteger (const Standard_Integer aValue) override
 
virtual Storage_BaseDriverPutBoolean (const Standard_Boolean aValue) override
 
virtual Storage_BaseDriverPutReal (const Standard_Real aValue) override
 
virtual Storage_BaseDriverPutShortReal (const Standard_ShortReal aValue) override
 
virtual Storage_BaseDriverGetReference (Standard_Integer &aValue) override
 
virtual Storage_BaseDriverGetCharacter (Standard_Character &aValue) override
 
virtual Storage_BaseDriverGetExtCharacter (Standard_ExtCharacter &aValue) override
 
virtual Storage_BaseDriverGetInteger (Standard_Integer &aValue) override
 
virtual Storage_BaseDriverGetBoolean (Standard_Boolean &aValue) override
 
virtual Storage_BaseDriverGetReal (Standard_Real &aValue) override
 
virtual Storage_BaseDriverGetShortReal (Standard_ShortReal &aValue) override
 
virtual Storage_Error Close () override
 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)
 
- Public Member Functions inherited from Standard_Transient
 Standard_Transient ()
 Empty constructor. More...
 
 Standard_Transient (const Standard_Transient &)
 Copy constructor – does nothing. More...
 
Standard_Transientoperator= (const Standard_Transient &)
 Assignment operator, needed to avoid copying reference counter. More...
 
virtual ~Standard_Transient ()
 Destructor must be virtual. More...
 
virtual void Delete () const
 Memory deallocator for transient classes. More...
 
virtual const opencascade::handle< Standard_Type > & DynamicType () const
 Returns a type descriptor about this object. More...
 
Standard_Boolean IsInstance (const opencascade::handle< Standard_Type > &theType) const
 Returns a true value if this is an instance of Type. More...
 
Standard_Boolean IsInstance (const Standard_CString theTypeName) const
 Returns a true value if this is an instance of TypeName. More...
 
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. More...
 
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. More...
 
Standard_TransientThis () 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. More...
 
Standard_Integer GetRefCount () const
 Get the reference counter of this object. More...
 
void IncrementRefCounter () const
 Increments the reference counter of this object. More...
 
Standard_Integer DecrementRefCounter () const
 Decrements the reference counter of this object; returns the decremented value. More...
 

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)
 
- Static Public Member Functions inherited from Standard_Transient
static const char * get_type_name ()
 Returns a type descriptor about this object. More...
 
static const opencascade::handle< Standard_Type > & get_type_descriptor ()
 Returns type descriptor of Standard_Transient class. More...
 

Protected Member Functions

virtual void ReadLine (TCollection_AsciiString &buffer)
 read from the current position to the end of line. More...
 
virtual void ReadWord (TCollection_AsciiString &buffer)
 read from the current position to the next white space or end of line. More...
 
virtual void ReadExtendedLine (TCollection_ExtendedString &buffer)
 read extended chars (unicode) from the current position to the end of line. More...
 
virtual void WriteExtendedLine (const TCollection_ExtendedString &buffer)
 write from the current position to the end of line. More...
 
virtual void ReadChar (TCollection_AsciiString &buffer, const Standard_Size rsize)
 read <rsize> character from the current position. More...
 
virtual void ReadString (TCollection_AsciiString &buffer)
 read from the first none space character position to the end of line. 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)
 

Protected Attributes

FSD_FStream myStream
 

Additional Inherited Members

- Public Types inherited from Standard_Transient
typedef void base_type
 Returns a type descriptor about this object. More...
 

Detailed Description

A general driver which defines as a file, the physical container for data to be stored or retrieved.

Constructor & Destructor Documentation

◆ FSD_File()

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.

◆ ~FSD_File()

FSD_File::~FSD_File ( )
inline

Member Function Documentation

◆ BeginReadCommentSection()

virtual Storage_Error FSD_File::BeginReadCommentSection ( )
overridevirtual

returns True if we are at end of the stream

Implements Storage_BaseDriver.

◆ BeginReadDataSection()

virtual Storage_Error FSD_File::BeginReadDataSection ( )
overridevirtual

returns True if we are at end of the stream

Implements Storage_BaseDriver.

◆ BeginReadInfoSection()

virtual Storage_Error FSD_File::BeginReadInfoSection ( )
overridevirtual

returns True if we are at end of the stream

Implements Storage_BaseDriver.

Reimplemented in FSD_CmpFile.

◆ BeginReadObjectData()

virtual void FSD_File::BeginReadObjectData ( )
overridevirtual

returns True if we are at end of the stream

Implements Storage_BaseDriver.

Reimplemented in FSD_CmpFile.

◆ BeginReadPersistentObjectData()

virtual void FSD_File::BeginReadPersistentObjectData ( )
overridevirtual

returns True if we are at end of the stream

Implements Storage_BaseDriver.

Reimplemented in FSD_CmpFile.

◆ BeginReadRefSection()

virtual Storage_Error FSD_File::BeginReadRefSection ( )
overridevirtual

returns True if we are at end of the stream

Implements Storage_BaseDriver.

◆ BeginReadRootSection()

virtual Storage_Error FSD_File::BeginReadRootSection ( )
overridevirtual

returns True if we are at end of the stream

Implements Storage_BaseDriver.

◆ BeginReadTypeSection()

virtual Storage_Error FSD_File::BeginReadTypeSection ( )
overridevirtual

returns True if we are at end of the stream

Implements Storage_BaseDriver.

◆ BeginWriteCommentSection()

virtual Storage_Error FSD_File::BeginWriteCommentSection ( )
overridevirtual

returns True if we are at end of the stream

Implements Storage_BaseDriver.

◆ BeginWriteDataSection()

virtual Storage_Error FSD_File::BeginWriteDataSection ( )
overridevirtual

returns True if we are at end of the stream

Implements Storage_BaseDriver.

◆ BeginWriteInfoSection()

virtual Storage_Error FSD_File::BeginWriteInfoSection ( )
overridevirtual

returns True if we are at end of the stream

Implements Storage_BaseDriver.

Reimplemented in FSD_CmpFile.

◆ BeginWriteObjectData()

virtual void FSD_File::BeginWriteObjectData ( )
overridevirtual

returns True if we are at end of the stream

Implements Storage_BaseDriver.

Reimplemented in FSD_CmpFile.

◆ BeginWritePersistentObjectData()

virtual void FSD_File::BeginWritePersistentObjectData ( )
overridevirtual

returns True if we are at end of the stream

Implements Storage_BaseDriver.

Reimplemented in FSD_CmpFile.

◆ BeginWriteRefSection()

virtual Storage_Error FSD_File::BeginWriteRefSection ( )
overridevirtual

returns True if we are at end of the stream

Implements Storage_BaseDriver.

◆ BeginWriteRootSection()

virtual Storage_Error FSD_File::BeginWriteRootSection ( )
overridevirtual

returns True if we are at end of the stream

Implements Storage_BaseDriver.

◆ BeginWriteTypeSection()

virtual Storage_Error FSD_File::BeginWriteTypeSection ( )
overridevirtual

returns True if we are at end of the stream

Implements Storage_BaseDriver.

◆ Close()

virtual Storage_Error FSD_File::Close ( )
overridevirtual

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.

Implements Storage_BaseDriver.

◆ Destroy()

void FSD_File::Destroy ( )

◆ EndReadCommentSection()

virtual Storage_Error FSD_File::EndReadCommentSection ( )
overridevirtual

returns True if we are at end of the stream

Implements Storage_BaseDriver.

◆ EndReadDataSection()

virtual Storage_Error FSD_File::EndReadDataSection ( )
overridevirtual

returns True if we are at end of the stream

Implements Storage_BaseDriver.

◆ EndReadInfoSection()

virtual Storage_Error FSD_File::EndReadInfoSection ( )
overridevirtual

returns True if we are at end of the stream

Implements Storage_BaseDriver.

◆ EndReadObjectData()

virtual void FSD_File::EndReadObjectData ( )
overridevirtual

returns True if we are at end of the stream

Implements Storage_BaseDriver.

Reimplemented in FSD_CmpFile.

◆ EndReadPersistentObjectData()

virtual void FSD_File::EndReadPersistentObjectData ( )
overridevirtual

returns True if we are at end of the stream

Implements Storage_BaseDriver.

Reimplemented in FSD_CmpFile.

◆ EndReadRefSection()

virtual Storage_Error FSD_File::EndReadRefSection ( )
overridevirtual

returns True if we are at end of the stream

Implements Storage_BaseDriver.

◆ EndReadRootSection()

virtual Storage_Error FSD_File::EndReadRootSection ( )
overridevirtual

returns True if we are at end of the stream

Implements Storage_BaseDriver.

◆ EndReadTypeSection()

virtual Storage_Error FSD_File::EndReadTypeSection ( )
overridevirtual

returns True if we are at end of the stream

Implements Storage_BaseDriver.

◆ EndWriteCommentSection()

virtual Storage_Error FSD_File::EndWriteCommentSection ( )
overridevirtual

returns True if we are at end of the stream

Implements Storage_BaseDriver.

◆ EndWriteDataSection()

virtual Storage_Error FSD_File::EndWriteDataSection ( )
overridevirtual

returns True if we are at end of the stream

Implements Storage_BaseDriver.

◆ EndWriteInfoSection()

virtual Storage_Error FSD_File::EndWriteInfoSection ( )
overridevirtual

returns True if we are at end of the stream

Implements Storage_BaseDriver.

◆ EndWriteObjectData()

virtual void FSD_File::EndWriteObjectData ( )
overridevirtual

returns True if we are at end of the stream

Implements Storage_BaseDriver.

Reimplemented in FSD_CmpFile.

◆ EndWritePersistentObjectData()

virtual void FSD_File::EndWritePersistentObjectData ( )
overridevirtual

returns True if we are at end of the stream

Implements Storage_BaseDriver.

Reimplemented in FSD_CmpFile.

◆ EndWriteRefSection()

virtual Storage_Error FSD_File::EndWriteRefSection ( )
overridevirtual

returns True if we are at end of the stream

Implements Storage_BaseDriver.

◆ EndWriteRootSection()

virtual Storage_Error FSD_File::EndWriteRootSection ( )
overridevirtual

returns True if we are at end of the stream

Implements Storage_BaseDriver.

◆ EndWriteTypeSection()

virtual Storage_Error FSD_File::EndWriteTypeSection ( )
overridevirtual

returns True if we are at end of the stream

Implements Storage_BaseDriver.

◆ FindTag()

virtual Storage_Error FSD_File::FindTag ( const Standard_CString  aTag)
protectedvirtual

◆ FlushEndOfLine()

virtual void FSD_File::FlushEndOfLine ( )
protectedvirtual

◆ GetBoolean()

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

Implements Storage_BaseDriver.

◆ GetCharacter()

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

Implements Storage_BaseDriver.

◆ GetExtCharacter()

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

Implements Storage_BaseDriver.

◆ GetInteger()

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

Implements Storage_BaseDriver.

◆ GetReal()

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

Implements Storage_BaseDriver.

◆ GetReference()

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

Implements Storage_BaseDriver.

◆ GetShortReal()

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

Implements Storage_BaseDriver.

◆ IsEnd()

virtual Standard_Boolean FSD_File::IsEnd ( )
overridevirtual

returns True if we are at end of the stream

Implements Storage_BaseDriver.

◆ IsGoodFileType()

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

◆ MagicNumber()

static Standard_CString FSD_File::MagicNumber ( )
static

◆ Open()

virtual Storage_Error FSD_File::Open ( const TCollection_AsciiString aName,
const Storage_OpenMode  aMode 
)
overridevirtual

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.

Implements Storage_BaseDriver.

Reimplemented in FSD_CmpFile.

◆ PutBoolean()

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

Implements Storage_BaseDriver.

◆ PutCharacter()

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

Implements Storage_BaseDriver.

◆ PutExtCharacter()

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

Implements Storage_BaseDriver.

◆ PutInteger()

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

Implements Storage_BaseDriver.

◆ PutReal()

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

Implements Storage_BaseDriver.

◆ PutReference()

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

Implements Storage_BaseDriver.

◆ PutShortReal()

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

Implements Storage_BaseDriver.

◆ ReadChar()

virtual void FSD_File::ReadChar ( TCollection_AsciiString buffer,
const Standard_Size  rsize 
)
protectedvirtual

read <rsize> character from the current position.

◆ ReadComment()

virtual void FSD_File::ReadComment ( TColStd_SequenceOfExtendedString userComments)
overridevirtual

returns True if we are at end of the stream

Implements Storage_BaseDriver.

◆ ReadCompleteInfo()

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

returns True if we are at end of the stream

Implements Storage_BaseDriver.

◆ ReadExtendedLine()

virtual void FSD_File::ReadExtendedLine ( TCollection_ExtendedString buffer)
protectedvirtual

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

Reimplemented in FSD_CmpFile.

◆ ReadInfo()

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

returns True if we are at end of the stream

Implements Storage_BaseDriver.

◆ ReadLine()

virtual void FSD_File::ReadLine ( TCollection_AsciiString buffer)
protectedvirtual

read from the current position to the end of line.

Reimplemented in FSD_CmpFile.

◆ ReadPersistentObjectHeader()

virtual void FSD_File::ReadPersistentObjectHeader ( Standard_Integer aRef,
Standard_Integer aType 
)
overridevirtual

returns True if we are at end of the stream

Implements Storage_BaseDriver.

Reimplemented in FSD_CmpFile.

◆ ReadReferenceType()

virtual void FSD_File::ReadReferenceType ( Standard_Integer reference,
Standard_Integer typeNum 
)
overridevirtual

returns True if we are at end of the stream

Implements Storage_BaseDriver.

◆ ReadRoot()

virtual void FSD_File::ReadRoot ( TCollection_AsciiString rootName,
Standard_Integer aRef,
TCollection_AsciiString aType 
)
overridevirtual

returns True if we are at end of the stream

Implements Storage_BaseDriver.

◆ ReadString()

virtual void FSD_File::ReadString ( TCollection_AsciiString buffer)
protectedvirtual

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

Reimplemented in FSD_CmpFile.

◆ ReadTypeInformations()

virtual void FSD_File::ReadTypeInformations ( Standard_Integer typeNum,
TCollection_AsciiString typeName 
)
overridevirtual

returns True if we are at end of the stream

Implements Storage_BaseDriver.

◆ ReadWord()

virtual void FSD_File::ReadWord ( TCollection_AsciiString buffer)
protectedvirtual

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

◆ RefSectionSize()

virtual Standard_Integer FSD_File::RefSectionSize ( )
overridevirtual

returns True if we are at end of the stream

Implements Storage_BaseDriver.

◆ RootSectionSize()

virtual Standard_Integer FSD_File::RootSectionSize ( )
overridevirtual

returns True if we are at end of the stream

Implements Storage_BaseDriver.

◆ SetRefSectionSize()

virtual void FSD_File::SetRefSectionSize ( const Standard_Integer  aSize)
overridevirtual

returns True if we are at end of the stream

Implements Storage_BaseDriver.

◆ SetRootSectionSize()

virtual void FSD_File::SetRootSectionSize ( const Standard_Integer  aSize)
overridevirtual

returns True if we are at end of the stream

Implements Storage_BaseDriver.

◆ SetTypeSectionSize()

virtual void FSD_File::SetTypeSectionSize ( const Standard_Integer  aSize)
overridevirtual

returns True if we are at end of the stream

Implements Storage_BaseDriver.

◆ SkipObject()

virtual void FSD_File::SkipObject ( )
overridevirtual

returns True if we are at end of the stream

Implements Storage_BaseDriver.

◆ Tell()

virtual Storage_Position FSD_File::Tell ( )
overridevirtual

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

Implements Storage_BaseDriver.

◆ TypeSectionSize()

virtual Standard_Integer FSD_File::TypeSectionSize ( )
overridevirtual

returns True if we are at end of the stream

Implements Storage_BaseDriver.

◆ WriteComment()

virtual void FSD_File::WriteComment ( const TColStd_SequenceOfExtendedString userComments)
overridevirtual

returns True if we are at end of the stream

Implements Storage_BaseDriver.

◆ WriteExtendedLine()

virtual void FSD_File::WriteExtendedLine ( const TCollection_ExtendedString buffer)
protectedvirtual

write from the current position to the end of line.

Reimplemented in FSD_CmpFile.

◆ WriteInfo()

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

returns True if we are at end of the stream

Implements Storage_BaseDriver.

◆ WritePersistentObjectHeader()

virtual void FSD_File::WritePersistentObjectHeader ( const Standard_Integer  aRef,
const Standard_Integer  aType 
)
overridevirtual

returns True if we are at end of the stream

Implements Storage_BaseDriver.

Reimplemented in FSD_CmpFile.

◆ WriteReferenceType()

virtual void FSD_File::WriteReferenceType ( const Standard_Integer  reference,
const Standard_Integer  typeNum 
)
overridevirtual

returns True if we are at end of the stream

Implements Storage_BaseDriver.

◆ WriteRoot()

virtual void FSD_File::WriteRoot ( const TCollection_AsciiString rootName,
const Standard_Integer  aRef,
const TCollection_AsciiString aType 
)
overridevirtual

returns True if we are at end of the stream

Implements Storage_BaseDriver.

◆ WriteTypeInformations()

virtual void FSD_File::WriteTypeInformations ( const Standard_Integer  typeNum,
const TCollection_AsciiString typeName 
)
overridevirtual

returns True if we are at end of the stream

Implements Storage_BaseDriver.

Field Documentation

◆ myStream

FSD_FStream FSD_File::myStream
protected

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