qgsprocessingmodelresult.h

Go to the documentation of this file.

/***************************************************************************
                         qgsprocessingmodelresult.h
                         ----------------------
    begin                : April 2024
    copyright            : (C) 2024 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 QGSPROCESSINGMODELRESULT_H
#define QGSPROCESSINGMODELRESULT_H
 
#include "qgis.h"
#include "qgis_core.h"
 
#include <QSet>

class CORE_EXPORT QgsProcessingModelChildAlgorithmResult
{
  public:
 
    QgsProcessingModelChildAlgorithmResult();

    Qgis::ProcessingModelChildAlgorithmExecutionStatus executionStatus() const { return mExecutionStatus; }

    void setExecutionStatus( Qgis::ProcessingModelChildAlgorithmExecutionStatus status ) { mExecutionStatus = status; }

    QVariantMap inputs() const { return mInputs; }

    void setInputs( const QVariantMap &inputs ) { mInputs = inputs; }

    QVariantMap outputs() const { return mOutputs; }

    void setOutputs( const QVariantMap &outputs ) { mOutputs = outputs; }

    QString htmlLog() const { return mHtmlLog; }

    void setHtmlLog( const QString &log ) { mHtmlLog = log; }
 
    bool operator==( const QgsProcessingModelChildAlgorithmResult &other ) const
    {
      return mExecutionStatus == other.mExecutionStatus
             && mHtmlLog == other.mHtmlLog
             && mInputs == other.mInputs
             && mOutputs == other.mOutputs;
    }
    bool operator!=( const QgsProcessingModelChildAlgorithmResult &other ) const
    {
      return !( *this == other );
    }
 
  private:
 
    Qgis::ProcessingModelChildAlgorithmExecutionStatus mExecutionStatus = Qgis::ProcessingModelChildAlgorithmExecutionStatus::NotExecuted;
    QVariantMap mInputs;
    QVariantMap mOutputs;
    QString mHtmlLog;
 
};

class CORE_EXPORT QgsProcessingModelResult
{
  public:
 
    QgsProcessingModelResult();

    void clear();

    void mergeWith( const QgsProcessingModelResult &other );

    QMap< QString, QgsProcessingModelChildAlgorithmResult > childResults() const { return mChildResults; }

    QMap< QString, QgsProcessingModelChildAlgorithmResult > &childResults() SIP_SKIP { return mChildResults; }

    QVariantMap &rawChildInputs() SIP_SKIP { return mRawChildInputs; }

    QVariantMap &rawChildOutputs() SIP_SKIP { return mRawChildOutputs; }

    QSet< QString > &executedChildIds() SIP_SKIP { return mExecutedChildren; }

    QSet< QString > executedChildIds() const { return mExecutedChildren; }
 
  private:
 
    QMap< QString, QgsProcessingModelChildAlgorithmResult > mChildResults;
 
    QSet< QString > mExecutedChildren;
    QVariantMap mRawChildInputs;
    QVariantMap mRawChildOutputs;
 
};
 
 
#endif // QGSPROCESSINGMODELRESULT_H