qgsprocessingpostprocessor.h

Go to the documentation of this file.

/***************************************************************************
                         qgsprocessingpostprocessor.h
                         ------------------------
    begin                : October 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 QGSPROCESSINGPOSTPROCESSOR_H
#define QGSPROCESSINGPOSTPROCESSOR_H
 
#include "qgis.h"
#include "qgis_core.h"
#include "qgsprocessingcontext.h"
 
class QgsMapLayer;
class QgsProcessingAlgorithm;
class QgsLayerTreeGroup;

class CORE_EXPORT QgsProcessingLayerPostProcessor
{
  public:
    QgsProcessingLayerPostProcessor() = default;
 
    virtual ~QgsProcessingLayerPostProcessor();

    virtual void postProcessLayer( QgsMapLayer *layer, const QString &outputName, const QgsProcessingAlgorithm *algorithm );
};
 

class CORE_EXPORT QgsProcessingResultsHandler
{
  public:
    QgsProcessingResultsHandler() = default;
 
    virtual ~QgsProcessingResultsHandler();

    class CORE_EXPORT ResultLayerDetails
    {
      public:
        ResultLayerDetails( QgsMapLayer *layer SIP_TRANSFER )
          : layer( layer )
        {}

        QgsMapLayer *layer = nullptr;

        QgsLayerTreeGroup *targetLayerTreeGroup = nullptr;

        int sortKey = 0;

        QgsProject *destinationProject = nullptr;
    };

    static QString determineOutputName(
      const QString &destinationId, const QgsProcessingContext::LayerDetails &details, const QgsProcessingAlgorithm *algorithm, QgsProcessingContext &context, const QVariantMap &parameters
    );

    static QgsLayerTreeGroup *layerTreeResultsGroup( const QgsProcessingContext::LayerDetails &layerDetails, const QgsProcessingContext &context );

    static void configureResultLayerTreeLayer( QgsLayerTreeLayer *layerTreeLayer );

    static QgsMapLayer *addResultLayers( const QVector< QgsProcessingResultsHandler::ResultLayerDetails > &layers, const QgsProcessingContext &context, QgsLayerTreeNode *currentSelectedNode );

    bool handleAlgorithmResults( const QgsProcessingAlgorithm *algorithm, QgsProcessingContext &context, const QVariantMap &parameters, QgsProcessingFeedback *feedback = nullptr );
 
  protected:
#ifndef SIP_RUN
    struct ResultDetails
    {
        bool succeeded = false;
        QList<QgsProcessingResultsHandler::ResultLayerDetails> addedLayers;
    };

    virtual QgsProcessingResultsHandler::ResultDetails handleAlgorithmResultsProtected(
      const QgsProcessingAlgorithm *algorithm, QgsProcessingContext &context, const QVariantMap &parameters, QgsProcessingFeedback *feedback
    );

    virtual QgsMapLayer *handleAddResultLayers( const QgsProcessingResultsHandler::ResultDetails &details, const QgsProcessingContext &context );

    virtual void setNewActiveLayer( QgsMapLayer *layer );
#endif
};
 
 
#endif // QGSPROCESSINGPOSTPROCESSOR_H