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

    This class allows to store a redefinable Graph, via a Handle (useful for an Object which can work on several successive Models, with the same general conditions). More...

    #include <Interface_HGraph.hxx>

    Inheritance diagram for Interface_HGraph:

    Public Member Functions

     Interface_HGraph (const Interface_Graph &agraph)
     Creates an HGraph directly from a Graph. Remark that the starting Graph is duplicated.
     Interface_HGraph (const occ::handle< Interface_InterfaceModel > &amodel, const Interface_GeneralLib &lib, const bool theModeStats=true)
     Creates an HGraph with a Graph created from <amodel> and <lib>.
     Interface_HGraph (const occ::handle< Interface_InterfaceModel > &amodel, const occ::handle< Interface_Protocol > &protocol, const bool theModeStats=true)
     Creates an HGraph with a graph itself created from <amodel> and <protocol>.
     Interface_HGraph (const occ::handle< Interface_InterfaceModel > &amodel, const occ::handle< Interface_GTool > &gtool, const bool theModeStats=true)
     Creates an HGraph with a graph itself created from <amodel> and <protocol>.
     Interface_HGraph (const occ::handle< Interface_InterfaceModel > &amodel, const bool theModeStats=true)
     Same a above, but works with the GTool in the model.
    const Interface_GraphGraph () const
     Returns the Graph contained in <me>, for Read Only Operations Remark that it is returns as "const &" Getting it in a new variable instead of a reference would be a pity, because all the graph's content would be duplicated.
    Interface_GraphCGraph ()
     Same as above, but for Read-Write Operations Then, The Graph will be modified in the HGraph itself.
    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.

    Detailed Description

    This class allows to store a redefinable Graph, via a Handle (useful for an Object which can work on several successive Models, with the same general conditions).

    Constructor & Destructor Documentation

    ◆ Interface_HGraph() [1/5]

    Interface_HGraph::Interface_HGraph ( const Interface_Graph & agraph)

    Creates an HGraph directly from a Graph. Remark that the starting Graph is duplicated.

    ◆ Interface_HGraph() [2/5]

    Interface_HGraph::Interface_HGraph ( const occ::handle< Interface_InterfaceModel > & amodel,
    const Interface_GeneralLib & lib,
    const bool theModeStats = true )

    Creates an HGraph with a Graph created from <amodel> and <lib>.

    ◆ Interface_HGraph() [3/5]

    Interface_HGraph::Interface_HGraph ( const occ::handle< Interface_InterfaceModel > & amodel,
    const occ::handle< Interface_Protocol > & protocol,
    const bool theModeStats = true )

    Creates an HGraph with a graph itself created from <amodel> and <protocol>.

    ◆ Interface_HGraph() [4/5]

    Interface_HGraph::Interface_HGraph ( const occ::handle< Interface_InterfaceModel > & amodel,
    const occ::handle< Interface_GTool > & gtool,
    const bool theModeStats = true )

    Creates an HGraph with a graph itself created from <amodel> and <protocol>.

    ◆ Interface_HGraph() [5/5]

    Interface_HGraph::Interface_HGraph ( const occ::handle< Interface_InterfaceModel > & amodel,
    const bool theModeStats = true )

    Same a above, but works with the GTool in the model.

    Member Function Documentation

    ◆ CGraph()

    Interface_Graph & Interface_HGraph::CGraph ( )

    Same as above, but for Read-Write Operations Then, The Graph will be modified in the HGraph itself.

    ◆ Graph()

    const Interface_Graph & Interface_HGraph::Graph ( ) const

    Returns the Graph contained in <me>, for Read Only Operations Remark that it is returns as "const &" Getting it in a new variable instead of a reference would be a pity, because all the graph's content would be duplicated.


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