QGIS API Documentation 4.1.0-Master (d6fb7a379fb)
Loading...
Searching...
No Matches
qgsprocessingmodelfeedback.cpp
Go to the documentation of this file.
1/***************************************************************************
2 qgsprocessingmodelfeedback.cpp
3 ----------------------
4 begin : May 2026
5 copyright : (C) 2026 by Nyall Dawson
6 email : nyall dot dawson at gmail dot com
7 ***************************************************************************/
8
9/***************************************************************************
10 * *
11 * This program is free software; you can redistribute it and/or modify *
12 * it under the terms of the GNU General Public License as published by *
13 * the Free Software Foundation; either version 2 of the License, or *
14 * (at your option) any later version. *
15 * *
16 ***************************************************************************/
17
19
20#include "moc_qgsprocessingmodelfeedback.cpp"
21
25
27{
28 emit childAlgorithmsBroken( childIds );
29}
30
32{
33 mPreparedChildren.insert( childId );
34 emit preparingChild( childId );
35}
36
37void QgsProcessingModelFeedback::reportChildPreparationFailure( const QString &childId, const QString &error )
38{
39 emit childPreparationFailed( childId, error );
40}
41
42void QgsProcessingModelFeedback::reportChildStarted( const QString &childId, const QVariantMap &childParameters )
43{
44 mStartedChildren.insert( childId );
45 emit childStarted( childId, childParameters );
46}
47
48void QgsProcessingModelFeedback::reportChildProgress( const QString &childId, double progress )
49{
50 emit childProgressChanged( childId, progress );
51}
52
53void QgsProcessingModelFeedback::reportChildExecutionFailure( const QString &childId, const QString &error )
54{
55 mFailedChildren.insert( childId );
56 emit childExecutionFailed( childId, error );
57}
58
59void QgsProcessingModelFeedback::reportChildExecutionSuccess( const QString &childId, const QVariantMap &childResults )
60{
61 mSuccessfullyExecutedChildren.insert( childId );
62 emit childExecutionSucceeded( childId, childResults );
63}
64
66{
67 emit childResultReported( childId, result );
68}
69
71{
72 mPrunedChildren.insert( childId );
73 emit childPruned( childId );
74}
double progress() const
Returns the current progress reported by the feedback object.
Definition qgsfeedback.h:81
QgsProcessingFeedback(bool logFeedback=true)
Constructor for QgsProcessingFeedback.
Encapsulates the results of running a child algorithm within a model.
void reportChildExecutionFailure(const QString &childId, const QString &error)
Report an error which occurred while executing a child algorithm.
QgsProcessingModelFeedback(bool logFeedback=true)
Constructor for QgsProcessingModelFeedback.
void childExecutionSucceeded(const QString &childId, const QVariantMap &childResults)
Emitted when a child algorithm successfully executed.
void childPreparationFailed(const QString &childId, const QString &error)
Emitted when an error occurred while preparing a child algorithm.
void reportChildResult(const QString &childId, const QgsProcessingModelChildAlgorithmResult &result)
Reports the result of the execution of a child algorithm.
void childExecutionFailed(const QString &childId, const QString &error)
Emitted when an error occurred while executing a child algorithm.
void childStarted(const QString &childId, const QVariantMap &childParameters)
Emitted when a child algorithm has started executing.
void childResultReported(const QString &childId, const QgsProcessingModelChildAlgorithmResult &result)
Emitted when the result of a child algorithm has been reported.
void reportBrokenChildAlgorithms(const QSet< QString > &childIds)
Report a set of child algorithms as broken (e.g.
void preparingChild(const QString &childId)
Emitted when a child algorithm starts preparation.
void childAlgorithmsBroken(const QSet< QString > &childIds)
Emitted when a set of child algorithms was reported as broken (e.g.
void reportChildPreparationFailure(const QString &childId, const QString &error)
Report an error which occurred while preparing a child algorithm.
void reportPreparingChild(const QString &childId)
Report a child algorithm as undergoing the preparation step.
void childPruned(const QString &childId)
Emitted when a child algorithm was pruned from the pending children (i.e.
void reportChildExecutionSuccess(const QString &childId, const QVariantMap &childResults)
Report that a child algorithm successfully executed.
void reportChildProgress(const QString &childId, double progress)
Reports the progress of a running child algorithm.
void childProgressChanged(const QString &childId, double progress)
Emitted when a child algorithm changes progress.
void reportChildStarted(const QString &childId, const QVariantMap &childParameters)
Report a child algorithm as started execution.
void reportChildPruned(const QString &childId)
Report that a child algorithm was pruned from the pending children (i.e.