Branch data     Line data    Source code

       1                 :            : /***************************************************************************
       2                 :            :                          qgsprocessingmodeloutput.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 QGSPROCESSINGMODELOUTPUT_H
      19                 :            : #define QGSPROCESSINGMODELOUTPUT_H
      20                 :            : 
      21                 :            : #include "qgis_core.h"
      22                 :            : #include "qgis.h"
      23                 :            : #include "qgsprocessingmodelcomponent.h"
      24                 :            : #include "qgsprocessingparameters.h"
      25                 :            : #include "qgsprocessingmodelcomment.h"
      26                 :            : 
      27                 :            : ///@cond NOT_STABLE
      28                 :            : 
      29                 :            : /**
      30                 :            :  * \brief Represents a final output created by the model.
      31                 :            :  * \ingroup core
      32                 :            :  * \since QGIS 3.0
      33                 :            :  */
      34                 :          0 : class CORE_EXPORT QgsProcessingModelOutput : public QgsProcessingModelComponent
      35                 :            : {
      36                 :            :   public:
      37                 :            : 
      38                 :            :     /**
      39                 :            :      * Constructor for QgsProcessingModelOutput with the specified \a name and \a description.
      40                 :            :      */
      41                 :            :     QgsProcessingModelOutput( const QString &name = QString(), const QString &description = QString() );
      42                 :            : 
      43                 :            :     QgsProcessingModelOutput *clone() const override SIP_FACTORY;
      44                 :            : 
      45                 :            :     /**
      46                 :            :      * Returns the model output name.
      47                 :            :      * \see setName()
      48                 :            :      */
      49                 :          0 :     QString name() const { return mName; }
      50                 :            : 
      51                 :            :     /**
      52                 :            :      * Sets the model output \a name.
      53                 :            :      * \see name()
      54                 :            :      */
      55                 :          0 :     void setName( const QString &name ) { mName = name; }
      56                 :            : 
      57                 :            :     /**
      58                 :            :      * Returns the default value for the model output parameter.
      59                 :            :      * \see setDefaultValue()
      60                 :            :      * \since QGIS 3.2
      61                 :            :      */
      62                 :          0 :     QVariant defaultValue() const { return mDefaultValue; }
      63                 :            : 
      64                 :            :     /**
      65                 :            :      * Sets the default value for the model output.
      66                 :            :      * \see defaultValue()
      67                 :            :      * \since QGIS 3.2
      68                 :            :      */
      69                 :            :     void setDefaultValue( const QVariant &value ) { mDefaultValue = value; }
      70                 :            : 
      71                 :            :     /**
      72                 :            :      * Returns TRUE if the output is mandatory. This may override the associated
      73                 :            :      * child algorithm's parameter optional status - e.g. allowing
      74                 :            :      * an optional output from an algorithm to be mandatory within a model.
      75                 :            :      * \see setMandatory()
      76                 :            :      * \since QGIS 3.2
      77                 :            :      */
      78                 :          0 :     bool isMandatory() const { return mMandatory; }
      79                 :            : 
      80                 :            :     /**
      81                 :            :      * Sets whether the output is \a mandatory. This may override the associated
      82                 :            :      * child algorithm's parameter optional status - e.g. allowing
      83                 :            :      * an optional output from an algorithm to be mandatory within a model.
      84                 :            :      * \see isMandatory()
      85                 :            :      * \since QGIS 3.2
      86                 :            :      */
      87                 :            :     void setMandatory( bool mandatory ) { mMandatory = mandatory; }
      88                 :            : 
      89                 :            :     /**
      90                 :            :      * Returns the child algorithm ID from which this output is generated.
      91                 :            :      * \see setChildId()
      92                 :            :      */
      93                 :          0 :     QString childId() const { return mChildId; }
      94                 :            : 
      95                 :            :     /**
      96                 :            :      * Sets the child algorithm \a id from which this output is generated.
      97                 :            :      * \see childId()
      98                 :            :      */
      99                 :          0 :     void setChildId( const QString &id ) { mChildId = id; }
     100                 :            : 
     101                 :            :     /**
     102                 :            :      * Returns the child algorithm output name from which this output is generated.
     103                 :            :      * \see setOutputName()
     104                 :            :      */
     105                 :          0 :     QString childOutputName() const { return mOutputName; }
     106                 :            : 
     107                 :            :     /**
     108                 :            :      * Sets the child algorithm output \a name from which this output is generated.
     109                 :            :      * \see outputName()
     110                 :            :      */
     111                 :            :     void setChildOutputName( const QString &name ) { mOutputName = name; }
     112                 :            : 
     113                 :            :     /**
     114                 :            :      * Saves this output to a QVariant.
     115                 :            :      * \see loadVariant()
     116                 :            :      */
     117                 :            :     QVariant toVariant() const;
     118                 :            : 
     119                 :            :     /**
     120                 :            :      * Loads this output from a QVariantMap.
     121                 :            :      * \see toVariant()
     122                 :            :      */
     123                 :            :     bool loadVariant( const QVariantMap &map );
     124                 :            : 
     125                 :          0 :     SIP_SKIP const QgsProcessingModelComment *comment() const override { return &mComment; }
     126                 :          0 :     QgsProcessingModelComment *comment() override { return &mComment; }
     127                 :          0 :     void setComment( const QgsProcessingModelComment &comment ) override { mComment = comment; }
     128                 :            : 
     129                 :            :   private:
     130                 :            : 
     131                 :            :     QString mName;
     132                 :            :     QVariant mDefaultValue;
     133                 :            :     QString mChildId;
     134                 :            :     QString mOutputName;
     135                 :            :     bool mMandatory = false;
     136                 :            : 
     137                 :            :     QgsProcessingModelComment mComment;
     138                 :            : 
     139                 :            : };
     140                 :            : 
     141                 :            : ///@endcond
     142                 :            : 
     143                 :            : #endif // QGSPROCESSINGMODELOUTPUT_H