include/opencascade/Message_Attribute.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_Attribute_HeaderFile
0015 #define _Message_Attribute_HeaderFile
0016
0017 #include <Standard_Transient.hxx>
0018 #include <NCollection_DefineAlloc.hxx>
0019 #include <TCollection_AsciiString.hxx>
0020
0021 DEFINE_STANDARD_HANDLE(Message_Attribute, Standard_Transient)
0022
0023 //! Additional information of extended alert attribute
0024 //! To provide other custom attribute container, it might be redefined.
0025 class Message_Attribute : public Standard_Transient
0026 {
0027   DEFINE_STANDARD_RTTIEXT(Message_Attribute, Standard_Transient)
0028 public:
0029   //! Empty constructor
0030   Standard_EXPORT Message_Attribute (const TCollection_AsciiString& theName = TCollection_AsciiString());
0031
0032   //! Return a C string to be used as a key for generating text user messages describing this alert.
0033   //! The messages are generated with help of Message_Msg class, in Message_Report::Dump().
0034   //! Base implementation returns dynamic type name of the instance.
0035   Standard_EXPORT virtual Standard_CString GetMessageKey() const;
0036
0037   //! Returns custom name of alert if it is set
0038   //! @return alert name
0039   const TCollection_AsciiString& GetName() const { return myName; }
0040
0041   //! Sets the custom name of alert
0042   //! @param theName a name for the alert
0043   void SetName (const TCollection_AsciiString& theName) { myName = theName; }
0044
0045   //! Dumps the content of me into the stream
0046   virtual Standard_EXPORT void DumpJson (Standard_OStream& theOStream, Standard_Integer theDepth = -1) const;
0047
0048 private:
0049   TCollection_AsciiString myName; //!< alert name, if defined is used in GetMessageKey
0050
0051 };
0052
0053 #endif // _Message_Attribute_HeaderFile