Open CASCADE Technology 7.8.2.dev
ShapeExtend_BasicMsgRegistrator Class Reference

Abstract class that can be used for attaching messages to the objects (e.g. shapes). It is used by ShapeHealing algorithms to attach a message describing encountered case (e.g. removing small edge from a wire). More...

#include <ShapeExtend_BasicMsgRegistrator.hxx>

Inheritance diagram for ShapeExtend_BasicMsgRegistrator:

Public Member Functions

 ShapeExtend_BasicMsgRegistrator ()
 Empty constructor.
 
virtual void Send (const Handle< Standard_Transient > &object, const Message_Msg &message, const Message_Gravity gravity)
 Sends a message to be attached to the object. Object can be of any type interpreted by redefined MsgRegistrator.
 
virtual void Send (const TopoDS_Shape &shape, const Message_Msg &message, const Message_Gravity gravity)
 Sends a message to be attached to the shape.
 
virtual void Send (const Message_Msg &message, const Message_Gravity gravity)
 Calls Send method with Null Transient.
 
- 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 ()
 Destructor must be virtual.
 
virtual const opencascade::handle< Standard_Type > & DynamicType () const
 Returns a type descriptor about this object.
 
Standard_Boolean IsInstance (const opencascade::handle< Standard_Type > &theType) const
 Returns a true value if this is an instance of Type.
 
Standard_Boolean IsInstance (const Standard_CString theTypeName) const
 Returns a true value if this is an instance of TypeName.
 
Standard_Boolean 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.
 
Standard_Boolean IsKind (const Standard_CString 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.
 
Standard_Integer GetRefCount () const noexcept
 Get the reference counter of this object.
 
void IncrementRefCounter () noexcept
 Increments the reference counter of this object.
 
Standard_Integer DecrementRefCounter () noexcept
 Decrements the reference counter of this object; returns the decremented value.
 
virtual void Delete () const
 Memory deallocator for transient classes.
 

Additional Inherited Members

- Public Types inherited from Standard_Transient
typedef void base_type
 Returns a type descriptor about this object.
 
- Static Public Member Functions inherited from Standard_Transient
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

Abstract class that can be used for attaching messages to the objects (e.g. shapes). It is used by ShapeHealing algorithms to attach a message describing encountered case (e.g. removing small edge from a wire).

The methods of this class are empty and redefined, for instance, in the classes for Data Exchange processors for attaching messages to interface file entities or CAS.CADE shapes.

Constructor & Destructor Documentation

◆ ShapeExtend_BasicMsgRegistrator()

ShapeExtend_BasicMsgRegistrator::ShapeExtend_BasicMsgRegistrator ( )

Empty constructor.

Member Function Documentation

◆ Send() [1/3]

virtual void ShapeExtend_BasicMsgRegistrator::Send ( const Handle< Standard_Transient > & object,
const Message_Msg & message,
const Message_Gravity gravity )
virtual

Sends a message to be attached to the object. Object can be of any type interpreted by redefined MsgRegistrator.

Reimplemented in ShapeExtend_MsgRegistrator.

◆ Send() [2/3]

virtual void ShapeExtend_BasicMsgRegistrator::Send ( const Message_Msg & message,
const Message_Gravity gravity )
virtual

Calls Send method with Null Transient.

◆ Send() [3/3]

virtual void ShapeExtend_BasicMsgRegistrator::Send ( const TopoDS_Shape & shape,
const Message_Msg & message,
const Message_Gravity gravity )
virtual

Sends a message to be attached to the shape.

Reimplemented in ShapeExtend_MsgRegistrator.


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