qgsprocessingmodeloutput.h

Go to the documentation of this file.

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


class CORE_EXPORT QgsProcessingModelOutput : public QgsProcessingModelComponent
{
  public:
    QgsProcessingModelOutput( const QString &name = QString(), const QString &description = QString() );
 
    QgsProcessingModelOutput *clone() const override SIP_FACTORY;

    QString name() const { return mName; }

    void setName( const QString &name ) { mName = name; }

    QVariant defaultValue() const { return mDefaultValue; }

    void setDefaultValue( const QVariant &value ) { mDefaultValue = value; }

    bool isMandatory() const { return mMandatory; }

    void setMandatory( bool mandatory ) { mMandatory = mandatory; }

    QString childId() const { return mChildId; }

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

    QString childOutputName() const { return mOutputName; }

    void setChildOutputName( const QString &name ) { mOutputName = 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 mName;
    QVariant mDefaultValue;
    QString mChildId;
    QString mOutputName;
    bool mMandatory = false;
 
    QgsProcessingModelComment mComment;
};

 
#endif // QGSPROCESSINGMODELOUTPUT_H