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

    Alert object storing TopoDS shape in its field. More...

    #include <TopoDS_AlertWithShape.hxx>

    Inheritance diagram for TopoDS_AlertWithShape:

    Public Member Functions

     TopoDS_AlertWithShape (const TopoDS_Shape &theShape)
     Constructor with shape argument.
    const TopoDS_ShapeGetShape () const
     Returns contained shape.
    void SetShape (const TopoDS_Shape &theShape)
     Sets the shape.
    bool SupportsMerge () const override
     Returns false.
    bool Merge (const occ::handle< Message_Alert > &theTarget) override
     Returns false.
    Public Member Functions inherited from Message_Alert
    virtual const char * GetMessageKey () const
     Return a C string to be used as a key for generating text user messages describing this alert. The messages are generated with help of Message_Msg class, in Message_Report::Dump(). Base implementation returns dynamic type name of the instance.
    virtual void DumpJson (Standard_OStream &theOStream, int theDepth=-1) const
     Dumps the content of me into the stream.
    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

    Alert object storing TopoDS shape in its field.

    Constructor & Destructor Documentation

    ◆ TopoDS_AlertWithShape()

    TopoDS_AlertWithShape::TopoDS_AlertWithShape ( const TopoDS_Shape & theShape)

    Constructor with shape argument.

    Member Function Documentation

    ◆ GetShape()

    const TopoDS_Shape & TopoDS_AlertWithShape::GetShape ( ) const
    inline

    Returns contained shape.

    ◆ Merge()

    bool TopoDS_AlertWithShape::Merge ( const occ::handle< Message_Alert > & theTarget)
    overridevirtual

    Returns false.

    Reimplemented from Message_Alert.

    ◆ SetShape()

    void TopoDS_AlertWithShape::SetShape ( const TopoDS_Shape & theShape)
    inline

    Sets the shape.

    ◆ SupportsMerge()

    bool TopoDS_AlertWithShape::SupportsMerge ( ) const
    overridevirtual

    Returns false.

    Reimplemented from Message_Alert.


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