include/opencascade/TopoDS_AlertAttribute.hxx

0001 // Created on: 2018-06-10
0002 // Created by: Natalia Ermolaeva
0003 // Copyright (c) 2018-2020 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 _TopoDS_AlertAttribute_HeaderFile
0017 #define _TopoDS_AlertAttribute_HeaderFile
0018
0019 #include <Message_AttributeStream.hxx>
0020 #include <Message_Messenger.hxx>
0021 #include <Message_Report.hxx>
0022
0023 #include <TopoDS_Shape.hxx>
0024
0025 class Message_Messenger;
0026
0027 //! Alert attribute object storing TopoDS shape in its field
0028 class TopoDS_AlertAttribute : public Message_AttributeStream
0029 {
0030   DEFINE_STANDARD_RTTIEXT(TopoDS_AlertAttribute, Message_AttributeStream)
0031 public:
0032   //! Constructor with shape argument
0033   Standard_EXPORT TopoDS_AlertAttribute(
0034     const TopoDS_Shape&            theShape,
0035     const TCollection_AsciiString& theName = TCollection_AsciiString());
0036
0037   //! Returns contained shape
0038   const TopoDS_Shape& GetShape() const { return myShape; }
0039
0040 public:
0041   //! Push shape information into messenger
0042   Standard_EXPORT static void Send(const Handle(Message_Messenger)& theMessenger,
0043                                    const TopoDS_Shape&              theShape);
0044
0045   //! Dumps the content of me into the stream
0046   Standard_EXPORT void DumpJson(Standard_OStream& theOStream,
0047                                 Standard_Integer  theDepth = -1) const Standard_OVERRIDE;
0048
0049 private:
0050   TopoDS_Shape myShape;
0051 };
0052
0053 inline const Handle(Message_Messenger)& operator<<(const Handle(Message_Messenger)& theMessenger,
0054                                                    const TopoDS_Shape&              theShape)
0055 {
0056   TopoDS_AlertAttribute::Send(theMessenger, theShape);
0057   return theMessenger;
0058 }
0059
0060 #endif // _TopoDS_AlertAttribute_HeaderFile