mirror of
https://git.dev.opencascade.org/repos/occt.git
synced 2025-05-06 10:36:12 +03:00
6522304c17
- Added possibility to send stream information and transient object into Message_Messenger. Message_Printer will process it if needed. - Add Message_PrinterToReport to send messenger information into Message_Report. - Extended Message_Report to collect hierarchical alerts, to be able to collect some metrics during alerts processing. - Added Message_AlertExtended to prepare hierarchical alerts with custom attributes. One attribute for one alert. - Added Message_CompositeAlerts class to handle a container of alerts. - Added Message_Level to start a new hierarchical level by creating an instance, stop by destricting. - Added Message_Attribute and inheritors to store custom information about alert like object, stream, shape, some metrics. - Implement Message_AttributeAlert to collect start/stop information about active metrics of Message_Report. This kind of attribute is created if at least one metric is active in the report. - Add Message_MetricType enumeration with possible kinds of metrics in report. - Implement DumpJson for Message_Report to store all collected alerts into stream. - Added draw commands for Message_Report, Message_Messenger.
53 lines
2.1 KiB
C++
53 lines
2.1 KiB
C++
// Copyright (c) 2020 OPEN CASCADE SAS
|
|
//
|
|
// This file is part of Open CASCADE Technology software library.
|
|
//
|
|
// This library is free software; you can redistribute it and/or modify it under
|
|
// the terms of the GNU Lesser General Public License version 2.1 as published
|
|
// by the Free Software Foundation, with special exception defined in the file
|
|
// OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
|
|
// distribution for complete text of the license and disclaimer of any warranty.
|
|
//
|
|
// Alternatively, this file may be used under the terms of Open CASCADE
|
|
// commercial license or contractual agreement.
|
|
|
|
#ifndef _Message_Attribute_HeaderFile
|
|
#define _Message_Attribute_HeaderFile
|
|
|
|
#include <Standard_Transient.hxx>
|
|
#include <TCollection_AsciiString.hxx>
|
|
|
|
DEFINE_STANDARD_HANDLE(Message_Attribute, Standard_Transient)
|
|
|
|
//! Additional information of extended alert attribute
|
|
//! To provide other custom attribute container, it might be redefined.
|
|
class Message_Attribute : public Standard_Transient
|
|
{
|
|
DEFINE_STANDARD_RTTIEXT(Message_Attribute, Standard_Transient)
|
|
public:
|
|
//! Empty constructor
|
|
Standard_EXPORT Message_Attribute (const TCollection_AsciiString& theName = TCollection_AsciiString());
|
|
|
|
//! Return a C string to be used as a key for generating text user messages describing this alert.
|
|
//! The messages are generated with help of Message_Msg class, in Message_Report::Dump().
|
|
//! Base implementation returns dynamic type name of the instance.
|
|
Standard_EXPORT virtual Standard_CString GetMessageKey() const;
|
|
|
|
//! Returns custom name of alert if it is set
|
|
//! @return alert name
|
|
const TCollection_AsciiString& GetName() const { return myName; }
|
|
|
|
//! Sets the custom name of alert
|
|
//! @param theName a name for the alert
|
|
void SetName (const TCollection_AsciiString& theName) { myName = theName; }
|
|
|
|
//! Dumps the content of me into the stream
|
|
virtual Standard_EXPORT void DumpJson (Standard_OStream& theOStream, Standard_Integer theDepth = -1) const;
|
|
|
|
private:
|
|
TCollection_AsciiString myName; //!< alert name, if defined is used in GetMessageKey
|
|
|
|
};
|
|
|
|
#endif // _Message_Attribute_HeaderFile
|