qgsprocessingmodelfeedback.h

Go to the documentation of this file.

/***************************************************************************
                         qgsprocessingmodelfeedback.h
                         ----------------------
    begin                : May 2026
    copyright            : (C) 2026 by Nyall Dawson
    email                : nyall dot dawson at gmail dot com
 ***************************************************************************/
 
/***************************************************************************
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/
 
#ifndef QGSPROCESSINGMODELFEEDBACK_H
#define QGSPROCESSINGMODELFEEDBACK_H
 
#include "qgis.h"
#include "qgis_core.h"
#include "qgsprocessingfeedback.h"
#include "qgsprocessingmodelresult.h"
 
#define SIP_NO_FILE

class CORE_EXPORT QgsProcessingModelFeedback : public QgsProcessingFeedback
{
    Q_OBJECT
 
  public:
    QgsProcessingModelFeedback( bool logFeedback = true );

    void reportBrokenChildAlgorithms( const QSet< QString > &childIds );

    void reportPreparingChild( const QString &childId );

    QSet< QString > preparedChildren() const { return mPreparedChildren; }

    void reportChildPreparationFailure( const QString &childId, const QString &error );

    void reportChildStarted( const QString &childId, const QVariantMap &childParameters );

    QSet< QString > startedChildren() const { return mStartedChildren; }

    void reportChildProgress( const QString &childId, double progress );

    void reportChildSourceLoaded( const QString &childId, const QString &parameterName, long long featureCount );

    void reportChildSinkFeatureCountChanged( const QString &childId, const QString &childOutput, long long featureCount );

    void reportChildExecutionFailure( const QString &childId, const QString &error );

    QSet< QString > failedChildren() const { return mFailedChildren; }

    void reportChildExecutionSuccess( const QString &childId, const QVariantMap &childResults );

    QSet< QString > successfulChildren() const { return mSuccessfullyExecutedChildren; }

    void reportChildResult( const QString &childId, const QgsProcessingModelChildAlgorithmResult &result );

    void reportChildPruned( const QString &childId );

    QSet< QString > prunedChildren() const { return mPrunedChildren; }
 
  signals:

    void childAlgorithmsBroken( const QSet< QString > &childIds );

    void preparingChild( const QString &childId );

    void childPreparationFailed( const QString &childId, const QString &error );

    void childStarted( const QString &childId, const QVariantMap &childParameters );

    void childProgressChanged( const QString &childId, double progress );

    void childSourceLoaded( const QString &childId, const QString &parameterName, long long featureCount );

    void childSinkFeatureCountChanged( const QString &childId, const QString &childOutput, long long featureCount );

    void childExecutionFailed( const QString &childId, const QString &error );

    void childExecutionSucceeded( const QString &childId, const QVariantMap &childResults );

    void childResultReported( const QString &childId, const QgsProcessingModelChildAlgorithmResult &result );

    void childPruned( const QString &childId );
 
  private:
    QSet< QString > mPreparedChildren;
    QSet< QString > mStartedChildren;
    QSet< QString > mSuccessfullyExecutedChildren;
    QSet< QString > mFailedChildren;
    QSet< QString > mPrunedChildren;
};
 
#endif // QGSPROCESSINGMODELFEEDBACK_H