Open CASCADE Technology  7.5.0
Public Member Functions | Static Public Member Functions | Protected Member Functions
FSD_CmpFile Class Reference

#include <FSD_CmpFile.hxx>

Inheritance diagram for FSD_CmpFile:
Inheritance graph
[legend]

Public Member Functions

 FSD_CmpFile ()
 
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...
 
Storage_Error BeginWriteInfoSection () override
 returns True if we are at end of the stream More...
 
Storage_Error BeginReadInfoSection () override
 returns True if we are at end of the stream More...
 
void WritePersistentObjectHeader (const Standard_Integer aRef, const Standard_Integer aType) override
 returns True if we are at end of the stream More...
 
void BeginWritePersistentObjectData () override
 returns True if we are at end of the stream More...
 
void BeginWriteObjectData () override
 returns True if we are at end of the stream More...
 
void EndWriteObjectData () override
 returns True if we are at end of the stream More...
 
void EndWritePersistentObjectData () override
 returns True if we are at end of the stream More...
 
void ReadPersistentObjectHeader (Standard_Integer &aRef, Standard_Integer &aType) override
 returns True if we are at end of the stream More...
 
void BeginReadPersistentObjectData () override
 returns True if we are at end of the stream More...
 
void BeginReadObjectData () override
 returns True if we are at end of the stream More...
 
void EndReadObjectData () override
 returns True if we are at end of the stream More...
 
void EndReadPersistentObjectData () override
 returns True if we are at end of the stream More...
 
void Destroy ()
 
 ~FSD_CmpFile ()
 
- Public Member Functions inherited from 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. 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 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 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 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 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 FSD_File
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

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

Additional Inherited Members

- Public Types inherited from Standard_Transient
typedef void base_type
 Returns a type descriptor about this object. More...
 
- Protected Attributes inherited from FSD_File
FSD_FStream myStream
 

Constructor & Destructor Documentation

◆ FSD_CmpFile()

FSD_CmpFile::FSD_CmpFile ( )

◆ ~FSD_CmpFile()

FSD_CmpFile::~FSD_CmpFile ( )
inline

Member Function Documentation

◆ BeginReadInfoSection()

Storage_Error FSD_CmpFile::BeginReadInfoSection ( )
overridevirtual

returns True if we are at end of the stream

Reimplemented from FSD_File.

◆ BeginReadObjectData()

void FSD_CmpFile::BeginReadObjectData ( )
overridevirtual

returns True if we are at end of the stream

Reimplemented from FSD_File.

◆ BeginReadPersistentObjectData()

void FSD_CmpFile::BeginReadPersistentObjectData ( )
overridevirtual

returns True if we are at end of the stream

Reimplemented from FSD_File.

◆ BeginWriteInfoSection()

Storage_Error FSD_CmpFile::BeginWriteInfoSection ( )
overridevirtual

returns True if we are at end of the stream

Reimplemented from FSD_File.

◆ BeginWriteObjectData()

void FSD_CmpFile::BeginWriteObjectData ( )
overridevirtual

returns True if we are at end of the stream

Reimplemented from FSD_File.

◆ BeginWritePersistentObjectData()

void FSD_CmpFile::BeginWritePersistentObjectData ( )
overridevirtual

returns True if we are at end of the stream

Reimplemented from FSD_File.

◆ Destroy()

void FSD_CmpFile::Destroy ( )

◆ EndReadObjectData()

void FSD_CmpFile::EndReadObjectData ( )
overridevirtual

returns True if we are at end of the stream

Reimplemented from FSD_File.

◆ EndReadPersistentObjectData()

void FSD_CmpFile::EndReadPersistentObjectData ( )
overridevirtual

returns True if we are at end of the stream

Reimplemented from FSD_File.

◆ EndWriteObjectData()

void FSD_CmpFile::EndWriteObjectData ( )
overridevirtual

returns True if we are at end of the stream

Reimplemented from FSD_File.

◆ EndWritePersistentObjectData()

void FSD_CmpFile::EndWritePersistentObjectData ( )
overridevirtual

returns True if we are at end of the stream

Reimplemented from FSD_File.

◆ IsGoodFileType()

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

◆ MagicNumber()

static Standard_CString FSD_CmpFile::MagicNumber ( )
static

◆ Open()

Storage_Error FSD_CmpFile::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.

Reimplemented from FSD_File.

◆ ReadExtendedLine()

void FSD_CmpFile::ReadExtendedLine ( TCollection_ExtendedString buffer)
overrideprotectedvirtual

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

Reimplemented from FSD_File.

◆ ReadLine()

void FSD_CmpFile::ReadLine ( TCollection_AsciiString buffer)
overrideprotectedvirtual

read from the current position to the end of line.

Reimplemented from FSD_File.

◆ ReadPersistentObjectHeader()

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

returns True if we are at end of the stream

Reimplemented from FSD_File.

◆ ReadString()

void FSD_CmpFile::ReadString ( TCollection_AsciiString buffer)
overrideprotectedvirtual

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

Reimplemented from FSD_File.

◆ WriteExtendedLine()

void FSD_CmpFile::WriteExtendedLine ( const TCollection_ExtendedString buffer)
overrideprotectedvirtual

write from the current position to the end of line.

Reimplemented from FSD_File.

◆ WritePersistentObjectHeader()

void FSD_CmpFile::WritePersistentObjectHeader ( const Standard_Integer  aRef,
const Standard_Integer  aType 
)
overridevirtual

returns True if we are at end of the stream

Reimplemented from FSD_File.


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