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
0031 class ShapeExtend_MsgRegistrator;
0032 DEFINE_STANDARD_HANDLE(ShapeExtend_MsgRegistrator, ShapeExtend_BasicMsgRegistrator)
0033
0034 //! Attaches messages to the objects (generic Transient or shape).
0035 //! The objects of this class are transmitted to the Shape Healing
0036 //! algorithms so that they could collect messages occurred during
0037 //! processing.
0038 //!
0039 //! Messages are added to the Maps (stored as a field) that can be
0040 //! used, for instance, by Data Exchange processors to attach those
0041 //! messages to initial file entities.
0042 class ShapeExtend_MsgRegistrator : public ShapeExtend_BasicMsgRegistrator
0043 {
0044
0045 public:
0046
0047
0048   //! Creates an object.
0049   Standard_EXPORT ShapeExtend_MsgRegistrator();
0050
0051   //! Sends a message to be attached to the object.
0052   //! If the object is in the map then the message is added to the
0053   //! list, otherwise the object is firstly added to the map.
0054   Standard_EXPORT virtual void Send (const Handle(Standard_Transient)& object, const Message_Msg& message, const Message_Gravity gravity) Standard_OVERRIDE;
0055
0056   //! Sends a message to be attached to the shape.
0057   //! If the shape is in the map then the message is added to the
0058   //! list, otherwise the shape is firstly added to the map.
0059   Standard_EXPORT virtual void Send (const TopoDS_Shape& shape, const Message_Msg& message, const Message_Gravity gravity) Standard_OVERRIDE;
0060
0061   //! Returns a Map of objects and message list
0062     const ShapeExtend_DataMapOfTransientListOfMsg& MapTransient() const;
0063
0064   //! Returns a Map of shapes and message list
0065     const ShapeExtend_DataMapOfShapeListOfMsg& MapShape() const;
0066
0067
0068
0069
0070   DEFINE_STANDARD_RTTIEXT(ShapeExtend_MsgRegistrator,ShapeExtend_BasicMsgRegistrator)
0071
0072 protected:
0073
0074
0075
0076
0077 private:
0078
0079
0080   ShapeExtend_DataMapOfTransientListOfMsg myMapTransient;
0081   ShapeExtend_DataMapOfShapeListOfMsg myMapShape;
0082
0083
0084 };
0085
0086
0087 #include <ShapeExtend_MsgRegistrator.lxx>
0088
0089
0090
0091
0092
0093 #endif // _ShapeExtend_MsgRegistrator_HeaderFile