OCCT 8.0.1
OCCT documentation

Search guides and API reference

Enter at least two characters.

    Open CASCADE Technology Reference Manual 8.0.1
    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:

    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.
    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.
    bool IsEnd () override
     returns True if we are at end of the stream
    Storage_Position Tell () override
     return position in the file. Return -1 upon error.
    Storage_Error BeginWriteInfoSection () override
     returns True if we are at end of the stream
    void WriteInfo (const int 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 NCollection_Sequence< TCollection_AsciiString > &userInfo) override
     returns True if we are at end of the stream
    Storage_Error EndWriteInfoSection () override
     returns True if we are at end of the stream
    Storage_Error BeginReadInfoSection () override
     returns True if we are at end of the stream
    void ReadInfo (int &nbObj, TCollection_AsciiString &dbVersion, TCollection_AsciiString &date, TCollection_AsciiString &schemaName, TCollection_AsciiString &schemaVersion, TCollection_ExtendedString &appName, TCollection_AsciiString &appVersion, TCollection_ExtendedString &objectType, NCollection_Sequence< TCollection_AsciiString > &userInfo) override
     returns True if we are at end of the stream
    void ReadCompleteInfo (Standard_IStream &theIStream, occ::handle< Storage_Data > &theData) override
     returns True if we are at end of the stream
    Storage_Error EndReadInfoSection () override
     returns True if we are at end of the stream
    Storage_Error BeginWriteCommentSection () override
     returns True if we are at end of the stream
    void WriteComment (const NCollection_Sequence< TCollection_ExtendedString > &userComments) override
     returns True if we are at end of the stream
    Storage_Error EndWriteCommentSection () override
     returns True if we are at end of the stream
    Storage_Error BeginReadCommentSection () override
     returns True if we are at end of the stream
    void ReadComment (NCollection_Sequence< TCollection_ExtendedString > &userComments) override
     returns True if we are at end of the stream
    Storage_Error EndReadCommentSection () override
     returns True if we are at end of the stream
    Storage_Error BeginWriteTypeSection () override
     returns True if we are at end of the stream
    void SetTypeSectionSize (const int aSize) override
     returns True if we are at end of the stream
    void WriteTypeInformations (const int typeNum, const TCollection_AsciiString &typeName) override
     returns True if we are at end of the stream
    Storage_Error EndWriteTypeSection () override
     returns True if we are at end of the stream
    Storage_Error BeginReadTypeSection () override
     returns True if we are at end of the stream
    int TypeSectionSize () override
     returns True if we are at end of the stream
    void ReadTypeInformations (int &typeNum, TCollection_AsciiString &typeName) override
     returns True if we are at end of the stream
    Storage_Error EndReadTypeSection () override
     returns True if we are at end of the stream
    Storage_Error BeginWriteRootSection () override
     returns True if we are at end of the stream
    void SetRootSectionSize (const int aSize) override
     returns True if we are at end of the stream
    void WriteRoot (const TCollection_AsciiString &rootName, const int aRef, const TCollection_AsciiString &aType) override
     returns True if we are at end of the stream
    Storage_Error EndWriteRootSection () override
     returns True if we are at end of the stream
    Storage_Error BeginReadRootSection () override
     returns True if we are at end of the stream
    int RootSectionSize () override
     returns True if we are at end of the stream
    void ReadRoot (TCollection_AsciiString &rootName, int &aRef, TCollection_AsciiString &aType) override
     returns True if we are at end of the stream
    Storage_Error EndReadRootSection () override
     returns True if we are at end of the stream
    Storage_Error BeginWriteRefSection () override
     returns True if we are at end of the stream
    void SetRefSectionSize (const int aSize) override
     returns True if we are at end of the stream
    void WriteReferenceType (const int referencereference, const int typeNum) override
     returns True if we are at end of the stream
    Storage_Error EndWriteRefSection () override
     returns True if we are at end of the stream
    Storage_Error BeginReadRefSection () override
     returns True if we are at end of the stream
    int RefSectionSize () override
     returns True if we are at end of the stream
    void ReadReferenceType (int &referencereference, int &typeNum) override
     returns True if we are at end of the stream
    Storage_Error EndReadRefSection () override
     returns True if we are at end of the stream
    Storage_Error BeginWriteDataSection () override
     returns True if we are at end of the stream
    void WritePersistentObjectHeader (const int aRef, const int aType) override
     returns True if we are at end of the stream
    void BeginWritePersistentObjectData () override
     returns True if we are at end of the stream
    void BeginWriteObjectData () override
     returns True if we are at end of the stream
    void EndWriteObjectData () override
     returns True if we are at end of the stream
    void EndWritePersistentObjectData () override
     returns True if we are at end of the stream
    Storage_Error EndWriteDataSection () override
     returns True if we are at end of the stream
    Storage_Error BeginReadDataSection () override
     returns True if we are at end of the stream
    void ReadPersistentObjectHeader (int &aRef, int &aType) override
     returns True if we are at end of the stream
    void BeginReadPersistentObjectData () override
     returns True if we are at end of the stream
    void BeginReadObjectData () override
     returns True if we are at end of the stream
    void EndReadObjectData () override
     returns True if we are at end of the stream
    void EndReadPersistentObjectData () override
     returns True if we are at end of the stream
    Storage_Error EndReadDataSection () override
     returns True if we are at end of the stream
    void SkipObject () override
     returns True if we are at end of the stream
    Storage_BaseDriver & PutReference (const int aValue) override
    Storage_BaseDriver & PutCharacter (const char aValue) override
    Storage_BaseDriver & PutExtCharacter (const char16_t aValue) override
    Storage_BaseDriver & PutInteger (const int aValue) override
    Storage_BaseDriver & PutBoolean (const bool aValue) override
    Storage_BaseDriver & PutReal (const double aValue) override
    Storage_BaseDriver & PutShortReal (const float aValue) override
    Storage_BaseDriver & GetReference (int &aValue) override
    Storage_BaseDriver & GetCharacter (char &aValue) override
    Storage_BaseDriver & GetExtCharacter (char16_t &aValue) override
    Storage_BaseDriver & GetInteger (int &aValue) override
    Storage_BaseDriver & GetBoolean (bool &aValue) override
    Storage_BaseDriver & GetReal (double &aValue) override
    Storage_BaseDriver & GetShortReal (float &aValue) override
    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.
    void Destroy ()
     ~FSD_File () override
    Public Member Functions inherited from Storage_BaseDriver
     ~Storage_BaseDriver () override
    TCollection_AsciiString Name () const
    Storage_OpenMode OpenMode () const
    Storage_BaseDriver & operator<< (const char aValue)
    Storage_BaseDriver & operator<< (const char16_t aValue)
    Storage_BaseDriver & operator<< (const int aValue)
    Storage_BaseDriver & operator<< (const bool aValue)
    Storage_BaseDriver & operator<< (const double aValue)
    Storage_BaseDriver & operator<< (const float aValue)
    Storage_BaseDriver & operator>> (char &aValue)
    Storage_BaseDriver & operator>> (char16_t &aValue)
    Storage_BaseDriver & operator>> (int &aValue)
    Storage_BaseDriver & operator>> (bool &aValue)
    Storage_BaseDriver & operator>> (double &aValue)
    Storage_BaseDriver & operator>> (float &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 ()=default
     Destructor must be virtual.
    virtual const opencascade::handle< Standard_Type > & DynamicType () const
     Returns a type descriptor about this object.
    bool IsInstance (const opencascade::handle< Standard_Type > &theType) const
     Returns a true value if this is an instance of Type.
    bool IsInstance (const char *const theTypeName) const
     Returns a true value if this is an instance of TypeName.
    bool 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.
    bool IsKind (const char *const 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.
    int GetRefCount () const noexcept
     Get the reference counter of this object.
    void IncrementRefCounter () noexcept
     Increments the reference counter of this object. Uses relaxed memory ordering since incrementing only requires atomicity, not synchronization with other memory operations.
    int DecrementRefCounter () noexcept
     Decrements the reference counter of this object; returns the decremented value. Uses release ordering for the decrement to ensure all writes to the object are visible before the count reaches zero. An acquire fence is added only when the count reaches zero, ensuring proper synchronization before deletion. This is more efficient than using acq_rel for every decrement.
    virtual void Delete () const
     Memory deallocator for transient classes.

    Static Public Member Functions

    static Storage_Error IsGoodFileType (const TCollection_AsciiString &aName)
    static const char * MagicNumber ()
    Static Public Member Functions inherited from Storage_BaseDriver
    static TCollection_AsciiString ReadMagicNumber (Standard_IStream &theIStream)
    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.

    Protected Member Functions

    virtual void ReadLine (TCollection_AsciiString &bufferbuffer)
     read from the current position to the end of line.
    virtual void ReadWord (TCollection_AsciiString &bufferbuffer)
     read from the current position to the next white space or end of line.
    virtual void ReadExtendedLine (TCollection_ExtendedString &bufferbuffer)
     read extended chars (unicode) from the current position to the end of line.
    virtual void WriteExtendedLine (const TCollection_ExtendedString &bufferbuffer)
     write from the current position to the end of line.
    virtual void ReadChar (TCollection_AsciiString &bufferbuffer, const size_t rsize)
     read <rsize> character from the current position.
    virtual void ReadString (TCollection_AsciiString &bufferbuffer)
     read from the first none space character position to the end of line.
    virtual void FlushEndOfLine ()
    virtual Storage_Error FindTag (const char *const aTag)
     Storage_BaseDriver ()
    void SetName (const TCollection_AsciiString &aName)
    void SetOpenMode (const Storage_OpenMode aMode)

    Protected Attributes

    FSD_FStream myStream

    Additional Inherited Members

    typedef void base_type
     Returns a type descriptor about this object.

    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 ( )
    inlineoverride

    Member Function Documentation

    ◆ BeginReadCommentSection()

    Storage_Error FSD_File::BeginReadCommentSection ( )
    overridevirtual

    returns True if we are at end of the stream

    Implements Storage_BaseDriver.

    ◆ BeginReadDataSection()

    Storage_Error FSD_File::BeginReadDataSection ( )
    overridevirtual

    returns True if we are at end of the stream

    Implements Storage_BaseDriver.

    ◆ BeginReadInfoSection()

    Storage_Error FSD_File::BeginReadInfoSection ( )
    overridevirtual

    returns True if we are at end of the stream

    Implements Storage_BaseDriver.

    ◆ BeginReadObjectData()

    void FSD_File::BeginReadObjectData ( )
    overridevirtual

    returns True if we are at end of the stream

    Implements Storage_BaseDriver.

    ◆ BeginReadPersistentObjectData()

    void FSD_File::BeginReadPersistentObjectData ( )
    overridevirtual

    returns True if we are at end of the stream

    Implements Storage_BaseDriver.

    ◆ BeginReadRefSection()

    Storage_Error FSD_File::BeginReadRefSection ( )
    overridevirtual

    returns True if we are at end of the stream

    Implements Storage_BaseDriver.

    ◆ BeginReadRootSection()

    Storage_Error FSD_File::BeginReadRootSection ( )
    overridevirtual

    returns True if we are at end of the stream

    Implements Storage_BaseDriver.

    ◆ BeginReadTypeSection()

    Storage_Error FSD_File::BeginReadTypeSection ( )
    overridevirtual

    returns True if we are at end of the stream

    Implements Storage_BaseDriver.

    ◆ BeginWriteCommentSection()

    Storage_Error FSD_File::BeginWriteCommentSection ( )
    overridevirtual

    returns True if we are at end of the stream

    Implements Storage_BaseDriver.

    ◆ BeginWriteDataSection()

    Storage_Error FSD_File::BeginWriteDataSection ( )
    overridevirtual

    returns True if we are at end of the stream

    Implements Storage_BaseDriver.

    ◆ BeginWriteInfoSection()

    Storage_Error FSD_File::BeginWriteInfoSection ( )
    overridevirtual

    returns True if we are at end of the stream

    Implements Storage_BaseDriver.

    ◆ BeginWriteObjectData()

    void FSD_File::BeginWriteObjectData ( )
    overridevirtual

    returns True if we are at end of the stream

    Implements Storage_BaseDriver.

    ◆ BeginWritePersistentObjectData()

    void FSD_File::BeginWritePersistentObjectData ( )
    overridevirtual

    returns True if we are at end of the stream

    Implements Storage_BaseDriver.

    ◆ BeginWriteRefSection()

    Storage_Error FSD_File::BeginWriteRefSection ( )
    overridevirtual

    returns True if we are at end of the stream

    Implements Storage_BaseDriver.

    ◆ BeginWriteRootSection()

    Storage_Error FSD_File::BeginWriteRootSection ( )
    overridevirtual

    returns True if we are at end of the stream

    Implements Storage_BaseDriver.

    ◆ BeginWriteTypeSection()

    Storage_Error FSD_File::BeginWriteTypeSection ( )
    overridevirtual

    returns True if we are at end of the stream

    Implements Storage_BaseDriver.

    ◆ Close()

    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()

    Storage_Error FSD_File::EndReadCommentSection ( )
    overridevirtual

    returns True if we are at end of the stream

    Implements Storage_BaseDriver.

    ◆ EndReadDataSection()

    Storage_Error FSD_File::EndReadDataSection ( )
    overridevirtual

    returns True if we are at end of the stream

    Implements Storage_BaseDriver.

    ◆ EndReadInfoSection()

    Storage_Error FSD_File::EndReadInfoSection ( )
    overridevirtual

    returns True if we are at end of the stream

    Implements Storage_BaseDriver.

    ◆ EndReadObjectData()

    void FSD_File::EndReadObjectData ( )
    overridevirtual

    returns True if we are at end of the stream

    Implements Storage_BaseDriver.

    ◆ EndReadPersistentObjectData()

    void FSD_File::EndReadPersistentObjectData ( )
    overridevirtual

    returns True if we are at end of the stream

    Implements Storage_BaseDriver.

    ◆ EndReadRefSection()

    Storage_Error FSD_File::EndReadRefSection ( )
    overridevirtual

    returns True if we are at end of the stream

    Implements Storage_BaseDriver.

    ◆ EndReadRootSection()

    Storage_Error FSD_File::EndReadRootSection ( )
    overridevirtual

    returns True if we are at end of the stream

    Implements Storage_BaseDriver.

    ◆ EndReadTypeSection()

    Storage_Error FSD_File::EndReadTypeSection ( )
    overridevirtual

    returns True if we are at end of the stream

    Implements Storage_BaseDriver.

    ◆ EndWriteCommentSection()

    Storage_Error FSD_File::EndWriteCommentSection ( )
    overridevirtual

    returns True if we are at end of the stream

    Implements Storage_BaseDriver.

    ◆ EndWriteDataSection()

    Storage_Error FSD_File::EndWriteDataSection ( )
    overridevirtual

    returns True if we are at end of the stream

    Implements Storage_BaseDriver.

    ◆ EndWriteInfoSection()

    Storage_Error FSD_File::EndWriteInfoSection ( )
    overridevirtual

    returns True if we are at end of the stream

    Implements Storage_BaseDriver.

    ◆ EndWriteObjectData()

    void FSD_File::EndWriteObjectData ( )
    overridevirtual

    returns True if we are at end of the stream

    Implements Storage_BaseDriver.

    ◆ EndWritePersistentObjectData()

    void FSD_File::EndWritePersistentObjectData ( )
    overridevirtual

    returns True if we are at end of the stream

    Implements Storage_BaseDriver.

    ◆ EndWriteRefSection()

    Storage_Error FSD_File::EndWriteRefSection ( )
    overridevirtual

    returns True if we are at end of the stream

    Implements Storage_BaseDriver.

    ◆ EndWriteRootSection()

    Storage_Error FSD_File::EndWriteRootSection ( )
    overridevirtual

    returns True if we are at end of the stream

    Implements Storage_BaseDriver.

    ◆ EndWriteTypeSection()

    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 char *const aTag)
    protectedvirtual

    ◆ FlushEndOfLine()

    virtual void FSD_File::FlushEndOfLine ( )
    protectedvirtual

    ◆ GetBoolean()

    Storage_BaseDriver & FSD_File::GetBoolean ( bool & aValue)
    overridevirtual

    Implements Storage_BaseDriver.

    ◆ GetCharacter()

    Storage_BaseDriver & FSD_File::GetCharacter ( char & aValue)
    overridevirtual

    Implements Storage_BaseDriver.

    ◆ GetExtCharacter()

    Storage_BaseDriver & FSD_File::GetExtCharacter ( char16_t & aValue)
    overridevirtual

    Implements Storage_BaseDriver.

    ◆ GetInteger()

    Storage_BaseDriver & FSD_File::GetInteger ( int & aValue)
    overridevirtual

    Implements Storage_BaseDriver.

    ◆ GetReal()

    Storage_BaseDriver & FSD_File::GetReal ( double & aValue)
    overridevirtual

    Implements Storage_BaseDriver.

    ◆ GetReference()

    Storage_BaseDriver & FSD_File::GetReference ( int & aValue)
    overridevirtual

    Implements Storage_BaseDriver.

    ◆ GetShortReal()

    Storage_BaseDriver & FSD_File::GetShortReal ( float & aValue)
    overridevirtual

    Implements Storage_BaseDriver.

    ◆ IsEnd()

    bool FSD_File::IsEnd ( )
    overridevirtual

    returns True if we are at end of the stream

    Implements Storage_BaseDriver.

    ◆ IsGoodFileType()

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

    ◆ MagicNumber()

    const char * FSD_File::MagicNumber ( )
    static

    ◆ Open()

    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.

    ◆ PutBoolean()

    Storage_BaseDriver & FSD_File::PutBoolean ( const bool aValue)
    overridevirtual

    Implements Storage_BaseDriver.

    ◆ PutCharacter()

    Storage_BaseDriver & FSD_File::PutCharacter ( const char aValue)
    overridevirtual

    Implements Storage_BaseDriver.

    ◆ PutExtCharacter()

    Storage_BaseDriver & FSD_File::PutExtCharacter ( const char16_t aValue)
    overridevirtual

    Implements Storage_BaseDriver.

    ◆ PutInteger()

    Storage_BaseDriver & FSD_File::PutInteger ( const int aValue)
    overridevirtual

    Implements Storage_BaseDriver.

    ◆ PutReal()

    Storage_BaseDriver & FSD_File::PutReal ( const double aValue)
    overridevirtual

    Implements Storage_BaseDriver.

    ◆ PutReference()

    Storage_BaseDriver & FSD_File::PutReference ( const int aValue)
    overridevirtual

    Implements Storage_BaseDriver.

    ◆ PutShortReal()

    Storage_BaseDriver & FSD_File::PutShortReal ( const float aValue)
    overridevirtual

    Implements Storage_BaseDriver.

    ◆ ReadChar()

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

    read <rsize> character from the current position.

    ◆ ReadComment()

    void FSD_File::ReadComment ( NCollection_Sequence< TCollection_ExtendedString > & userComments)
    overridevirtual

    returns True if we are at end of the stream

    Implements Storage_BaseDriver.

    ◆ ReadCompleteInfo()

    void FSD_File::ReadCompleteInfo ( Standard_IStream & theIStream,
    occ::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()

    void FSD_File::ReadInfo ( int & nbObj,
    TCollection_AsciiString & dbVersion,
    TCollection_AsciiString & date,
    TCollection_AsciiString & schemaName,
    TCollection_AsciiString & schemaVersion,
    TCollection_ExtendedString & appName,
    TCollection_AsciiString & appVersion,
    TCollection_ExtendedString & objectType,
    NCollection_Sequence< TCollection_AsciiString > & 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()

    void FSD_File::ReadPersistentObjectHeader ( int & aRef,
    int & aType )
    overridevirtual

    returns True if we are at end of the stream

    Implements Storage_BaseDriver.

    ◆ ReadReferenceType()

    void FSD_File::ReadReferenceType ( int & reference,
    int & typeNum )
    overridevirtual

    returns True if we are at end of the stream

    Implements Storage_BaseDriver.

    ◆ ReadRoot()

    void FSD_File::ReadRoot ( TCollection_AsciiString & rootName,
    int & 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()

    void FSD_File::ReadTypeInformations ( int & 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()

    int FSD_File::RefSectionSize ( )
    overridevirtual

    returns True if we are at end of the stream

    Implements Storage_BaseDriver.

    ◆ RootSectionSize()

    int FSD_File::RootSectionSize ( )
    overridevirtual

    returns True if we are at end of the stream

    Implements Storage_BaseDriver.

    ◆ SetRefSectionSize()

    void FSD_File::SetRefSectionSize ( const int aSize)
    overridevirtual

    returns True if we are at end of the stream

    Implements Storage_BaseDriver.

    ◆ SetRootSectionSize()

    void FSD_File::SetRootSectionSize ( const int aSize)
    overridevirtual

    returns True if we are at end of the stream

    Implements Storage_BaseDriver.

    ◆ SetTypeSectionSize()

    void FSD_File::SetTypeSectionSize ( const int aSize)
    overridevirtual

    returns True if we are at end of the stream

    Implements Storage_BaseDriver.

    ◆ SkipObject()

    void FSD_File::SkipObject ( )
    overridevirtual

    returns True if we are at end of the stream

    Implements Storage_BaseDriver.

    ◆ Tell()

    Storage_Position FSD_File::Tell ( )
    overridevirtual

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

    Implements Storage_BaseDriver.

    ◆ TypeSectionSize()

    int FSD_File::TypeSectionSize ( )
    overridevirtual

    returns True if we are at end of the stream

    Implements Storage_BaseDriver.

    ◆ WriteComment()

    void FSD_File::WriteComment ( const NCollection_Sequence< TCollection_ExtendedString > & 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()

    void FSD_File::WriteInfo ( const int 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 NCollection_Sequence< TCollection_AsciiString > & userInfo )
    overridevirtual

    returns True if we are at end of the stream

    Implements Storage_BaseDriver.

    ◆ WritePersistentObjectHeader()

    void FSD_File::WritePersistentObjectHeader ( const int aRef,
    const int aType )
    overridevirtual

    returns True if we are at end of the stream

    Implements Storage_BaseDriver.

    ◆ WriteReferenceType()

    void FSD_File::WriteReferenceType ( const int reference,
    const int typeNum )
    overridevirtual

    returns True if we are at end of the stream

    Implements Storage_BaseDriver.

    ◆ WriteRoot()

    void FSD_File::WriteRoot ( const TCollection_AsciiString & rootName,
    const int aRef,
    const TCollection_AsciiString & aType )
    overridevirtual

    returns True if we are at end of the stream

    Implements Storage_BaseDriver.

    ◆ WriteTypeInformations()

    void FSD_File::WriteTypeInformations ( const int 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: