include/opencascade/Message_AttributeStream.hxx

0001 // Copyright (c) 2020 OPEN CASCADE SAS
0002 //
0003 // This file is part of Open CASCADE Technology software library.
0004 //
0005 // This library is free software; you can redistribute it and/or modify it under
0006 // the terms of the GNU Lesser General Public License version 2.1 as published
0007 // by the Free Software Foundation, with special exception defined in the file
0008 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
0009 // distribution for complete text of the license and disclaimer of any warranty.
0010 //
0011 // Alternatively, this file may be used under the terms of Open CASCADE
0012 // commercial license or contractual agreement.
0013
0014 #ifndef _Message_AttributeStream_HeaderFile
0015 #define _Message_AttributeStream_HeaderFile
0016
0017 #include <Message_Attribute.hxx>
0018
0019 #include <Standard_SStream.hxx>
0020
0021 //! Alert object storing stream value
0022 class Message_AttributeStream : public Message_Attribute
0023 {
0024   DEFINE_STANDARD_RTTIEXT(Message_AttributeStream, Message_Attribute)
0025 public:
0026
0027   //! Constructor with string argument
0028   Standard_EXPORT Message_AttributeStream (const Standard_SStream& theStream,
0029                                            const TCollection_AsciiString& theName = TCollection_AsciiString());
0030
0031   //! Returns stream value
0032   const Standard_SStream& Stream() const { return myStream; }
0033
0034   //! Sets stream value
0035   Standard_EXPORT void SetStream (const Standard_SStream& theStream);
0036
0037   //! Dumps the content of me into the stream
0038   virtual Standard_EXPORT void DumpJson (Standard_OStream& theOStream,
0039                                          Standard_Integer theDepth = -1) const Standard_OVERRIDE;
0040
0041 private:
0042   Standard_SStream myStream; //!< container of values
0043 };
0044
0045 #endif // _Message_AttributeStream_HeaderFile