qgsprocessingmodelparameter.h

Go to the documentation of this file.

/***************************************************************************
                         qgsprocessingmodelparameter.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 QGSPROCESSINGMODELPARAMETER_H
#define QGSPROCESSINGMODELPARAMETER_H
 
#include "qgis.h"
#include "qgis_core.h"
#include "qgsprocessingmodelcomment.h"
#include "qgsprocessingmodelcomponent.h"

 

class CORE_EXPORT QgsProcessingModelParameter : public QgsProcessingModelComponent
{
  public:
    QgsProcessingModelParameter( const QString &parameterName = QString() );
 
    QgsProcessingModelParameter *clone() const override SIP_FACTORY;

    QString parameterName() const { return mParameterName; }

    void setParameterName( const QString &name ) { mParameterName = name; }

    QVariant toVariant() const;

    bool loadVariant( const QVariantMap &map );
 
    SIP_SKIP const QgsProcessingModelComment *comment() const override { return &mComment; }
    QgsProcessingModelComment *comment() override { return &mComment; }
    void setComment( const QgsProcessingModelComment &comment ) override { mComment = comment; }
 
  private:
    QString mParameterName;
 
    QgsProcessingModelComment mComment;
};

 
#endif // QGSPROCESSINGMODELPARAMETER_H