Open CASCADE Technology  7.3.1.dev
Public Member Functions
ShapeExtend_MsgRegistrator Class Reference

Attaches messages to the objects (generic Transient or shape). The objects of this class are transmitted to the Shape Healing algorithms so that they could collect messages occurred during processing. More...

#include <ShapeExtend_MsgRegistrator.hxx>

Inheritance diagram for ShapeExtend_MsgRegistrator:
Inheritance graph
[legend]

Public Member Functions

 ShapeExtend_MsgRegistrator ()
 Creates an object. More...
 
virtual void Send (const Handle< Standard_Transient > &object, const Message_Msg &message, const Message_Gravity gravity) override
 Sends a message to be attached to the object. If the object is in the map then the message is added to the list, otherwise the object is firstly added to the map. More...
 
virtual void Send (const TopoDS_Shape &shape, const Message_Msg &message, const Message_Gravity gravity) override
 Sends a message to be attached to the shape. If the shape is in the map then the message is added to the list, otherwise the shape is firstly added to the map. More...
 
const ShapeExtend_DataMapOfTransientListOfMsgMapTransient () const
 Returns a Map of objects and message list. More...
 
const ShapeExtend_DataMapOfShapeListOfMsgMapShape () const
 Returns a Map of shapes and message list. More...
 
- Public Member Functions inherited from ShapeExtend_BasicMsgRegistrator
 ShapeExtend_BasicMsgRegistrator ()
 Empty constructor. More...
 
virtual void Send (const Message_Msg &message, const Message_Gravity gravity)
 Calls Send method with Null Transient. More...
 
- Public Member Functions inherited from Standard_Transient
 Standard_Transient ()
 Empty constructor. More...
 
 Standard_Transient (const Standard_Transient &)
 Copy constructor – does nothing. More...
 
Standard_Transientoperator= (const Standard_Transient &)
 Assignment operator, needed to avoid copying reference counter. More...
 
virtual ~Standard_Transient ()
 Destructor must be virtual. More...
 
virtual void Delete () const
 Memory deallocator for transient classes. More...
 
virtual const opencascade::handle< Standard_Type > & DynamicType () const
 Returns a type descriptor about this object. More...
 
Standard_Boolean IsInstance (const opencascade::handle< Standard_Type > &theType) const
 Returns a true value if this is an instance of Type. More...
 
Standard_Boolean IsInstance (const Standard_CString theTypeName) const
 Returns a true value if this is an instance of TypeName. More...
 
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. More...
 
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. More...
 
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. More...
 
Standard_Integer GetRefCount () const
 Get the reference counter of this object. More...
 
void IncrementRefCounter () const
 Increments the reference counter of this object. More...
 
Standard_Integer DecrementRefCounter () const
 Decrements the reference counter of this object; returns the decremented value. More...
 

Additional Inherited Members

- Public Types inherited from Standard_Transient
typedef void base_type
 Returns a type descriptor about this object. More...
 
- Static Public Member Functions inherited from Standard_Transient
static const char * get_type_name ()
 Returns a type descriptor about this object. More...
 
static const opencascade::handle< Standard_Type > & get_type_descriptor ()
 Returns type descriptor of Standard_Transient class. More...
 

Detailed Description

Attaches messages to the objects (generic Transient or shape). The objects of this class are transmitted to the Shape Healing algorithms so that they could collect messages occurred during processing.

Messages are added to the Maps (stored as a field) that can be used, for instance, by Data Exchange processors to attach those messages to initial file entities.

Constructor & Destructor Documentation

◆ ShapeExtend_MsgRegistrator()

ShapeExtend_MsgRegistrator::ShapeExtend_MsgRegistrator ( )

Creates an object.

Member Function Documentation

◆ MapShape()

const ShapeExtend_DataMapOfShapeListOfMsg& ShapeExtend_MsgRegistrator::MapShape ( ) const

Returns a Map of shapes and message list.

◆ MapTransient()

const ShapeExtend_DataMapOfTransientListOfMsg& ShapeExtend_MsgRegistrator::MapTransient ( ) const

Returns a Map of objects and message list.

◆ Send() [1/2]

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

Sends a message to be attached to the object. If the object is in the map then the message is added to the list, otherwise the object is firstly added to the map.

Reimplemented from ShapeExtend_BasicMsgRegistrator.

◆ Send() [2/2]

virtual void ShapeExtend_MsgRegistrator::Send ( const TopoDS_Shape shape,
const Message_Msg message,
const Message_Gravity  gravity 
)
overridevirtual

Sends a message to be attached to the shape. If the shape is in the map then the message is added to the list, otherwise the shape is firstly added to the map.

Reimplemented from ShapeExtend_BasicMsgRegistrator.


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