Branch data     Line data    Source code

       1                 :            : /***************************************************************************
       2                 :            :                          qgsalgorithmconditionalbranch.cpp
       3                 :            :                          ---------------------
       4                 :            :     begin                : March 2020
       5                 :            :     copyright            : (C) 2020 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                 :            : #include "qgsalgorithmconditionalbranch.h"
      19                 :            : #include "qgsapplication.h"
      20                 :            : 
      21                 :            : ///@cond PRIVATE
      22                 :            : 
      23                 :          0 : QString QgsConditionalBranchAlgorithm::name() const
      24                 :            : {
      25                 :          0 :   return QStringLiteral( "condition" );
      26                 :            : }
      27                 :            : 
      28                 :          0 : QString QgsConditionalBranchAlgorithm::displayName() const
      29                 :            : {
      30                 :          0 :   return QObject::tr( "Conditional branch" );
      31                 :            : }
      32                 :            : 
      33                 :          0 : QStringList QgsConditionalBranchAlgorithm::tags() const
      34                 :            : {
      35                 :          0 :   return QObject::tr( "if,logic,test" ).split( ',' );
      36                 :          0 : }
      37                 :            : 
      38                 :          0 : QString QgsConditionalBranchAlgorithm::group() const
      39                 :            : {
      40                 :          0 :   return QObject::tr( "Modeler tools" );
      41                 :            : }
      42                 :            : 
      43                 :          0 : QString QgsConditionalBranchAlgorithm::groupId() const
      44                 :            : {
      45                 :          0 :   return QStringLiteral( "modelertools" );
      46                 :            : }
      47                 :            : 
      48                 :          0 : QgsProcessingAlgorithm::Flags QgsConditionalBranchAlgorithm::flags() const
      49                 :            : {
      50                 :          0 :   return FlagHideFromToolbox | FlagSkipGenericModelLogging;
      51                 :            : }
      52                 :            : 
      53                 :          0 : QString QgsConditionalBranchAlgorithm::shortHelpString() const
      54                 :            : {
      55                 :          0 :   return QObject::tr( "This algorithm adds a conditional branch into a model, allowing parts of the model to be executed based on the result of an expression evaluation." );
      56                 :            : }
      57                 :            : 
      58                 :          0 : QString QgsConditionalBranchAlgorithm::shortDescription() const
      59                 :            : {
      60                 :          0 :   return QObject::tr( "Adds a conditional branch into a model, allowing parts of the model to be selectively executed." );
      61                 :            : }
      62                 :            : 
      63                 :          0 : QgsConditionalBranchAlgorithm *QgsConditionalBranchAlgorithm::createInstance() const
      64                 :            : {
      65                 :          0 :   return new QgsConditionalBranchAlgorithm();
      66                 :            : }
      67                 :            : 
      68                 :          0 : QgsConditionalBranchAlgorithm::~QgsConditionalBranchAlgorithm()
      69                 :          0 : {
      70                 :          0 :   qDeleteAll( mOutputs );
      71                 :          0 : }
      72                 :            : 
      73                 :          0 : void QgsConditionalBranchAlgorithm::initAlgorithm( const QVariantMap &configuration )
      74                 :            : {
      75                 :          0 :   const QVariantList branches = configuration.value( QStringLiteral( "conditions" ) ).toList();
      76                 :          0 :   for ( const QVariant &branch : branches )
      77                 :            :   {
      78                 :          0 :     const QVariantMap branchDef = branch.toMap();
      79                 :          0 :     const QString name = branchDef.value( QStringLiteral( "name" ) ).toString();
      80                 :          0 :     mOutputs.append( new Output( name, branchDef.value( QStringLiteral( "expression" ) ).toString() ) );
      81                 :          0 :     addOutput( new QgsProcessingOutputConditionalBranch( name, name ) );
      82                 :          0 :   }
      83                 :          0 : }
      84                 :            : 
      85                 :          0 : QVariantMap QgsConditionalBranchAlgorithm::processAlgorithm( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback )
      86                 :            : {
      87                 :          0 :   QgsExpressionContext expressionContext = createExpressionContext( parameters, context );
      88                 :            : 
      89                 :          0 :   QVariantMap results;
      90                 :          0 :   for ( Output *output : std::as_const( mOutputs ) )
      91                 :            :   {
      92                 :          0 :     output->expression.prepare( &expressionContext );
      93                 :          0 :     const QVariant res = output->expression.evaluate( &expressionContext );
      94                 :          0 :     results.insert( output->name, res );
      95                 :          0 :     if ( res.toBool() )
      96                 :            :     {
      97                 :          0 :       feedback->pushInfo( QObject::tr( "Condition %1 passed" ).arg( output->name ) );
      98                 :          0 :     }
      99                 :            :     else
     100                 :            :     {
     101                 :          0 :       feedback->pushInfo( QObject::tr( "Condition %1 failed" ).arg( output->name ) );
     102                 :            :     }
     103                 :          0 :   }
     104                 :          0 :   qDeleteAll( mOutputs );
     105                 :          0 :   mOutputs.clear();
     106                 :          0 :   return results;
     107                 :          0 : }
     108                 :            : 
     109                 :            : 
     110                 :            : ///@endcond PRIVATE