OCCT3D 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_BinaryFile Class Reference

    #include <FSD_BinaryFile.hxx>

    Inheritance diagram for FSD_BinaryFile:

    Public Member Functions

     FSD_BinaryFile ()
    Storage_Error Open (const TCollection_AsciiString &aName, const Storage_OpenMode aMode) override
     returns True if we are at end of the stream
    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 EndWriteInfoSection (Standard_OStream &theOStream)
    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
    Storage_Error BeginWriteCommentSection (Standard_OStream &theOStream)
    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 EndWriteCommentSection (Standard_OStream &theOStream)
    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_BaseDriverPutReference (const int aValue) override
    Storage_BaseDriverPutCharacter (const char aValue) override
    Storage_BaseDriverPutExtCharacter (const char16_t aValue) override
    Storage_BaseDriverPutInteger (const int aValue) override
    Storage_BaseDriverPutBoolean (const bool aValue) override
    Storage_BaseDriverPutReal (const double aValue) override
    Storage_BaseDriverPutShortReal (const float aValue) override
    Storage_BaseDriverGetReference (int &aValue) override
    Storage_BaseDriverGetCharacter (char &aValue) override
    Storage_BaseDriverGetExtCharacter (char16_t &aValue) override
    Storage_BaseDriverGetInteger (int &aValue) override
    Storage_BaseDriverGetBoolean (bool &aValue) override
    Storage_BaseDriverGetReal (double &aValue) override
    Storage_BaseDriverGetShortReal (float &aValue) override
    Storage_Error Close () override
     returns True if we are at end of the stream
    void Destroy ()
     ~FSD_BinaryFile () override
    Public Member Functions inherited from Storage_BaseDriver
     ~Storage_BaseDriver () override
    TCollection_AsciiString Name () const
    Storage_OpenMode OpenMode () const
    Storage_BaseDriveroperator<< (const char aValue)
    Storage_BaseDriveroperator<< (const char16_t aValue)
    Storage_BaseDriveroperator<< (const int aValue)
    Storage_BaseDriveroperator<< (const bool aValue)
    Storage_BaseDriveroperator<< (const double aValue)
    Storage_BaseDriveroperator<< (const float aValue)
    Storage_BaseDriveroperator>> (char &aValue)
    Storage_BaseDriveroperator>> (char16_t &aValue)
    Storage_BaseDriveroperator>> (int &aValue)
    Storage_BaseDriveroperator>> (bool &aValue)
    Storage_BaseDriveroperator>> (double &aValue)
    Storage_BaseDriveroperator>> (float &aValue)
    Public Member Functions inherited from Standard_Transient
     Standard_Transient ()
     Empty constructor.
     Standard_Transient (const Standard_Transient &)
     Copy constructor – does nothing.
    Standard_Transientoperator= (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_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.
    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 int WriteInfo (Standard_OStream &theOStream, 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, const bool theOnlyCount=false)
    static int WriteComment (Standard_OStream &theOStream, const NCollection_Sequence< TCollection_ExtendedString > &theComments, const bool theOnlyCount=false)
    static void ReadComment (Standard_IStream &theIStream, NCollection_Sequence< TCollection_ExtendedString > &userComments)
    static int TypeSectionSize (Standard_IStream &theIStream)
    static void ReadTypeInformations (Standard_IStream &theIStream, int &typeNum, TCollection_AsciiString &typeName)
    static int RootSectionSize (Standard_IStream &theIStream)
    static void ReadRoot (Standard_IStream &theIStream, TCollection_AsciiString &rootName, int &aRef, TCollection_AsciiString &aType)
    static int RefSectionSize (Standard_IStream &theIStream)
    static void ReadReferenceType (Standard_IStream &theIStream, int &referencereference, int &typeNum)
    static int PutInteger (Standard_OStream &theOStream, const int aValue, const bool theOnlyCount=false)
    static void GetReference (Standard_IStream &theIStream, int &aValue)
    static void GetInteger (Standard_IStream &theIStream, int &aValue)
    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.

    Own methods

    static int InverseInt (const int theValue)
     Inverse bytes in integer value.
    static char16_t InverseExtChar (const char16_t theValue)
     Inverse bytes in extended character value.
    static double InverseReal (const double theValue)
     Inverse bytes in real value.
    static float InverseShortReal (const float theValue)
     Inverse bytes in short real value.
    static size_t InverseSize (const size_t theValue)
     Inverse bytes in size value.
    static uint64_t InverseUint64 (const uint64_t theValue)
     Inverse bytes in 64bit unsigned int value.
    static void ReadHeader (Standard_IStream &theIStream, FSD_FileHeader &theFileHeader)
     Inverse bytes in integer value.
    static void ReadHeaderData (Standard_IStream &theIStream, const occ::handle< Storage_HeaderData > &theHeaderData)
     Inverse bytes in integer value.
    static void ReadString (Standard_IStream &theIStream, TCollection_AsciiString &bufferbuffer)
     Inverse bytes in integer value.
    static void ReadExtendedString (Standard_IStream &theIStream, TCollection_ExtendedString &bufferbuffer)
     Inverse bytes in integer value.
    static int WriteHeader (Standard_OStream &theOStream, const FSD_FileHeader &theHeader, const bool theOnlyCount=false)
     Inverse bytes in integer value.
    static const char * MagicNumber ()
     Inverse bytes in integer value.
    void ReadChar (TCollection_AsciiString &bufferbuffer, const size_t rsize)
     read <rsize> character from the current position.
    void ReadString (TCollection_AsciiString &bufferbuffer)
     read string from the current position.
    void WriteString (const TCollection_AsciiString &bufferbuffer)
     write string at the current position.
    void ReadExtendedString (TCollection_ExtendedString &bufferbuffer)
     read string from the current position.
    void WriteExtendedString (const TCollection_ExtendedString &bufferbuffer)
     write string at the current position.
    static int WriteString (Standard_OStream &theOStream, const TCollection_AsciiString &theString, const bool theOnlyCount=false)
     write string at the current position.
    static int WriteExtendedString (Standard_OStream &theOStream, const TCollection_ExtendedString &theString, const bool theOnlyCount=false)
     write string at the current position.

    Additional Inherited Members

    typedef void base_type
     Returns a type descriptor about this object.
     Storage_BaseDriver ()
    void SetName (const TCollection_AsciiString &aName)
    void SetOpenMode (const Storage_OpenMode aMode)

    Constructor & Destructor Documentation

    ◆ FSD_BinaryFile()

    FSD_BinaryFile::FSD_BinaryFile ( )

    ◆ ~FSD_BinaryFile()

    FSD_BinaryFile::~FSD_BinaryFile ( )
    inlineoverride

    Member Function Documentation

    ◆ BeginReadCommentSection()

    Storage_Error FSD_BinaryFile::BeginReadCommentSection ( )
    overridevirtual

    returns True if we are at end of the stream

    Implements Storage_BaseDriver.

    ◆ BeginReadDataSection()

    Storage_Error FSD_BinaryFile::BeginReadDataSection ( )
    overridevirtual

    returns True if we are at end of the stream

    Implements Storage_BaseDriver.

    ◆ BeginReadInfoSection()

    Storage_Error FSD_BinaryFile::BeginReadInfoSection ( )
    overridevirtual

    returns True if we are at end of the stream

    Implements Storage_BaseDriver.

    ◆ BeginReadObjectData()

    void FSD_BinaryFile::BeginReadObjectData ( )
    overridevirtual

    returns True if we are at end of the stream

    Implements Storage_BaseDriver.

    ◆ BeginReadPersistentObjectData()

    void FSD_BinaryFile::BeginReadPersistentObjectData ( )
    overridevirtual

    returns True if we are at end of the stream

    Implements Storage_BaseDriver.

    ◆ BeginReadRefSection()

    Storage_Error FSD_BinaryFile::BeginReadRefSection ( )
    overridevirtual

    returns True if we are at end of the stream

    Implements Storage_BaseDriver.

    ◆ BeginReadRootSection()

    Storage_Error FSD_BinaryFile::BeginReadRootSection ( )
    overridevirtual

    returns True if we are at end of the stream

    Implements Storage_BaseDriver.

    ◆ BeginReadTypeSection()

    Storage_Error FSD_BinaryFile::BeginReadTypeSection ( )
    overridevirtual

    returns True if we are at end of the stream

    Implements Storage_BaseDriver.

    ◆ BeginWriteCommentSection() [1/2]

    Storage_Error FSD_BinaryFile::BeginWriteCommentSection ( )
    overridevirtual

    returns True if we are at end of the stream

    Implements Storage_BaseDriver.

    ◆ BeginWriteCommentSection() [2/2]

    Storage_Error FSD_BinaryFile::BeginWriteCommentSection ( Standard_OStream & theOStream)

    ◆ BeginWriteDataSection()

    Storage_Error FSD_BinaryFile::BeginWriteDataSection ( )
    overridevirtual

    returns True if we are at end of the stream

    Implements Storage_BaseDriver.

    ◆ BeginWriteInfoSection()

    Storage_Error FSD_BinaryFile::BeginWriteInfoSection ( )
    overridevirtual

    returns True if we are at end of the stream

    Implements Storage_BaseDriver.

    ◆ BeginWriteObjectData()

    void FSD_BinaryFile::BeginWriteObjectData ( )
    overridevirtual

    returns True if we are at end of the stream

    Implements Storage_BaseDriver.

    ◆ BeginWritePersistentObjectData()

    void FSD_BinaryFile::BeginWritePersistentObjectData ( )
    overridevirtual

    returns True if we are at end of the stream

    Implements Storage_BaseDriver.

    ◆ BeginWriteRefSection()

    Storage_Error FSD_BinaryFile::BeginWriteRefSection ( )
    overridevirtual

    returns True if we are at end of the stream

    Implements Storage_BaseDriver.

    ◆ BeginWriteRootSection()

    Storage_Error FSD_BinaryFile::BeginWriteRootSection ( )
    overridevirtual

    returns True if we are at end of the stream

    Implements Storage_BaseDriver.

    ◆ BeginWriteTypeSection()

    Storage_Error FSD_BinaryFile::BeginWriteTypeSection ( )
    overridevirtual

    returns True if we are at end of the stream

    Implements Storage_BaseDriver.

    ◆ Close()

    Storage_Error FSD_BinaryFile::Close ( )
    overridevirtual

    returns True if we are at end of the stream

    Implements Storage_BaseDriver.

    ◆ Destroy()

    void FSD_BinaryFile::Destroy ( )

    ◆ EndReadCommentSection()

    Storage_Error FSD_BinaryFile::EndReadCommentSection ( )
    overridevirtual

    returns True if we are at end of the stream

    Implements Storage_BaseDriver.

    ◆ EndReadDataSection()

    Storage_Error FSD_BinaryFile::EndReadDataSection ( )
    overridevirtual

    returns True if we are at end of the stream

    Implements Storage_BaseDriver.

    ◆ EndReadInfoSection()

    Storage_Error FSD_BinaryFile::EndReadInfoSection ( )
    overridevirtual

    returns True if we are at end of the stream

    Implements Storage_BaseDriver.

    ◆ EndReadObjectData()

    void FSD_BinaryFile::EndReadObjectData ( )
    overridevirtual

    returns True if we are at end of the stream

    Implements Storage_BaseDriver.

    ◆ EndReadPersistentObjectData()

    void FSD_BinaryFile::EndReadPersistentObjectData ( )
    overridevirtual

    returns True if we are at end of the stream

    Implements Storage_BaseDriver.

    ◆ EndReadRefSection()

    Storage_Error FSD_BinaryFile::EndReadRefSection ( )
    overridevirtual

    returns True if we are at end of the stream

    Implements Storage_BaseDriver.

    ◆ EndReadRootSection()

    Storage_Error FSD_BinaryFile::EndReadRootSection ( )
    overridevirtual

    returns True if we are at end of the stream

    Implements Storage_BaseDriver.

    ◆ EndReadTypeSection()

    Storage_Error FSD_BinaryFile::EndReadTypeSection ( )
    overridevirtual

    returns True if we are at end of the stream

    Implements Storage_BaseDriver.

    ◆ EndWriteCommentSection() [1/2]

    Storage_Error FSD_BinaryFile::EndWriteCommentSection ( )
    overridevirtual

    returns True if we are at end of the stream

    Implements Storage_BaseDriver.

    ◆ EndWriteCommentSection() [2/2]

    Storage_Error FSD_BinaryFile::EndWriteCommentSection ( Standard_OStream & theOStream)

    ◆ EndWriteDataSection()

    Storage_Error FSD_BinaryFile::EndWriteDataSection ( )
    overridevirtual

    returns True if we are at end of the stream

    Implements Storage_BaseDriver.

    ◆ EndWriteInfoSection() [1/2]

    Storage_Error FSD_BinaryFile::EndWriteInfoSection ( )
    overridevirtual

    returns True if we are at end of the stream

    Implements Storage_BaseDriver.

    ◆ EndWriteInfoSection() [2/2]

    Storage_Error FSD_BinaryFile::EndWriteInfoSection ( Standard_OStream & theOStream)

    ◆ EndWriteObjectData()

    void FSD_BinaryFile::EndWriteObjectData ( )
    overridevirtual

    returns True if we are at end of the stream

    Implements Storage_BaseDriver.

    ◆ EndWritePersistentObjectData()

    void FSD_BinaryFile::EndWritePersistentObjectData ( )
    overridevirtual

    returns True if we are at end of the stream

    Implements Storage_BaseDriver.

    ◆ EndWriteRefSection()

    Storage_Error FSD_BinaryFile::EndWriteRefSection ( )
    overridevirtual

    returns True if we are at end of the stream

    Implements Storage_BaseDriver.

    ◆ EndWriteRootSection()

    Storage_Error FSD_BinaryFile::EndWriteRootSection ( )
    overridevirtual

    returns True if we are at end of the stream

    Implements Storage_BaseDriver.

    ◆ EndWriteTypeSection()

    Storage_Error FSD_BinaryFile::EndWriteTypeSection ( )
    overridevirtual

    returns True if we are at end of the stream

    Implements Storage_BaseDriver.

    ◆ GetBoolean()

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

    Implements Storage_BaseDriver.

    ◆ GetCharacter()

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

    Implements Storage_BaseDriver.

    ◆ GetExtCharacter()

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

    Implements Storage_BaseDriver.

    ◆ GetInteger() [1/2]

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

    Implements Storage_BaseDriver.

    ◆ GetInteger() [2/2]

    void FSD_BinaryFile::GetInteger ( Standard_IStream & theIStream,
    int & aValue )
    static

    ◆ GetReal()

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

    Implements Storage_BaseDriver.

    ◆ GetReference() [1/2]

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

    Implements Storage_BaseDriver.

    ◆ GetReference() [2/2]

    void FSD_BinaryFile::GetReference ( Standard_IStream & theIStream,
    int & aValue )
    static

    ◆ GetShortReal()

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

    Implements Storage_BaseDriver.

    ◆ InverseExtChar()

    char16_t FSD_BinaryFile::InverseExtChar ( const char16_t theValue)
    inlinestatic

    Inverse bytes in extended character value.

    ◆ InverseInt()

    int FSD_BinaryFile::InverseInt ( const int theValue)
    inlinestatic

    Inverse bytes in integer value.

    ◆ InverseReal()

    double FSD_BinaryFile::InverseReal ( const double theValue)
    static

    Inverse bytes in real value.

    ◆ InverseShortReal()

    float FSD_BinaryFile::InverseShortReal ( const float theValue)
    static

    Inverse bytes in short real value.

    ◆ InverseSize()

    size_t FSD_BinaryFile::InverseSize ( const size_t theValue)
    static

    Inverse bytes in size value.

    ◆ InverseUint64()

    uint64_t FSD_BinaryFile::InverseUint64 ( const uint64_t theValue)
    static

    Inverse bytes in 64bit unsigned int value.

    ◆ IsEnd()

    bool FSD_BinaryFile::IsEnd ( )
    overridevirtual

    returns True if we are at end of the stream

    Implements Storage_BaseDriver.

    ◆ IsGoodFileType()

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

    ◆ MagicNumber()

    const char * FSD_BinaryFile::MagicNumber ( )
    static

    Inverse bytes in integer value.

    ◆ Open()

    Storage_Error FSD_BinaryFile::Open ( const TCollection_AsciiString & aName,
    const Storage_OpenMode aMode )
    overridevirtual

    returns True if we are at end of the stream

    Implements Storage_BaseDriver.

    ◆ PutBoolean()

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

    Implements Storage_BaseDriver.

    ◆ PutCharacter()

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

    Implements Storage_BaseDriver.

    ◆ PutExtCharacter()

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

    Implements Storage_BaseDriver.

    ◆ PutInteger() [1/2]

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

    Implements Storage_BaseDriver.

    ◆ PutInteger() [2/2]

    int FSD_BinaryFile::PutInteger ( Standard_OStream & theOStream,
    const int aValue,
    const bool theOnlyCount = false )
    static

    ◆ PutReal()

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

    Implements Storage_BaseDriver.

    ◆ PutReference()

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

    Implements Storage_BaseDriver.

    ◆ PutShortReal()

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

    Implements Storage_BaseDriver.

    ◆ ReadChar()

    void FSD_BinaryFile::ReadChar ( TCollection_AsciiString & buffer,
    const size_t rsize )
    protected

    read <rsize> character from the current position.

    ◆ ReadComment() [1/2]

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

    returns True if we are at end of the stream

    Implements Storage_BaseDriver.

    ◆ ReadComment() [2/2]

    void FSD_BinaryFile::ReadComment ( Standard_IStream & theIStream,
    NCollection_Sequence< TCollection_ExtendedString > & userComments )
    static

    ◆ ReadCompleteInfo()

    void FSD_BinaryFile::ReadCompleteInfo ( Standard_IStream & theIStream,
    occ::handle< Storage_Data > & theData )
    overridevirtual

    returns True if we are at end of the stream

    Implements Storage_BaseDriver.

    ◆ ReadExtendedString() [1/2]

    void FSD_BinaryFile::ReadExtendedString ( Standard_IStream & theIStream,
    TCollection_ExtendedString & buffer )
    static

    Inverse bytes in integer value.

    ◆ ReadExtendedString() [2/2]

    void FSD_BinaryFile::ReadExtendedString ( TCollection_ExtendedString & buffer)
    protected

    read string from the current position.

    ◆ ReadHeader()

    void FSD_BinaryFile::ReadHeader ( Standard_IStream & theIStream,
    FSD_FileHeader & theFileHeader )
    static

    Inverse bytes in integer value.

    ◆ ReadHeaderData()

    void FSD_BinaryFile::ReadHeaderData ( Standard_IStream & theIStream,
    const occ::handle< Storage_HeaderData > & theHeaderData )
    static

    Inverse bytes in integer value.

    ◆ ReadInfo()

    void FSD_BinaryFile::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.

    ◆ ReadPersistentObjectHeader()

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

    returns True if we are at end of the stream

    Implements Storage_BaseDriver.

    ◆ ReadReferenceType() [1/2]

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

    returns True if we are at end of the stream

    Implements Storage_BaseDriver.

    ◆ ReadReferenceType() [2/2]

    void FSD_BinaryFile::ReadReferenceType ( Standard_IStream & theIStream,
    int & reference,
    int & typeNum )
    static

    ◆ ReadRoot() [1/2]

    void FSD_BinaryFile::ReadRoot ( Standard_IStream & theIStream,
    TCollection_AsciiString & rootName,
    int & aRef,
    TCollection_AsciiString & aType )
    static

    ◆ ReadRoot() [2/2]

    void FSD_BinaryFile::ReadRoot ( TCollection_AsciiString & rootName,
    int & aRef,
    TCollection_AsciiString & aType )
    overridevirtual

    returns True if we are at end of the stream

    Implements Storage_BaseDriver.

    ◆ ReadString() [1/2]

    void FSD_BinaryFile::ReadString ( Standard_IStream & theIStream,
    TCollection_AsciiString & buffer )
    static

    Inverse bytes in integer value.

    ◆ ReadString() [2/2]

    void FSD_BinaryFile::ReadString ( TCollection_AsciiString & buffer)
    protected

    read string from the current position.

    ◆ ReadTypeInformations() [1/2]

    void FSD_BinaryFile::ReadTypeInformations ( int & typeNum,
    TCollection_AsciiString & typeName )
    overridevirtual

    returns True if we are at end of the stream

    Implements Storage_BaseDriver.

    ◆ ReadTypeInformations() [2/2]

    void FSD_BinaryFile::ReadTypeInformations ( Standard_IStream & theIStream,
    int & typeNum,
    TCollection_AsciiString & typeName )
    static

    ◆ RefSectionSize() [1/2]

    int FSD_BinaryFile::RefSectionSize ( )
    overridevirtual

    returns True if we are at end of the stream

    Implements Storage_BaseDriver.

    ◆ RefSectionSize() [2/2]

    int FSD_BinaryFile::RefSectionSize ( Standard_IStream & theIStream)
    static

    ◆ RootSectionSize() [1/2]

    int FSD_BinaryFile::RootSectionSize ( )
    overridevirtual

    returns True if we are at end of the stream

    Implements Storage_BaseDriver.

    ◆ RootSectionSize() [2/2]

    int FSD_BinaryFile::RootSectionSize ( Standard_IStream & theIStream)
    static

    ◆ SetRefSectionSize()

    void FSD_BinaryFile::SetRefSectionSize ( const int aSize)
    overridevirtual

    returns True if we are at end of the stream

    Implements Storage_BaseDriver.

    ◆ SetRootSectionSize()

    void FSD_BinaryFile::SetRootSectionSize ( const int aSize)
    overridevirtual

    returns True if we are at end of the stream

    Implements Storage_BaseDriver.

    ◆ SetTypeSectionSize()

    void FSD_BinaryFile::SetTypeSectionSize ( const int aSize)
    overridevirtual

    returns True if we are at end of the stream

    Implements Storage_BaseDriver.

    ◆ SkipObject()

    void FSD_BinaryFile::SkipObject ( )
    overridevirtual

    returns True if we are at end of the stream

    Implements Storage_BaseDriver.

    ◆ Tell()

    Storage_Position FSD_BinaryFile::Tell ( )
    overridevirtual

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

    Implements Storage_BaseDriver.

    ◆ TypeSectionSize() [1/2]

    int FSD_BinaryFile::TypeSectionSize ( )
    overridevirtual

    returns True if we are at end of the stream

    Implements Storage_BaseDriver.

    ◆ TypeSectionSize() [2/2]

    int FSD_BinaryFile::TypeSectionSize ( Standard_IStream & theIStream)
    static

    ◆ WriteComment() [1/2]

    void FSD_BinaryFile::WriteComment ( const NCollection_Sequence< TCollection_ExtendedString > & userComments)
    overridevirtual

    returns True if we are at end of the stream

    Implements Storage_BaseDriver.

    ◆ WriteComment() [2/2]

    int FSD_BinaryFile::WriteComment ( Standard_OStream & theOStream,
    const NCollection_Sequence< TCollection_ExtendedString > & theComments,
    const bool theOnlyCount = false )
    static

    ◆ WriteExtendedString() [1/2]

    void FSD_BinaryFile::WriteExtendedString ( const TCollection_ExtendedString & buffer)
    protected

    write string at the current position.

    ◆ WriteExtendedString() [2/2]

    int FSD_BinaryFile::WriteExtendedString ( Standard_OStream & theOStream,
    const TCollection_ExtendedString & theString,
    const bool theOnlyCount = false )
    staticprotected

    write string at the current position.

    ◆ WriteHeader()

    int FSD_BinaryFile::WriteHeader ( Standard_OStream & theOStream,
    const FSD_FileHeader & theHeader,
    const bool theOnlyCount = false )
    static

    Inverse bytes in integer value.

    ◆ WriteInfo() [1/2]

    void FSD_BinaryFile::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.

    ◆ WriteInfo() [2/2]

    int FSD_BinaryFile::WriteInfo ( Standard_OStream & theOStream,
    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,
    const bool theOnlyCount = false )
    static

    ◆ WritePersistentObjectHeader()

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

    returns True if we are at end of the stream

    Implements Storage_BaseDriver.

    ◆ WriteReferenceType()

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

    returns True if we are at end of the stream

    Implements Storage_BaseDriver.

    ◆ WriteRoot()

    void FSD_BinaryFile::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.

    ◆ WriteString() [1/2]

    void FSD_BinaryFile::WriteString ( const TCollection_AsciiString & buffer)
    protected

    write string at the current position.

    ◆ WriteString() [2/2]

    int FSD_BinaryFile::WriteString ( Standard_OStream & theOStream,
    const TCollection_AsciiString & theString,
    const bool theOnlyCount = false )
    staticprotected

    write string at the current position.

    ◆ WriteTypeInformations()

    void FSD_BinaryFile::WriteTypeInformations ( const int typeNum,
    const TCollection_AsciiString & typeName )
    overridevirtual

    returns True if we are at end of the stream

    Implements Storage_BaseDriver.


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