Branch data     Line data    Source code

       1                 :            : /***************************************************************************
       2                 :            :                          qgsprocessingmodelparameter.h
       3                 :            :                          -----------------------------
       4                 :            :     begin                : June 2017
       5                 :            :     copyright            : (C) 2017 by Nyall Dawson
       6                 :            :     email                : nyall dot dawson at gmail dot com
       7                 :            :  ***************************************************************************/
       8                 :            : 
       9                 :            : /***************************************************************************
      10                 :            :  *                                                                         *
      11                 :            :  *   This program is free software; you can redistribute it and/or modify  *
      12                 :            :  *   it under the terms of the GNU General Public License as published by  *
      13                 :            :  *   the Free Software Foundation; either version 2 of the License, or     *
      14                 :            :  *   (at your option) any later version.                                   *
      15                 :            :  *                                                                         *
      16                 :            :  ***************************************************************************/
      17                 :            : 
      18                 :            : #ifndef QGSPROCESSINGMODELPARAMETER_H
      19                 :            : #define QGSPROCESSINGMODELPARAMETER_H
      20                 :            : 
      21                 :            : #include "qgis_core.h"
      22                 :            : #include "qgis.h"
      23                 :            : #include "qgsprocessingmodelcomponent.h"
      24                 :            : #include "qgsprocessingmodelcomment.h"
      25                 :            : 
      26                 :            : ///@cond NOT_STABLE
      27                 :            : 
      28                 :            : 
      29                 :            : /**
      30                 :            :  * \brief Represents an input parameter used by the model.
      31                 :            :  * \ingroup core
      32                 :            :  * \since QGIS 3.0
      33                 :            :  */
      34                 :          0 : class CORE_EXPORT QgsProcessingModelParameter : public QgsProcessingModelComponent
      35                 :            : {
      36                 :            :   public:
      37                 :            : 
      38                 :            :     /**
      39                 :            :      * Constructor for QgsProcessingModelParameter. The parameter name should match one of the
      40                 :            :      * parameters from the parent model.
      41                 :            :      */
      42                 :            :     QgsProcessingModelParameter( const QString &parameterName = QString() );
      43                 :            : 
      44                 :            :     QgsProcessingModelParameter *clone() const override SIP_FACTORY;
      45                 :            : 
      46                 :            :     /**
      47                 :            :      * Returns the associated parameter name. The parameter name should match one of the
      48                 :            :      * parameters from the parent model.
      49                 :            :      * \see parameterName()
      50                 :            :      */
      51                 :          0 :     QString parameterName() const { return mParameterName; }
      52                 :            : 
      53                 :            :     /**
      54                 :            :      * Sets the associated parameter name. The parameter name should match one of the
      55                 :            :      * parameters from the parent model.
      56                 :            :      * \see parameterName()
      57                 :            :      */
      58                 :          0 :     void setParameterName( const QString &name ) { mParameterName = name; }
      59                 :            : 
      60                 :            :     /**
      61                 :            :      * Saves this parameter to a QVariant.
      62                 :            :      * \see loadVariant()
      63                 :            :      */
      64                 :            :     QVariant toVariant() const;
      65                 :            : 
      66                 :            :     /**
      67                 :            :      * Loads this parameter from a QVariantMap.
      68                 :            :      * \see toVariant()
      69                 :            :      */
      70                 :            :     bool loadVariant( const QVariantMap &map );
      71                 :            : 
      72                 :          0 :     SIP_SKIP const QgsProcessingModelComment *comment() const override { return &mComment; }
      73                 :          0 :     QgsProcessingModelComment *comment() override { return &mComment; }
      74                 :          0 :     void setComment( const QgsProcessingModelComment &comment ) override { mComment = comment; }
      75                 :            : 
      76                 :            :   private:
      77                 :            : 
      78                 :            :     QString mParameterName;
      79                 :            : 
      80                 :            :     QgsProcessingModelComment mComment;
      81                 :            : 
      82                 :            : };
      83                 :            : 
      84                 :            : ///@endcond
      85                 :            : 
      86                 :            : #endif // QGSPROCESSINGMODELPARAMETER_H