1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
|
// Created on: 2021-04-27
// Created by: Natalia ERMOLAEVA
// Copyright (c) 2021 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 MessageModel_ItemRoot_H
#define MessageModel_ItemRoot_H
#include <Message_Alert.hxx>
#include <Message_Report.hxx>
#include <NCollection_List.hxx>
#include <Standard.hxx>
#include <TCollection_AsciiString.hxx>
#include <inspector/MessageModel_ItemBase.hxx>
class MessageModel_ItemRoot;
typedef QExplicitlySharedDataPointer<MessageModel_ItemRoot> MessageModel_ItemRootPtr;
//! \struct to extend report by description
struct MessageModel_ReportInformation
{
//! Constructor
MessageModel_ReportInformation(Handle(Message_Report) theReport,
const TCollection_AsciiString& theDescription)
: myReport(theReport),
myDescription(theDescription)
{
}
Handle(Message_Report) myReport; //! report
TCollection_AsciiString myDescription; //! report description
};
//! \class MessageModel_ItemRoot
//! Collects message reports that should be visualized in tree view. Reports are cached and if
//! reports are not needed, cache should be cleared using RemoveAllReports Parent is NULL, children
//! are MessageModel_ItemReport items.
class MessageModel_ItemRoot : public MessageModel_ItemBase
{
public:
//! Creates an item wrapped by a shared pointer
static MessageModel_ItemRootPtr CreateItem(TreeModel_ItemBasePtr theParent,
const int theRow,
const int theColumn)
{
return MessageModel_ItemRootPtr(new MessageModel_ItemRoot(theParent, theRow, theColumn));
}
//! Destructor
virtual ~MessageModel_ItemRoot() Standard_OVERRIDE {};
//! Appends new report
//! \param theReport a report instance
//! \param theReportDescription an additional report information
void AddReport(const Handle(Message_Report)& theReport,
const TCollection_AsciiString& theReportDescription)
{
myReports.Append(MessageModel_ReportInformation(theReport, theReportDescription));
}
//! Set report, se it into the given row index
//! \param theRowId a report child row
//! \param theReport a report instance
//! \param theReportDescription an additional report information
Standard_EXPORT void SetReport(const int theRowId,
const Handle(Message_Report)& theReport,
const TCollection_AsciiString& theReportDescription = "");
//! Returns true if report exists is in the list of the current reports
//! \param theReport a report instance
//! \return boolean value
Standard_EXPORT Standard_Boolean HasReport(const Handle(Message_Report)& theReport);
//!< Returns processed reports
const NCollection_List<MessageModel_ReportInformation>& Reports() const { return myReports; }
//! Clears internal container of added reports
void RemoveAllReports() { myReports.Clear(); }
//! Returns report by the number
//! \param theRowId an index of the report in the internal container.
Standard_EXPORT const Handle(Message_Report)& GetReport(
const int theRowId,
TCollection_AsciiString& theReportDescription);
//! Set the item name
//! \param theName text value
void SetName(const TCollection_AsciiString& theName) { myName = theName; }
protected:
//! Return data value for the role.
//! \param theRole a value role
//! \return the value
virtual QVariant initValue(const int theRole) const Standard_OVERRIDE;
//! \return number of children.
virtual int initRowCount() const Standard_OVERRIDE { return myReports.Size(); }
//! Creates a child item in the given position.
//! \param theRow the child row position
//! \param theColumn the child column position
//! \return the created item
virtual TreeModel_ItemBasePtr createChild(int theRow, int theColumn) Standard_OVERRIDE;
private:
//! Constructor
//! param theParent a parent item
MessageModel_ItemRoot(TreeModel_ItemBasePtr theParent, const int theRow, const int theColumn)
: MessageModel_ItemBase(theParent, theRow, theColumn)
{
}
private:
NCollection_List<MessageModel_ReportInformation> myReports; //!< reports sent by algorithms
TCollection_AsciiString myName; //!< DisplayRole data, if defined
};
#endif
|
