qgsprocessingmodelchildparametersource.h

Go to the documentation of this file.

/***************************************************************************
                         qgsprocessingmodelchildparametersource.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 QGSPROCESSINGMODELCHILDPARAMETERSOURCE_H
#define QGSPROCESSINGMODELCHILDPARAMETERSOURCE_H
 
#include "qgis_core.h"
#include "qgis.h"
#include "qgsprocessing.h"
class QgsProcessingParameterDefinition;
class QgsProcessingModelAlgorithm;
 
 
class CORE_EXPORT QgsProcessingModelChildParameterSource
{
  public:
 
    enum Source
    {
      ModelParameter, 
      ChildOutput, 
      StaticValue, 
      Expression, 
      ExpressionText, 
      ModelOutput, 
    };
 
    QgsProcessingModelChildParameterSource() = default;
 
    bool operator==( const QgsProcessingModelChildParameterSource &other ) const;
    bool operator!=( const QgsProcessingModelChildParameterSource &other ) const
    {
      return !operator==( other );
    }
 
    static QgsProcessingModelChildParameterSource fromStaticValue( const QVariant &value );
 
    static QgsProcessingModelChildParameterSource fromModelParameter( const QString &parameterName );
 
    static QgsProcessingModelChildParameterSource fromChildOutput( const QString &childId, const QString &outputName );
 
    static QgsProcessingModelChildParameterSource fromExpression( const QString &expression );
 
    static QgsProcessingModelChildParameterSource fromExpressionText( const QString &text );
 
    Source source() const;
 
    void setSource( Source source );
 
    QVariant staticValue() const { return mStaticValue; }
 
    void setStaticValue( const QVariant &value ) { mStaticValue = value; mSource = StaticValue; }
 
    QString parameterName() const { return mParameterName; }
 
    void setParameterName( const QString &name ) { mParameterName = name; mSource = ModelParameter; }
 
    QString outputChildId() const { return mChildId; }
 
    void setOutputChildId( const QString &id ) { mChildId = id; mSource = ChildOutput; }
 
    QString outputName() const { return mOutputName; }
 
    void setOutputName( const QString &name ) { mOutputName = name; mSource = ChildOutput; }
 
    QString expression() const { return mExpression; }
 
    void setExpression( const QString &expression ) { mExpression = expression; mSource = Expression; }
 
    QString expressionText() const { return mExpressionText; }
 
    void setExpressionText( const QString &text ) { mExpressionText = text; mSource = ExpressionText; }
 
    QVariant toVariant() const;
 
    bool loadVariant( const QVariantMap &map );
 
    QString asPythonCode( QgsProcessing::PythonOutputType outputType, const QgsProcessingParameterDefinition *definition, const QMap< QString, QString > &friendlyChildNames ) const;
 
    QString asPythonComment( const QgsProcessingParameterDefinition *definition ) const;
 
    QString friendlyIdentifier( QgsProcessingModelAlgorithm *model ) const;
 
  private:
 
    Source mSource = StaticValue;
    QVariant mStaticValue;
    QString mParameterName;
    QString mChildId;
    QString mOutputName;
    QString mExpression;
    QString mExpressionText;
 
};
 
Q_DECLARE_METATYPE( QgsProcessingModelChildParameterSource );
CORE_EXPORT QDataStream &operator<<( QDataStream &out, const QgsProcessingModelChildParameterSource &source );
CORE_EXPORT QDataStream &operator>>( QDataStream &in, QgsProcessingModelChildParameterSource &source );
 
#ifndef SIP_RUN
typedef QList< QgsProcessingModelChildParameterSource > QgsProcessingModelChildParameterSources;
#endif
 
 
#endif // QGSPROCESSINGMODELCHILDPARAMETERSOURCE_H