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

    #include <XmlTObjDrivers_DocumentStorageDriver.hxx>

    Inheritance diagram for XmlTObjDrivers_DocumentStorageDriver:

    Public Member Functions

     XmlTObjDrivers_DocumentStorageDriver (const TCollection_ExtendedString &theCopyright)
    occ::handle< XmlMDF_ADriverTableAttributeDrivers (const occ::handle< Message_Messenger > &theMsgDriver) override
    Public Member Functions inherited from XmlLDrivers_DocumentStorageDriver
     XmlLDrivers_DocumentStorageDriver (const TCollection_ExtendedString &theCopyright)
    void Write (const occ::handle< CDM_Document > &theDocument, const TCollection_ExtendedString &theFileName, const Message_ProgressRange &theRange=Message_ProgressRange()) override
     Warning! raises DriverError if an error occurs during inside the Make method. stores the content of the Document into a new file.
    void Write (const occ::handle< CDM_Document > &theDocument, Standard_OStream &theOStream, const Message_ProgressRange &theRange=Message_ProgressRange()) override
     Write <theDocument> to theOStream.
    Public Member Functions inherited from PCDM_StorageDriver
    virtual occ::handle< PCDM_DocumentMake (const occ::handle< CDM_Document > &aDocument)
     raises NotImplemented.
    virtual void Make (const occ::handle< CDM_Document > &aDocument, NCollection_Sequence< occ::handle< PCDM_Document > > &Documents)
     By default, puts in the Sequence the document returns by the previous Make method.
    void SetFormat (const TCollection_ExtendedString &aformat)
    TCollection_ExtendedString GetFormat () const
    bool IsError () const
    void SetIsError (const bool theIsError)
    PCDM_StoreStatus GetStoreStatus () const
    void SetStoreStatus (const PCDM_StoreStatus theStoreStatus)
    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 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_DocumentStorageDriver
    virtual bool WriteToDomDocument (const occ::handle< CDM_Document > &theDocument, XmlObjMgt_Element &thePDoc, const Message_ProgressRange &theRange=Message_ProgressRange())
    virtual int MakeDocument (const occ::handle< CDM_Document > &theDocument, XmlObjMgt_Element &thePDoc, const Message_ProgressRange &theRange=Message_ProgressRange())
    void AddNamespace (const TCollection_AsciiString &thePrefix, const TCollection_AsciiString &theURI)
    virtual bool WriteShapeSection (XmlObjMgt_Element &thePDoc, const TDocStd_FormatVersion theStorageFormatVersion, const Message_ProgressRange &theRange=Message_ProgressRange())
    Protected Attributes inherited from XmlLDrivers_DocumentStorageDriver
    occ::handle< XmlMDF_ADriverTablemyDrivers
    XmlObjMgt_SRelocationTable myRelocTable

    Constructor & Destructor Documentation

    ◆ XmlTObjDrivers_DocumentStorageDriver()

    XmlTObjDrivers_DocumentStorageDriver::XmlTObjDrivers_DocumentStorageDriver ( const TCollection_ExtendedString & theCopyright)

    Member Function Documentation

    ◆ AttributeDrivers()

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

    Reimplemented from XmlLDrivers_DocumentStorageDriver.


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