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
    XmlMDF_ADriver Class Referenceabstract

    Attribute Storage/Retrieval Driver. More...

    #include <XmlMDF_ADriver.hxx>

    Inheritance diagram for XmlMDF_ADriver:

    Public Member Functions

    virtual int VersionNumber () const
     Returns the version number from which the driver is available.
    virtual occ::handle< TDF_AttributeNewEmpty () const =0
     Creates a new attribute from TDF.
    virtual occ::handle< Standard_TypeSourceType () const
     Returns the type of source object, inheriting from Attribute from TDF.
    const TCollection_AsciiStringTypeName () const
     Returns the full XML tag name (including NS prefix).
    const TCollection_AsciiStringNamespace () const
     Returns the namespace string.
    virtual bool Paste (const XmlObjMgt_Persistent &aSource, const occ::handle< TDF_Attribute > &aTarget, XmlObjMgt_RRelocationTable &aRelocTable) const =0
     Translate the contents of <aSource> and put it into <aTarget>, using the relocation table <aRelocTable> to keep the sharings.
    virtual void Paste (const occ::handle< TDF_Attribute > &aSource, XmlObjMgt_Persistent &aTarget, XmlObjMgt_SRelocationTable &aRelocTable) const =0
     Translate the contents of <aSource> and put it into <aTarget>, using the relocation table <aRelocTable> to keep the sharings.
    const occ::handle< Message_Messenger > & MessageDriver () const
     Returns the current message driver of this driver.
    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.

    Protected Member Functions

     XmlMDF_ADriver (const occ::handle< Message_Messenger > &theMessageDriver, const char *const theNamespace, const char *const theName=nullptr)

    Protected Attributes

    TCollection_AsciiString myTypeName
    TCollection_AsciiString myNamespace
    occ::handle< Message_MessengermyMessageDriver

    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.

    Detailed Description

    Attribute Storage/Retrieval Driver.

    Constructor & Destructor Documentation

    ◆ XmlMDF_ADriver()

    XmlMDF_ADriver::XmlMDF_ADriver ( const occ::handle< Message_Messenger > & theMessageDriver,
    const char *const theNamespace,
    const char *const theName = nullptr )
    protected

    Member Function Documentation

    ◆ MessageDriver()

    const occ::handle< Message_Messenger > & XmlMDF_ADriver::MessageDriver ( ) const
    inline

    Returns the current message driver of this driver.

    ◆ Namespace()

    const TCollection_AsciiString & XmlMDF_ADriver::Namespace ( ) const
    inline

    Returns the namespace string.

    ◆ NewEmpty()

    virtual occ::handle< TDF_Attribute > XmlMDF_ADriver::NewEmpty ( ) const
    pure virtual

    Creates a new attribute from TDF.

    Implemented in XmlMDataStd_AsciiStringDriver, XmlMDataStd_BooleanArrayDriver, XmlMDataStd_BooleanListDriver, XmlMDataStd_ByteArrayDriver, XmlMDataStd_ExpressionDriver, XmlMDataStd_ExtStringArrayDriver, XmlMDataStd_ExtStringListDriver, XmlMDataStd_GenericEmptyDriver, XmlMDataStd_GenericExtStringDriver, XmlMDataStd_IntegerArrayDriver, XmlMDataStd_IntegerDriver, XmlMDataStd_IntegerListDriver, XmlMDataStd_IntPackedMapDriver, XmlMDataStd_NamedDataDriver, XmlMDataStd_RealArrayDriver, XmlMDataStd_RealDriver, XmlMDataStd_RealListDriver, XmlMDataStd_ReferenceArrayDriver, XmlMDataStd_ReferenceListDriver, XmlMDataStd_TreeNodeDriver, XmlMDataStd_UAttributeDriver, XmlMDataStd_VariableDriver, XmlMDataXtd_ConstraintDriver, XmlMDataXtd_GeometryDriver, XmlMDataXtd_PatternStdDriver, XmlMDataXtd_PositionDriver, XmlMDataXtd_PresentationDriver, XmlMDataXtd_TriangulationDriver, XmlMDF_DerivedDriver, XmlMDF_ReferenceDriver, XmlMDF_TagSourceDriver, XmlMDocStd_XLinkDriver, XmlMFunction_FunctionDriver, XmlMFunction_GraphNodeDriver, XmlMFunction_ScopeDriver, XmlMNaming_NamedShapeDriver, XmlMNaming_NamingDriver, XmlMXCAFDoc_AssemblyItemRefDriver, XmlMXCAFDoc_CentroidDriver, XmlMXCAFDoc_ColorDriver, XmlMXCAFDoc_DatumDriver, XmlMXCAFDoc_DimTolDriver, XmlMXCAFDoc_GraphNodeDriver, XmlMXCAFDoc_LengthUnitDriver, XmlMXCAFDoc_LocationDriver, XmlMXCAFDoc_MaterialDriver, XmlMXCAFDoc_NoteBinDataDriver, XmlMXCAFDoc_NoteCommentDriver, XmlMXCAFDoc_VisMaterialDriver, XmlMXCAFDoc_VisMaterialToolDriver, XmlTObjDrivers_IntSparseArrayDriver, XmlTObjDrivers_ModelDriver, XmlTObjDrivers_ObjectDriver, XmlTObjDrivers_ReferenceDriver, and XmlTObjDrivers_XYZDriver.

    ◆ Paste() [1/2]

    virtual void XmlMDF_ADriver::Paste ( const occ::handle< TDF_Attribute > & aSource,
    XmlObjMgt_Persistent & aTarget,
    XmlObjMgt_SRelocationTable & aRelocTable ) const
    pure virtual

    Translate the contents of <aSource> and put it into <aTarget>, using the relocation table <aRelocTable> to keep the sharings.

    Implemented in XmlMDataStd_AsciiStringDriver, XmlMDataStd_BooleanArrayDriver, XmlMDataStd_BooleanListDriver, XmlMDataStd_ByteArrayDriver, XmlMDataStd_ExpressionDriver, XmlMDataStd_ExtStringArrayDriver, XmlMDataStd_ExtStringListDriver, XmlMDataStd_GenericEmptyDriver, XmlMDataStd_GenericExtStringDriver, XmlMDataStd_IntegerArrayDriver, XmlMDataStd_IntegerDriver, XmlMDataStd_IntegerListDriver, XmlMDataStd_IntPackedMapDriver, XmlMDataStd_NamedDataDriver, XmlMDataStd_RealArrayDriver, XmlMDataStd_RealDriver, XmlMDataStd_RealListDriver, XmlMDataStd_ReferenceArrayDriver, XmlMDataStd_ReferenceListDriver, XmlMDataStd_TreeNodeDriver, XmlMDataStd_UAttributeDriver, XmlMDataStd_VariableDriver, XmlMDataXtd_ConstraintDriver, XmlMDataXtd_GeometryDriver, XmlMDataXtd_PatternStdDriver, XmlMDataXtd_PositionDriver, XmlMDataXtd_PresentationDriver, XmlMDataXtd_TriangulationDriver, XmlMDF_DerivedDriver, XmlMDF_ReferenceDriver, XmlMDF_TagSourceDriver, XmlMDocStd_XLinkDriver, XmlMFunction_FunctionDriver, XmlMFunction_GraphNodeDriver, XmlMFunction_ScopeDriver, XmlMNaming_NamedShapeDriver, XmlMNaming_NamingDriver, XmlMXCAFDoc_AssemblyItemRefDriver, XmlMXCAFDoc_CentroidDriver, XmlMXCAFDoc_ColorDriver, XmlMXCAFDoc_DatumDriver, XmlMXCAFDoc_DimTolDriver, XmlMXCAFDoc_GraphNodeDriver, XmlMXCAFDoc_LengthUnitDriver, XmlMXCAFDoc_LocationDriver, XmlMXCAFDoc_MaterialDriver, XmlMXCAFDoc_NoteBinDataDriver, XmlMXCAFDoc_NoteCommentDriver, XmlMXCAFDoc_NoteDriver, XmlMXCAFDoc_VisMaterialDriver, XmlMXCAFDoc_VisMaterialToolDriver, XmlTObjDrivers_IntSparseArrayDriver, XmlTObjDrivers_ModelDriver, XmlTObjDrivers_ObjectDriver, XmlTObjDrivers_ReferenceDriver, and XmlTObjDrivers_XYZDriver.

    ◆ Paste() [2/2]

    virtual bool XmlMDF_ADriver::Paste ( const XmlObjMgt_Persistent & aSource,
    const occ::handle< TDF_Attribute > & aTarget,
    XmlObjMgt_RRelocationTable & aRelocTable ) const
    pure virtual

    Translate the contents of <aSource> and put it into <aTarget>, using the relocation table <aRelocTable> to keep the sharings.

    Implemented in XmlMDataStd_AsciiStringDriver, XmlMDataStd_BooleanArrayDriver, XmlMDataStd_BooleanListDriver, XmlMDataStd_ByteArrayDriver, XmlMDataStd_ExpressionDriver, XmlMDataStd_ExtStringArrayDriver, XmlMDataStd_ExtStringListDriver, XmlMDataStd_GenericEmptyDriver, XmlMDataStd_GenericExtStringDriver, XmlMDataStd_IntegerArrayDriver, XmlMDataStd_IntegerDriver, XmlMDataStd_IntegerListDriver, XmlMDataStd_IntPackedMapDriver, XmlMDataStd_NamedDataDriver, XmlMDataStd_RealArrayDriver, XmlMDataStd_RealDriver, XmlMDataStd_RealListDriver, XmlMDataStd_ReferenceArrayDriver, XmlMDataStd_ReferenceListDriver, XmlMDataStd_TreeNodeDriver, XmlMDataStd_UAttributeDriver, XmlMDataStd_VariableDriver, XmlMDataXtd_ConstraintDriver, XmlMDataXtd_GeometryDriver, XmlMDataXtd_PatternStdDriver, XmlMDataXtd_PositionDriver, XmlMDataXtd_PresentationDriver, XmlMDataXtd_TriangulationDriver, XmlMDF_DerivedDriver, XmlMDF_ReferenceDriver, XmlMDF_TagSourceDriver, XmlMDocStd_XLinkDriver, XmlMFunction_FunctionDriver, XmlMFunction_GraphNodeDriver, XmlMFunction_ScopeDriver, XmlMNaming_NamedShapeDriver, XmlMNaming_NamingDriver, XmlMXCAFDoc_AssemblyItemRefDriver, XmlMXCAFDoc_CentroidDriver, XmlMXCAFDoc_ColorDriver, XmlMXCAFDoc_DatumDriver, XmlMXCAFDoc_DimTolDriver, XmlMXCAFDoc_GraphNodeDriver, XmlMXCAFDoc_LengthUnitDriver, XmlMXCAFDoc_LocationDriver, XmlMXCAFDoc_MaterialDriver, XmlMXCAFDoc_NoteBinDataDriver, XmlMXCAFDoc_NoteCommentDriver, XmlMXCAFDoc_NoteDriver, XmlMXCAFDoc_VisMaterialDriver, XmlMXCAFDoc_VisMaterialToolDriver, XmlTObjDrivers_IntSparseArrayDriver, XmlTObjDrivers_ModelDriver, XmlTObjDrivers_ObjectDriver, XmlTObjDrivers_ReferenceDriver, and XmlTObjDrivers_XYZDriver.

    ◆ SourceType()

    virtual occ::handle< Standard_Type > XmlMDF_ADriver::SourceType ( ) const
    virtual

    Returns the type of source object, inheriting from Attribute from TDF.

    Reimplemented in XmlMDataStd_GenericEmptyDriver, and XmlMDataStd_GenericExtStringDriver.

    ◆ TypeName()

    const TCollection_AsciiString & XmlMDF_ADriver::TypeName ( ) const

    Returns the full XML tag name (including NS prefix).

    ◆ VersionNumber()

    virtual int XmlMDF_ADriver::VersionNumber ( ) const
    virtual

    Returns the version number from which the driver is available.

    Field Documentation

    ◆ myMessageDriver

    occ::handle<Message_Messenger> XmlMDF_ADriver::myMessageDriver
    protected

    ◆ myNamespace

    TCollection_AsciiString XmlMDF_ADriver::myNamespace
    protected

    ◆ myTypeName

    TCollection_AsciiString XmlMDF_ADriver::myTypeName
    protected

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