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
    XmlDrivers_DocumentRetrievalDriver Class Reference

    #include <XmlDrivers_DocumentRetrievalDriver.hxx>

    Inheritance diagram for XmlDrivers_DocumentRetrievalDriver:

    Public Member Functions

     XmlDrivers_DocumentRetrievalDriver ()
    occ::handle< XmlMDF_ADriverTableAttributeDrivers (const occ::handle< Message_Messenger > &theMsgDriver) override
    occ::handle< XmlMDF_ADriverReadShapeSection (const XmlObjMgt_Element &thePDoc, const occ::handle< Message_Messenger > &theMsgDriver, const Message_ProgressRange &theRange=Message_ProgressRange()) override
    void ShapeSetCleaning (const occ::handle< XmlMDF_ADriver > &theDriver) override
    Public Member Functions inherited from XmlLDrivers_DocumentRetrievalDriver
     XmlLDrivers_DocumentRetrievalDriver ()
    void Read (const TCollection_ExtendedString &theFileName, const occ::handle< CDM_Document > &theNewDocument, const occ::handle< CDM_Application > &theApplication, const occ::handle< PCDM_ReaderFilter > &theFilter=occ::handle< PCDM_ReaderFilter >(), const Message_ProgressRange &theRange=Message_ProgressRange()) override
     retrieves the content of the file into a new Document.
    void Read (Standard_IStream &theIStream, const occ::handle< Storage_Data > &theStorageData, const occ::handle< CDM_Document > &theDoc, const occ::handle< CDM_Application > &theApplication, const occ::handle< PCDM_ReaderFilter > &theFilter=occ::handle< PCDM_ReaderFilter >(), const Message_ProgressRange &theRange=Message_ProgressRange()) override
    Public Member Functions inherited from PCDM_RetrievalDriver
    void SetFormat (const TCollection_ExtendedString &aformat)
    TCollection_ExtendedString GetFormat () const
    Public Member Functions inherited from PCDM_Reader
    PCDM_ReaderStatus GetStatus () const
    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.

    Additional Inherited Members

    typedef void base_type
     Returns a type descriptor about this object.
    Static Public Member Functions inherited from PCDM_RetrievalDriver
    static int DocumentVersion (const TCollection_ExtendedString &theFileName, const occ::handle< Message_Messenger > &theMsgDriver)
    static int ReferenceCounter (const TCollection_ExtendedString &theFileName, const occ::handle< Message_Messenger > &theMsgDriver)
    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 inherited from XmlLDrivers_DocumentRetrievalDriver
    virtual void ReadFromDomDocument (const XmlObjMgt_Element &theDomElement, const occ::handle< CDM_Document > &theNewDocument, const occ::handle< CDM_Application > &theApplication, const Message_ProgressRange &theRange=Message_ProgressRange())
    virtual bool MakeDocument (const XmlObjMgt_Element &thePDoc, const occ::handle< CDM_Document > &theTDoc, const Message_ProgressRange &theRange=Message_ProgressRange())
    Protected Attributes inherited from XmlLDrivers_DocumentRetrievalDriver
    occ::handle< XmlMDF_ADriverTablemyDrivers
    XmlObjMgt_RRelocationTable myRelocTable
    TCollection_ExtendedString myFileName
    Protected Attributes inherited from PCDM_Reader
    PCDM_ReaderStatus myReaderStatus

    Constructor & Destructor Documentation

    ◆ XmlDrivers_DocumentRetrievalDriver()

    XmlDrivers_DocumentRetrievalDriver::XmlDrivers_DocumentRetrievalDriver ( )

    Member Function Documentation

    ◆ AttributeDrivers()

    occ::handle< XmlMDF_ADriverTable > XmlDrivers_DocumentRetrievalDriver::AttributeDrivers ( const occ::handle< Message_Messenger > & theMsgDriver)
    overridevirtual

    ◆ ReadShapeSection()

    occ::handle< XmlMDF_ADriver > XmlDrivers_DocumentRetrievalDriver::ReadShapeSection ( const XmlObjMgt_Element & thePDoc,
    const occ::handle< Message_Messenger > & theMsgDriver,
    const Message_ProgressRange & theRange = Message_ProgressRange() )
    overridevirtual

    ◆ ShapeSetCleaning()

    void XmlDrivers_DocumentRetrievalDriver::ShapeSetCleaning ( const occ::handle< XmlMDF_ADriver > & theDriver)
    overridevirtual

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