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
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
|
// This file is generated by WOK (CPPExt).
// Please do not edit this file; modify original file instead.
// The copyright and license terms as defined for the original file apply to
// this header file considered to be the "object code" form of the original source.
#ifndef _Message_Algorithm_HeaderFile
#define _Message_Algorithm_HeaderFile
#ifndef _Standard_HeaderFile
#include <Standard.hxx>
#endif
#ifndef _Standard_DefineHandle_HeaderFile
#include <Standard_DefineHandle.hxx>
#endif
#ifndef _Handle_Message_Algorithm_HeaderFile
#include <Handle_Message_Algorithm.hxx>
#endif
#ifndef _Message_ExecStatus_HeaderFile
#include <Message_ExecStatus.hxx>
#endif
#ifndef _Handle_Message_Messenger_HeaderFile
#include <Handle_Message_Messenger.hxx>
#endif
#ifndef _Handle_TColStd_HArray1OfTransient_HeaderFile
#include <Handle_TColStd_HArray1OfTransient.hxx>
#endif
#ifndef _MMgt_TShared_HeaderFile
#include <MMgt_TShared.hxx>
#endif
#ifndef _Message_Status_HeaderFile
#include <Message_Status.hxx>
#endif
#ifndef _Standard_Integer_HeaderFile
#include <Standard_Integer.hxx>
#endif
#ifndef _Standard_CString_HeaderFile
#include <Standard_CString.hxx>
#endif
#ifndef _Standard_Boolean_HeaderFile
#include <Standard_Boolean.hxx>
#endif
#ifndef _Handle_TCollection_HAsciiString_HeaderFile
#include <Handle_TCollection_HAsciiString.hxx>
#endif
#ifndef _Handle_TCollection_HExtendedString_HeaderFile
#include <Handle_TCollection_HExtendedString.hxx>
#endif
#ifndef _Message_Gravity_HeaderFile
#include <Message_Gravity.hxx>
#endif
#ifndef _Handle_TColStd_HPackedMapOfInteger_HeaderFile
#include <Handle_TColStd_HPackedMapOfInteger.hxx>
#endif
#ifndef _Handle_TColStd_HSequenceOfHExtendedString_HeaderFile
#include <Handle_TColStd_HSequenceOfHExtendedString.hxx>
#endif
class Message_Messenger;
class TColStd_HArray1OfTransient;
class TCollection_AsciiString;
class TCollection_HAsciiString;
class TCollection_ExtendedString;
class TCollection_HExtendedString;
class TColStd_HPackedMapOfInteger;
class TColStd_HSequenceOfHExtendedString;
class TColStd_SequenceOfHExtendedString;
//! Class Message_Algorithm is intended to be the base class for <br>
//! classes implementing algorithms or any operations that need <br>
//! to provide extended information on its execution to the <br>
//! caller / user. <br>
class Message_Algorithm : public MMgt_TShared {
public:
//! Empty constructor <br>
Standard_EXPORT Message_Algorithm();
//! Sets status with no parameter <br>
Standard_EXPORT void SetStatus(const Message_Status& theStat) ;
//! Sets status with integer parameter <br>
Standard_EXPORT void SetStatus(const Message_Status& theStat,const Standard_Integer theInt) ;
//! Sets status with string parameter. <br>
//! If noRepetitions is True, the parameter will be added only <br>
//! if it has not been yet recorded for the same status flag <br>
void SetStatus(const Message_Status& theStat,const Standard_CString theStr,const Standard_Boolean noRepetitions = Standard_True) ;
//! Sets status with string parameter <br>
//! If noRepetitions is True, the parameter will be added only <br>
//! if it has not been yet recorded for the same status flag <br>
void SetStatus(const Message_Status& theStat,const TCollection_AsciiString& theStr,const Standard_Boolean noRepetitions = Standard_True) ;
//! Sets status with string parameter <br>
//! If noRepetitions is True, the parameter will be added only <br>
//! if it has not been yet recorded for the same status flag <br>
void SetStatus(const Message_Status& theStat,const Handle(TCollection_HAsciiString)& theStr,const Standard_Boolean noRepetitions = Standard_True) ;
//! Sets status with string parameter <br>
//! If noRepetitions is True, the parameter will be added only <br>
//! if it has not been yet recorded for the same status flag <br>
void SetStatus(const Message_Status& theStat,const TCollection_ExtendedString& theStr,const Standard_Boolean noRepetitions = Standard_True) ;
//! Sets status with string parameter <br>
//! If noRepetitions is True, the parameter will be added only <br>
//! if it has not been yet recorded for the same status flag <br>
Standard_EXPORT void SetStatus(const Message_Status& theStat,const Handle(TCollection_HExtendedString)& theStr,const Standard_Boolean noRepetitions = Standard_True) ;
//! Returns copy of exec status of algorithm <br>
const Message_ExecStatus& GetStatus() const;
//! Returns exec status of algorithm <br>
Message_ExecStatus& ChangeStatus() ;
//! Clear exec status of algorithm <br>
Standard_EXPORT void ClearStatus() ;
//! Sets messenger to algorithm <br>
Standard_EXPORT void SetMessenger(const Handle(Message_Messenger)& theMsgr) ;
//! Returns messenger of algorithm. <br>
//! The returned handle is always non-null and can <br>
//! be used for sending messages. <br>
Handle_Message_Messenger GetMessenger() const;
//! Print messages for all status flags that have been set during <br>
//! algorithm execution, excluding statuses that are NOT set <br>
//! in theFilter. <br>
Standard_EXPORT virtual void SendStatusMessages(const Message_ExecStatus& theFilter,const Message_Gravity theTraceLevel = Message_Warning,const Standard_Integer theMaxCount = 20) const;
//! Convenient variant of SendStatusMessages() with theFilter <br>
//! having defined all WARN, ALARM, and FAIL (but not DONE) <br>
//! status flags <br>
Standard_EXPORT void SendMessages(const Message_Gravity theTraceLevel = Message_Warning,const Standard_Integer theMaxCount = 20) const;
//! Add statuses to this algorithm from other algorithm <br>
//! (including messages) <br>
Standard_EXPORT void AddStatus(const Handle(Message_Algorithm)& theOther) ;
//! Add statuses to this algorithm from other algorithm, but <br>
//! only those items are moved that correspond to statuses <br>
//! set in theStatus <br>
Standard_EXPORT void AddStatus(const Message_ExecStatus& theStatus,const Handle(Message_Algorithm)& theOther) ;
//! Return the numbers associated with the indicated status; <br>
//! Null handle if no such status or no numbers associated with it <br>
Standard_EXPORT Handle_TColStd_HPackedMapOfInteger GetMessageNumbers(const Message_Status& theStatus) const;
//! Return the strings associated with the indicated status; <br>
//! Null handle if no such status or no strings associated with it <br>
Standard_EXPORT Handle_TColStd_HSequenceOfHExtendedString GetMessageStrings(const Message_Status& theStatus) const;
//! Prepares a string containing a list of integers contained <br>
//! in theError map, but not more than theMaxCount <br>
Standard_EXPORT static TCollection_ExtendedString PrepareReport(const Handle(TColStd_HPackedMapOfInteger)& theError,const Standard_Integer theMaxCount) ;
//! Prepares a string containing a list of names contained <br>
//! in theReportSeq sequence, but not more than theMaxCount <br>
Standard_EXPORT static TCollection_ExtendedString PrepareReport(const TColStd_SequenceOfHExtendedString& theReportSeq,const Standard_Integer theMaxCount) ;
DEFINE_STANDARD_RTTI(Message_Algorithm)
protected:
Message_ExecStatus myStatus;
Handle_Message_Messenger myMessenger;
private:
Handle_TColStd_HArray1OfTransient myReportIntegers;
Handle_TColStd_HArray1OfTransient myReportStrings;
};
#include <Message_Algorithm.lxx>
// other Inline functions and methods (like "C++: function call" methods)
#endif
|
