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
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
|
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/processing/qgsprocessingfeedback.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
class QgsProcessingFeedback : QgsFeedback
{
%Docstring(signature="appended")
Base class for providing feedback from a processing algorithm.
This base class implementation silently ignores all feedback reported by
algorithms. Subclasses of :py:class:`QgsProcessingFeedback` can be used
to log this feedback or report it to users via the GUI.
%End
%TypeHeaderCode
#include "qgsprocessingfeedback.h"
%End
public:
QgsProcessingFeedback( bool logFeedback = true );
%Docstring
Constructor for QgsProcessingFeedback.
If ``logFeedback`` is ``True``, then all feedback received will be
directed to :py:class:`QgsMessageLog`.
%End
virtual void setProgressText( const QString &text );
%Docstring
Sets a progress report text string. This can be used in conjunction with
:py:func:`~QgsProcessingFeedback.setProgress` to provide detailed
progress reports, such as "Transformed 4 of 5 layers".
.. seealso:: :py:func:`setProgress`
%End
virtual void reportError( const QString &error, bool fatalError = false );
%Docstring
Reports that the algorithm encountered an ``error`` while executing.
If ``fatalError`` is ``True`` then the error prevented the algorithm
from executing.
%End
virtual void pushWarning( const QString &warning );
%Docstring
Pushes a warning informational message from the algorithm. This should
only be used sparsely as to maintain the importance of visual queues
associated to this type of message.
.. seealso:: :py:func:`pushInfo`
.. seealso:: :py:func:`pushCommandInfo`
.. seealso:: :py:func:`pushDebugInfo`
.. seealso:: :py:func:`pushConsoleInfo`
.. versionadded:: 3.16.2
%End
virtual void pushInfo( const QString &info );
%Docstring
Pushes a general informational message from the algorithm. This can be
used to report feedback which is neither a status report or an error,
such as "Found 47 matching features".
.. seealso:: :py:func:`pushFormattedMessage`
.. seealso:: :py:func:`pushWarning`
.. seealso:: :py:func:`pushCommandInfo`
.. seealso:: :py:func:`pushDebugInfo`
.. seealso:: :py:func:`pushConsoleInfo`
%End
virtual void pushFormattedMessage( const QString &html, const QString &text );
%Docstring
Pushes a pre-formatted message from the algorithm.
This can be used to push formatted HTML messages to the feedback object.
A plain ``text`` version of the message must also be specified.
.. seealso:: :py:func:`pushInfo`
.. seealso:: :py:func:`pushWarning`
.. seealso:: :py:func:`pushCommandInfo`
.. seealso:: :py:func:`pushDebugInfo`
.. seealso:: :py:func:`pushConsoleInfo`
.. versionadded:: 3.36
%End
virtual void pushCommandInfo( const QString &info );
%Docstring
Pushes an informational message containing a command from the algorithm.
This is usually used to report commands which are executed in an
external application or as subprocesses.
.. seealso:: :py:func:`pushWarning`
.. seealso:: :py:func:`pushInfo`
.. seealso:: :py:func:`pushDebugInfo`
.. seealso:: :py:func:`pushConsoleInfo`
%End
virtual void pushDebugInfo( const QString &info );
%Docstring
Pushes an informational message containing debugging helpers from the
algorithm.
.. seealso:: :py:func:`pushWarning`
.. seealso:: :py:func:`pushInfo`
.. seealso:: :py:func:`pushCommandInfo`
.. seealso:: :py:func:`pushConsoleInfo`
%End
virtual void pushConsoleInfo( const QString &info );
%Docstring
Pushes a console feedback message from the algorithm. This is used to
report the output from executing an external command or subprocess.
.. seealso:: :py:func:`pushWarning`
.. seealso:: :py:func:`pushInfo`
.. seealso:: :py:func:`pushDebugInfo`
.. seealso:: :py:func:`pushCommandInfo`
%End
void pushVersionInfo( const QgsProcessingProvider *provider = 0 );
%Docstring
Pushes a summary of the QGIS (and underlying library) version
information to the log.
.. versionadded:: 3.4.7
%End
void pushFormattedResults( const QgsProcessingAlgorithm *algorithm, QgsProcessingContext &context, const QVariantMap &results );
%Docstring
Pushes a summary of the execution ``results`` to the log
.. versionadded:: 3.36
%End
virtual QString htmlLog() const;
%Docstring
Returns the HTML formatted contents of the log, which contains all
messages pushed to the feedback object.
.. seealso:: :py:func:`textLog`
.. versionadded:: 3.14
%End
virtual QString textLog() const;
%Docstring
Returns the plain text contents of the log, which contains all messages
pushed to the feedback object.
.. seealso:: :py:func:`htmlLog`
.. versionadded:: 3.14
%End
};
class QgsProcessingMultiStepFeedback : QgsProcessingFeedback
{
%Docstring(signature="appended")
Processing feedback object for multi-step operations.
A processing feedback object which proxies its calls to an underlying
feedback object, but scales overall progress reports to account for a
number of child steps which each report their own feedback.
%End
%TypeHeaderCode
#include "qgsprocessingfeedback.h"
%End
public:
QgsProcessingMultiStepFeedback( int steps, QgsProcessingFeedback *feedback );
%Docstring
Constructor for QgsProcessingMultiStepFeedback, for a process with the
specified number of ``steps``. This feedback object will proxy calls to
the specified ``feedback`` object.
%End
void setCurrentStep( int step );
%Docstring
Sets the ``step`` which is being executed. This is used to scale the
current progress to account for progress through the overall process.
%End
virtual void setProgressText( const QString &text );
virtual void reportError( const QString &error, bool fatalError = false );
virtual void pushWarning( const QString &warning );
virtual void pushInfo( const QString &info );
virtual void pushCommandInfo( const QString &info );
virtual void pushDebugInfo( const QString &info );
virtual void pushConsoleInfo( const QString &info );
virtual void pushFormattedMessage( const QString &html, const QString &text );
virtual QString htmlLog() const;
virtual QString textLog() const;
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/processing/qgsprocessingfeedback.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
|
