include/opencascade/ShapeExtend_MsgRegistrator.hxx

0001 // Created on: 2000-01-28
0002 // Created by: data exchange team
0003 // Copyright (c) 2000-2014 OPEN CASCADE SAS
0004 //
0005 // This file is part of Open CASCADE Technology software library.
0006 //
0007 // This library is free software; you can redistribute it and/or modify it under
0008 // the terms of the GNU Lesser General Public License version 2.1 as published
0009 // by the Free Software Foundation, with special exception defined in the file
0010 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
0011 // distribution for complete text of the license and disclaimer of any warranty.
0012 //
0013 // Alternatively, this file may be used under the terms of Open CASCADE
0014 // commercial license or contractual agreement.
0015
0016 #ifndef _ShapeExtend_MsgRegistrator_HeaderFile
0017 #define _ShapeExtend_MsgRegistrator_HeaderFile
0018
0019 #include <Standard.hxx>
0020 #include <Standard_Type.hxx>
0021
0022 #include <ShapeExtend_DataMapOfTransientListOfMsg.hxx>
0023 #include <ShapeExtend_DataMapOfShapeListOfMsg.hxx>
0024 #include <ShapeExtend_BasicMsgRegistrator.hxx>
0025 #include <Message_Gravity.hxx>
0026 class Standard_Transient;
0027 class Message_Msg;
0028 class TopoDS_Shape;
0029
0030 class ShapeExtend_MsgRegistrator;
0031 DEFINE_STANDARD_HANDLE(ShapeExtend_MsgRegistrator, ShapeExtend_BasicMsgRegistrator)
0032
0033 //! Attaches messages to the objects (generic Transient or shape).
0034 //! The objects of this class are transmitted to the Shape Healing
0035 //! algorithms so that they could collect messages occurred during
0036 //! processing.
0037 //!
0038 //! Messages are added to the Maps (stored as a field) that can be
0039 //! used, for instance, by Data Exchange processors to attach those
0040 //! messages to initial file entities.
0041 class ShapeExtend_MsgRegistrator : public ShapeExtend_BasicMsgRegistrator
0042 {
0043
0044 public:
0045   //! Creates an object.
0046   Standard_EXPORT ShapeExtend_MsgRegistrator();
0047
0048   //! Sends a message to be attached to the object.
0049   //! If the object is in the map then the message is added to the
0050   //! list, otherwise the object is firstly added to the map.
0051   Standard_EXPORT virtual void Send(const Handle(Standard_Transient)& object,
0052                                     const Message_Msg&                message,
0053                                     const Message_Gravity             gravity) Standard_OVERRIDE;
0054
0055   //! Sends a message to be attached to the shape.
0056   //! If the shape is in the map then the message is added to the
0057   //! list, otherwise the shape is firstly added to the map.
0058   Standard_EXPORT virtual void Send(const TopoDS_Shape&   shape,
0059                                     const Message_Msg&    message,
0060                                     const Message_Gravity gravity) Standard_OVERRIDE;
0061
0062   //! Returns a Map of objects and message list
0063   const ShapeExtend_DataMapOfTransientListOfMsg& MapTransient() const;
0064
0065   //! Returns a Map of shapes and message list
0066   const ShapeExtend_DataMapOfShapeListOfMsg& MapShape() const;
0067
0068   DEFINE_STANDARD_RTTIEXT(ShapeExtend_MsgRegistrator, ShapeExtend_BasicMsgRegistrator)
0069
0070 protected:
0071 private:
0072   ShapeExtend_DataMapOfTransientListOfMsg myMapTransient;
0073   ShapeExtend_DataMapOfShapeListOfMsg     myMapShape;
0074 };
0075
0076 #include <ShapeExtend_MsgRegistrator.lxx>
0077
0078 #endif // _ShapeExtend_MsgRegistrator_HeaderFile