QGIS API Documentation  3.23.0-Master (eb871beae0)
qgsprocessingparameteraggregate.cpp
Go to the documentation of this file.
1 /***************************************************************************
2  qgsprocessingparameteraggregate.cpp
3  -------------------------
4  begin : June 2020
5  copyright : (C) 2020 by Nyall Dawson
6  email : nyall dot dawson at gmail dot com
7  ***************************************************************************
8  * *
9  * This program is free software; you can redistribute it and/or modify *
10  * it under the terms of the GNU General Public License as published by *
11  * the Free Software Foundation; either version 2 of the License, or *
12  * (at your option) any later version. *
13  * *
14  ***************************************************************************/
15 
17 
18 #include "qgsvectorlayer.h"
19 
20 
21 QgsProcessingParameterAggregate::QgsProcessingParameterAggregate( const QString &name, const QString &description, const QString &parentLayerParameterName, bool optional )
22  : QgsProcessingParameterDefinition( name, description, QVariant(), optional )
23  , mParentLayerParameterName( parentLayerParameterName )
24 {
25 }
26 
28 {
29  return new QgsProcessingParameterAggregate( *this );
30 }
31 
33 {
34  return typeName();
35 }
36 
38 {
39  if ( !input.isValid() )
40  return mFlags & FlagOptional;
41 
42  if ( input.type() != QVariant::List )
43  return false;
44 
45  const QVariantList inputList = input.toList();
46  for ( const QVariant &inputItem : inputList )
47  {
48  if ( inputItem.type() != QVariant::Map )
49  return false;
50 
51  const QVariantMap inputItemMap = inputItem.toMap();
52 
53  if ( !inputItemMap.contains( "name" ) )
54  return false;
55  if ( !inputItemMap.contains( "type" ) )
56  return false;
57  if ( !inputItemMap.contains( "input" ) )
58  return false;
59  if ( !inputItemMap.contains( "aggregate" ) )
60  return false;
61  }
62 
63  return true;
64 }
65 
67 {
69 }
70 
72 {
73  switch ( outputType )
74  {
76  {
77  QString code = QStringLiteral( "QgsProcessingParameterAggregate('%1', %2" )
79  if ( !mParentLayerParameterName.isEmpty() )
80  code += QStringLiteral( ", parentLayerParameterName=%1" ).arg( QgsProcessingUtils::stringToPythonLiteral( mParentLayerParameterName ) );
81 
82  if ( mFlags & FlagOptional )
83  code += QLatin1String( ", optional=True" );
84  code += ')';
85  return code;
86  }
87  }
88  return QString();
89 }
90 
92 {
94  map.insert( QStringLiteral( "parent_layer" ), mParentLayerParameterName );
95  return map;
96 }
97 
99 {
101  mParentLayerParameterName = map.value( QStringLiteral( "parent_layer" ) ).toString();
102  return true;
103 }
104 
106 {
107  QStringList depends;
108  if ( !mParentLayerParameterName.isEmpty() )
109  depends << mParentLayerParameterName;
110  return depends;
111 }
112 
114 {
115  return mParentLayerParameterName;
116 }
117 
119 {
120  mParentLayerParameterName = name;
121 }
122 
Contains information about the context in which a processing algorithm is executed.
bool checkValueIsAcceptable(const QVariant &input, QgsProcessingContext *context=nullptr) const override
Checks whether the specified input value is acceptable for the parameter.
QStringList dependsOnOtherParameters() const override
Returns a list of other parameter names on which this parameter is dependent (e.g.
QString type() const override
Unique parameter type name.
static QString typeName()
Returns the type name for the parameter class.
void setParentLayerParameterName(const QString &name)
Sets the name of the parent layer parameter.
QgsProcessingParameterDefinition * clone() const override
Creates a clone of the parameter definition.
QString parentLayerParameterName() const
Returns the name of the parent layer parameter, or an empty string if this is not set.
QVariantMap toVariantMap() const override
Saves this parameter to a QVariantMap.
QString valueAsPythonString(const QVariant &value, QgsProcessingContext &context) const override
Returns a string version of the parameter input value, which is suitable for use as an input paramete...
QgsProcessingParameterAggregate(const QString &name, const QString &description=QString(), const QString &parentLayerParameterName=QString(), bool optional=false)
Constructor for QgsProcessingParameterAggregate.
QString asPythonString(QgsProcessing::PythonOutputType outputType=QgsProcessing::PythonQgsProcessingAlgorithmSubclass) const override
Returns the parameter definition as a Python command which can be used within a Python Processing scr...
bool fromVariantMap(const QVariantMap &map) override
Restores this parameter to a QVariantMap.
Base class for the definition of processing parameters.
QString description() const
Returns the description for the parameter.
virtual QVariantMap toVariantMap() const
Saves this parameter to a QVariantMap.
QString name() const
Returns the name of the parameter.
virtual bool fromVariantMap(const QVariantMap &map)
Restores this parameter to a QVariantMap.
static QString stringToPythonLiteral(const QString &string)
Converts a string to a Python string literal.
static QString variantToPythonLiteral(const QVariant &value)
Converts a variant to a Python literal.
PythonOutputType
Available Python output types.
Definition: qgsprocessing.h:63
@ PythonQgsProcessingAlgorithmSubclass
Full Python QgsProcessingAlgorithm subclass.
Definition: qgsprocessing.h:64