include/opencascade/ShapeExtend_BasicMsgRegistrator.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_BasicMsgRegistrator_HeaderFile
0017 #define _ShapeExtend_BasicMsgRegistrator_HeaderFile
0018
0019 #include <Standard.hxx>
0020 #include <Standard_Type.hxx>
0021
0022 #include <Standard_Transient.hxx>
0023 #include <Message_Gravity.hxx>
0024 class Message_Msg;
0025 class TopoDS_Shape;
0026
0027
0028 class ShapeExtend_BasicMsgRegistrator;
0029 DEFINE_STANDARD_HANDLE(ShapeExtend_BasicMsgRegistrator, Standard_Transient)
0030
0031 //! Abstract class that can be used for attaching messages
0032 //! to the objects (e.g. shapes).
0033 //! It is used by ShapeHealing algorithms to attach a message
0034 //! describing encountered case (e.g. removing small edge from
0035 //! a wire).
0036 //!
0037 //! The methods of this class are empty and redefined, for instance,
0038 //! in the classes for Data Exchange processors for attaching
0039 //! messages to interface file entities or CAS.CADE shapes.
0040 class ShapeExtend_BasicMsgRegistrator : public Standard_Transient
0041 {
0042
0043 public:
0044
0045
0046   //! Empty constructor.
0047   Standard_EXPORT ShapeExtend_BasicMsgRegistrator();
0048
0049   //! Sends a message to be attached to the object.
0050   //! Object can be of any type interpreted by redefined MsgRegistrator.
0051   Standard_EXPORT virtual void Send (const Handle(Standard_Transient)& object, const Message_Msg& message, const Message_Gravity gravity);
0052
0053   //! Sends a message to be attached to the shape.
0054   Standard_EXPORT virtual void Send (const TopoDS_Shape& shape, const Message_Msg& message, const Message_Gravity gravity);
0055
0056   //! Calls Send method with Null Transient.
0057   Standard_EXPORT virtual void Send (const Message_Msg& message, const Message_Gravity gravity);
0058
0059
0060
0061
0062   DEFINE_STANDARD_RTTIEXT(ShapeExtend_BasicMsgRegistrator,Standard_Transient)
0063
0064 protected:
0065
0066
0067
0068
0069 private:
0070
0071
0072
0073
0074 };
0075
0076
0077
0078
0079
0080
0081
0082 #endif // _ShapeExtend_BasicMsgRegistrator_HeaderFile