qgsprocessingmodelchildalgorithm.h

Go to the documentation of this file.

/***************************************************************************
                         qgsprocessingmodelchildalgorithm.h
                         ----------------------------------
    begin                : June 2017
    copyright            : (C) 2017 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 QGSPROCESSINGMODELCHILDALGORITHM_H
#define QGSPROCESSINGMODELCHILDALGORITHM_H
 
#include <memory>
 
#include "qgis.h"
#include "qgis_core.h"
#include "qgsprocessingmodelchilddependency.h"
#include "qgsprocessingmodelchildparametersource.h"
#include "qgsprocessingmodelcomment.h"
#include "qgsprocessingmodelcomponent.h"
#include "qgsprocessingmodeloutput.h"
 
class QgsProcessingModelAlgorithm;
class QgsProcessingAlgorithm;


class CORE_EXPORT QgsProcessingModelChildAlgorithm : public QgsProcessingModelComponent
{
  public:
    QgsProcessingModelChildAlgorithm( const QString &algorithmId = QString() );
 
    QgsProcessingModelChildAlgorithm( const QgsProcessingModelChildAlgorithm &other );
    QgsProcessingModelChildAlgorithm &operator=( const QgsProcessingModelChildAlgorithm &other );
 
    QgsProcessingModelChildAlgorithm *clone() const override SIP_FACTORY;

    void copyNonDefinitionPropertiesFromModel( QgsProcessingModelAlgorithm *model );

    QString childId() const { return mId; }

    void setChildId( const QString &id ) { mId = id; }

    void generateChildId( const QgsProcessingModelAlgorithm &model );

    QString algorithmId() const { return mAlgorithmId; }

    bool setAlgorithmId( const QString &algorithmId );

    bool reattach() const;

    QVariantMap configuration() const;

    void setConfiguration( const QVariantMap &configuration );

    const QgsProcessingAlgorithm *algorithm() const;

    QMap< QString, QList< QgsProcessingModelChildParameterSource > > parameterSources() const { return mParams; }

    void setParameterSources( const QMap< QString, QList< QgsProcessingModelChildParameterSource > > &sources ) { mParams = sources; }

    void addParameterSources( const QString &name, const QList< QgsProcessingModelChildParameterSource > &source ) { mParams.insert( name, source ); }

    bool isActive() const { return mActive; }

    void setActive( bool active ) { mActive = active; }

    QList< QgsProcessingModelChildDependency > dependencies() const { return mDependencies; }

    void setDependencies( const QList< QgsProcessingModelChildDependency > &dependencies ) { mDependencies = dependencies; }

    QMap<QString, QgsProcessingModelOutput> modelOutputs() const { return mModelOutputs; }

    QgsProcessingModelOutput &modelOutput( const QString &name ) { return mModelOutputs[name]; }

    void setModelOutputs( const QMap<QString, QgsProcessingModelOutput> &outputs );

    bool removeModelOutput( const QString &name );

    QVariant toVariant() const;

    bool loadVariant( const QVariant &child );

    QStringList asPythonCode(
      QgsProcessing::PythonOutputType outputType,
      const QgsStringMap &extraParameters,
      int currentIndent,
      int indentSize,
      const QMap<QString, QString> &friendlyChildNames,
      const QMap<QString, QString> &friendlyOutputNames
    ) const;
 
    SIP_SKIP const QgsProcessingModelComment *comment() const override { return &mComment; }
    QgsProcessingModelComment *comment() override { return &mComment; }
    void setComment( const QgsProcessingModelComment &comment ) override { mComment = comment; }
 
  private:
    QString mId;
 
    QString mAlgorithmId;
    std::unique_ptr< QgsProcessingAlgorithm > mAlgorithm;
 
    QVariantMap mConfiguration;

    QMap< QString, QgsProcessingModelChildParameterSources > mParams;

    QMap< QString, QgsProcessingModelOutput > mModelOutputs;
 
    bool mActive = true;

    QList< QgsProcessingModelChildDependency > mDependencies;
 
    QgsProcessingModelComment mComment;
 
    friend class TestQgsProcessingModelAlgorithm;
};

 
#endif // QGSPROCESSINGMODELCHILDALGORITHM_H