/***************************************************************************
                         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_core.h"
#include "qgis.h"
#include "qgsprocessingmodelcomponent.h"
#include "qgsprocessingparameters.h"
#include "qgsprocessingmodelcomment.h"

///@cond NOT_STABLE

/**
 * Represents a final output created by the model.
 * \ingroup core
 * \since QGIS 3.0
 */
class CORE_EXPORT QgsProcessingModelOutput : public QgsProcessingModelComponent
{
  public:

    /**
     * Constructor for QgsProcessingModelOutput with the specified \a name and \a description.
     */
    QgsProcessingModelOutput( const QString &name = QString(), const QString &description = QString() );

    QgsProcessingModelOutput *clone() const override SIP_FACTORY;

    /**
     * Returns the model output name.
     * \see setName()
     */
    QString name() const { return mName; }

    /**
     * Sets the model output \a name.
     * \see name()
     */
    void setName( const QString &name ) { mName = name; }

    /**
     * Returns the default value for the model output parameter.
     * \see setDefaultValue()
     * \since QGIS 3.2
     */
    QVariant defaultValue() const { return mDefaultValue; }

    /**
     * Sets the default value for the model output.
     * \see defaultValue()
     * \since QGIS 3.2
     */
    void setDefaultValue( const QVariant &value ) { mDefaultValue = value; }

    /**
     * Returns TRUE if the output is mandatory. This may override the associated
     * child algorithm's parameter optional status - e.g. allowing
     * an optional output from an algorithm to be mandatory within a model.
     * \see setMandatory()
     * \since QGIS 3.2
     */
    bool isMandatory() const { return mMandatory; }

    /**
     * Sets whether the output is \a mandatory. This may override the associated
     * child algorithm's parameter optional status - e.g. allowing
     * an optional output from an algorithm to be mandatory within a model.
     * \see isMandatory()
     * \since QGIS 3.2
     */
    void setMandatory( bool mandatory ) { mMandatory = mandatory; }

    /**
     * Returns the child algorithm ID from which this output is generated.
     * \see setChildId()
     */
    QString childId() const { return mChildId; }

    /**
     * Sets the child algorithm \a id from which this output is generated.
     * \see childId()
     */
    void setChildId( const QString &id ) { mChildId = id; }

    /**
     * Returns the child algorithm output name from which this output is generated.
     * \see setOutputName()
     */
    QString childOutputName() const { return mOutputName; }

    /**
     * Sets the child algorithm output \a name from which this output is generated.
     * \see outputName()
     */
    void setChildOutputName( const QString &name ) { mOutputName = name; }

    /**
     * Saves this output to a QVariant.
     * \see loadVariant()
     */
    QVariant toVariant() const;

    /**
     * Loads this output from a QVariantMap.
     * \see toVariant()
     */
    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;

};

///@endcond

#endif // QGSPROCESSINGMODELOUTPUT_H
