QGIS API Documentation 3.99.0-Master (21b3aa880ba)
Loading...
Searching...
No Matches
qgsprocessingparameters.h
Go to the documentation of this file.
1/***************************************************************************
2 qgsprocessingparameters.h
3 -------------------------
4 begin : April 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 QGSPROCESSINGPARAMETERS_H
19#define QGSPROCESSINGPARAMETERS_H
20
21#include <limits>
22
23#include "qgis.h"
24#include "qgis_core.h"
25#include "qgscoordinatereferencesystem.h"
26#include "qgsfilefiltergenerator.h"
27#include "qgsprocessing.h"
28#include "qgsprocessingutils.h"
29#include "qgsproperty.h"
30#include "qgsremappingproxyfeaturesink.h"
31
32#include <QColor>
33#include <QMap>
34
35class QgsProcessingContext;
36class QgsProcessingAlgorithm;
37class QgsRasterLayer;
38class QgsMeshLayer;
39class QgsVectorLayer;
40class QgsFeatureSink;
41class QgsProcessingFeatureSource;
42class QgsProcessingOutputDefinition;
43class QgsProcessingFeedback;
44class QgsProcessingProvider;
45class QgsPrintLayout;
46class QgsLayoutItem;
47class QgsPointCloudLayer;
48class QgsAnnotationLayer;
49
57
58class CORE_EXPORT QgsProcessingFeatureSourceDefinition
59{
60 public:
61
87
113
117 QgsProperty source;
118
122 bool selectedFeaturesOnly;
123
130 long long featureLimit = -1;
131
137 QString filterExpression;
138
144 Qgis::ProcessingFeatureSourceDefinitionFlags flags;
145
153 Qgis::InvalidGeometryCheck geometryCheck = Qgis::InvalidGeometryCheck::AbortOnInvalid;
154
161 QVariant toVariant() const;
162
169 bool loadVariant( const QVariantMap &map );
170
171 // TODO c++20 - replace with = default
172 bool operator==( const QgsProcessingFeatureSourceDefinition &other ) const
173 {
174 return source == other.source
175 && selectedFeaturesOnly == other.selectedFeaturesOnly
176 && featureLimit == other.featureLimit
177 && filterExpression == other.filterExpression
178 && flags == other.flags
179 && geometryCheck == other.geometryCheck;
180 }
181
182 bool operator!=( const QgsProcessingFeatureSourceDefinition &other ) const
183 {
184 return !( *this == other );
185 }
186
188 operator QVariant() const
189 {
190 return QVariant::fromValue( *this );
191 }
192
193};
194
195Q_DECLARE_METATYPE( QgsProcessingFeatureSourceDefinition )
196
197
204
205class CORE_EXPORT QgsProcessingRasterLayerDefinition
206{
207 public:
208
218 QgsProcessingRasterLayerDefinition( const QString &source = QString(), const double referenceScale = 0, const int dpi = 96 )
219 : source( QgsProperty::fromValue( source ) )
220 , referenceScale( referenceScale )
221 , dpi( dpi )
222 {}
223
233 QgsProcessingRasterLayerDefinition( const QgsProperty &source, const double referenceScale = 0, const int dpi = 96 )
234 : source( source )
235 , referenceScale( referenceScale )
236 , dpi( dpi )
237 {}
238
242 QgsProperty source;
243
247 double referenceScale = 0;
248
252 int dpi = 96;
253
259 QVariant toVariant() const;
260
266 bool loadVariant( const QVariantMap &map );
267
268 // TODO c++20 - replace with = default
269 bool operator==( const QgsProcessingRasterLayerDefinition &other ) const
270 {
271 return source == other.source
272 && referenceScale == other.referenceScale
273 && dpi == other.dpi;
274 }
275
276 bool operator!=( const QgsProcessingRasterLayerDefinition &other ) const
277 {
278 return !( *this == other );
279 }
280
282 operator QVariant() const
283 {
284 return QVariant::fromValue( *this );
285 }
286
287};
288
289Q_DECLARE_METATYPE( QgsProcessingRasterLayerDefinition )
290
291
298
299class CORE_EXPORT QgsProcessingOutputLayerDefinition
300{
301 public:
302
308 QgsProcessingOutputLayerDefinition( const QString &sink = QString(), QgsProject *destinationProject = nullptr )
309 : sink( QgsProperty::fromValue( sink ) )
310 , destinationProject( destinationProject )
311 {}
312
322
326 QgsProperty sink;
327
333 QgsProject *destinationProject = nullptr;
334
338 QString destinationName;
339
346 QVariantMap createOptions;
347
354 bool useRemapping() const { return mUseRemapping; }
355
363 QgsRemappingSinkDefinition remappingDefinition() const { return mRemappingDefinition; }
364
375 void setRemappingDefinition( const QgsRemappingSinkDefinition &definition );
376
383 QVariant toVariant() const;
384
391 bool loadVariant( const QVariantMap &map );
392
394 operator QVariant() const
395 {
396 return QVariant::fromValue( *this );
397 }
398
399 // TODO c++20 - replace with = default
400 bool operator==( const QgsProcessingOutputLayerDefinition &other ) const;
401 bool operator!=( const QgsProcessingOutputLayerDefinition &other ) const;
402
403 private:
404
405 bool mUseRemapping = false;
406 QgsRemappingSinkDefinition mRemappingDefinition = QgsRemappingSinkDefinition();
407
408};
409
410Q_DECLARE_METATYPE( QgsProcessingOutputLayerDefinition )
411
412
413
414
415//
416// Parameter definitions
417//
418
419
429
430class CORE_EXPORT QgsProcessingParameterDefinition
431{
432
433#ifdef SIP_RUN
434 % TypeHeaderCode
435#include "qgsprocessingparameteraggregate.h"
436#include "qgsprocessingparameterdxflayers.h"
437#include "qgsprocessingparameterfieldmap.h"
438#include "qgsprocessingparametertininputlayers.h"
439#include "qgsprocessingparametervectortilewriterlayers.h"
440#include "qgsprocessingparametermeshdataset.h"
441 % End
442 SIP_CONVERT_TO_SUBCLASS_CODE
443 if ( sipCpp->type() == QgsProcessingParameterBoolean::typeName() )
444 sipType = sipType_QgsProcessingParameterBoolean;
445 else if ( sipCpp->type() == QgsProcessingParameterCrs::typeName() )
446 sipType = sipType_QgsProcessingParameterCrs;
447 else if ( sipCpp->type() == QgsProcessingParameterMapLayer::typeName() )
448 sipType = sipType_QgsProcessingParameterMapLayer;
449 else if ( sipCpp->type() == QgsProcessingParameterExtent::typeName() )
450 sipType = sipType_QgsProcessingParameterExtent;
451 else if ( sipCpp->type() == QgsProcessingParameterPoint::typeName() )
452 sipType = sipType_QgsProcessingParameterPoint;
453 else if ( sipCpp->type() == QgsProcessingParameterGeometry::typeName() )
454 sipType = sipType_QgsProcessingParameterGeometry;
455 else if ( sipCpp->type() == QgsProcessingParameterFile::typeName() )
456 sipType = sipType_QgsProcessingParameterFile;
457 else if ( sipCpp->type() == QgsProcessingParameterMatrix::typeName() )
458 sipType = sipType_QgsProcessingParameterMatrix;
459 else if ( sipCpp->type() == QgsProcessingParameterMultipleLayers::typeName() )
460 sipType = sipType_QgsProcessingParameterMultipleLayers;
461 else if ( sipCpp->type() == QgsProcessingParameterNumber::typeName() )
462 sipType = sipType_QgsProcessingParameterNumber;
463 else if ( sipCpp->type() == QgsProcessingParameterDistance::typeName() )
464 sipType = sipType_QgsProcessingParameterDistance;
465 else if ( sipCpp->type() == QgsProcessingParameterArea::typeName() )
466 sipType = sipType_QgsProcessingParameterArea;
467 else if ( sipCpp->type() == QgsProcessingParameterVolume::typeName() )
468 sipType = sipType_QgsProcessingParameterVolume;
469 else if ( sipCpp->type() == QgsProcessingParameterDuration::typeName() )
470 sipType = sipType_QgsProcessingParameterDuration;
471 else if ( sipCpp->type() == QgsProcessingParameterScale::typeName() )
472 sipType = sipType_QgsProcessingParameterScale;
473 else if ( sipCpp->type() == QgsProcessingParameterRange::typeName() )
474 sipType = sipType_QgsProcessingParameterRange;
475 else if ( sipCpp->type() == QgsProcessingParameterRasterLayer::typeName() )
476 sipType = sipType_QgsProcessingParameterRasterLayer;
477 else if ( sipCpp->type() == QgsProcessingParameterMeshLayer::typeName() )
478 sipType = sipType_QgsProcessingParameterMeshLayer;
479 else if ( sipCpp->type() == QgsProcessingParameterEnum::typeName() )
480 sipType = sipType_QgsProcessingParameterEnum;
481 else if ( sipCpp->type() == QgsProcessingParameterString::typeName() )
482 sipType = sipType_QgsProcessingParameterString;
483 else if ( sipCpp->type() == QgsProcessingParameterExpression::typeName() )
484 sipType = sipType_QgsProcessingParameterExpression;
485 else if ( sipCpp->type() == QgsProcessingParameterAuthConfig::typeName() )
486 sipType = sipType_QgsProcessingParameterAuthConfig;
487 else if ( sipCpp->type() == QgsProcessingParameterVectorLayer::typeName() )
488 sipType = sipType_QgsProcessingParameterVectorLayer;
489 else if ( sipCpp->type() == QgsProcessingParameterField::typeName() )
490 sipType = sipType_QgsProcessingParameterField;
491 else if ( sipCpp->type() == QgsProcessingParameterFeatureSource::typeName() )
492 sipType = sipType_QgsProcessingParameterFeatureSource;
493 else if ( sipCpp->type() == QgsProcessingParameterFeatureSink::typeName() )
494 sipType = sipType_QgsProcessingParameterFeatureSink;
495 else if ( sipCpp->type() == QgsProcessingParameterVectorDestination::typeName() )
496 sipType = sipType_QgsProcessingParameterVectorDestination;
497 else if ( sipCpp->type() == QgsProcessingParameterRasterDestination::typeName() )
498 sipType = sipType_QgsProcessingParameterRasterDestination;
499 else if ( sipCpp->type() == QgsProcessingParameterPointCloudDestination::typeName() )
500 sipType = sipType_QgsProcessingParameterPointCloudDestination;
501 else if ( sipCpp->type() == QgsProcessingParameterFileDestination::typeName() )
502 sipType = sipType_QgsProcessingParameterFileDestination;
503 else if ( sipCpp->type() == QgsProcessingParameterFolderDestination::typeName() )
504 sipType = sipType_QgsProcessingParameterFolderDestination;
505 else if ( sipCpp->type() == QgsProcessingParameterBand::typeName() )
506 sipType = sipType_QgsProcessingParameterBand;
507 else if ( sipCpp->type() == QgsProcessingParameterLayout::typeName() )
508 sipType = sipType_QgsProcessingParameterLayout;
509 else if ( sipCpp->type() == QgsProcessingParameterLayoutItem::typeName() )
510 sipType = sipType_QgsProcessingParameterLayoutItem;
511 else if ( sipCpp->type() == QgsProcessingParameterColor::typeName() )
512 sipType = sipType_QgsProcessingParameterColor;
513 else if ( sipCpp->type() == QgsProcessingParameterCoordinateOperation::typeName() )
514 sipType = sipType_QgsProcessingParameterCoordinateOperation;
515 else if ( sipCpp->type() == QgsProcessingParameterMapTheme::typeName() )
516 sipType = sipType_QgsProcessingParameterMapTheme;
517 else if ( sipCpp->type() == QgsProcessingParameterDateTime::typeName() )
518 sipType = sipType_QgsProcessingParameterDateTime;
519 else if ( sipCpp->type() == QgsProcessingParameterProviderConnection::typeName() )
520 sipType = sipType_QgsProcessingParameterProviderConnection;
521 else if ( sipCpp->type() == QgsProcessingParameterDatabaseSchema::typeName() )
522 sipType = sipType_QgsProcessingParameterDatabaseSchema;
523 else if ( sipCpp->type() == QgsProcessingParameterDatabaseTable::typeName() )
524 sipType = sipType_QgsProcessingParameterDatabaseTable;
525 else if ( sipCpp->type() == QgsProcessingParameterFieldMapping::typeName() )
526 sipType = sipType_QgsProcessingParameterFieldMapping;
527 else if ( sipCpp->type() == QgsProcessingParameterTinInputLayers::typeName() )
528 sipType = sipType_QgsProcessingParameterTinInputLayers;
529 else if ( sipCpp->type() == QgsProcessingParameterVectorTileWriterLayers::typeName() )
530 sipType = sipType_QgsProcessingParameterVectorTileWriterLayers;
531 else if ( sipCpp->type() == QgsProcessingParameterDxfLayers::typeName() )
532 sipType = sipType_QgsProcessingParameterDxfLayers;
533 else if ( sipCpp->type() == QgsProcessingParameterMeshDatasetGroups::typeName() )
534 sipType = sipType_QgsProcessingParameterMeshDatasetGroups;
535 else if ( sipCpp->type() == QgsProcessingParameterMeshDatasetTime::typeName() )
536 sipType = sipType_QgsProcessingParameterMeshDatasetTime;
537 else if ( sipCpp->type() == QgsProcessingParameterPointCloudLayer::typeName() )
538 sipType = sipType_QgsProcessingParameterPointCloudLayer;
539 else if ( sipCpp->type() == QgsProcessingParameterAnnotationLayer::typeName() )
540 sipType = sipType_QgsProcessingParameterAnnotationLayer;
541 else if ( sipCpp->type() == QgsProcessingParameterPointCloudAttribute::typeName() )
542 sipType = sipType_QgsProcessingParameterPointCloudAttribute;
543 else if ( sipCpp->type() == QgsProcessingParameterVectorTileDestination::typeName() )
544 sipType = sipType_QgsProcessingParameterVectorTileDestination;
545 else
546 sipType = nullptr;
547 SIP_END
548#endif
549
550 public:
551
555 QgsProcessingParameterDefinition( const QString &name, const QString &description = QString(), const QVariant &defaultValue = QVariant(),
556 bool optional = false, const QString &help = QString() );
557
558 virtual ~QgsProcessingParameterDefinition() = default;
559
567 virtual QColor modelColor() const;
568
575 virtual QString userFriendlyString( const QVariant &value ) const;
576
580 virtual QgsProcessingParameterDefinition *clone() const = 0 SIP_FACTORY;
581
585 virtual QString type() const = 0;
586
592 virtual bool isDestination() const { return false; }
593
599 QString name() const { return mName; }
600
606 void setName( const QString &name ) { mName = name; }
607
613 QString description() const { return mDescription; }
614
620 void setDescription( const QString &description ) { mDescription = description; }
621
631 QString help() const { return mHelp; }
632
642 void setHelp( const QString &help ) { mHelp = help; }
643
650 QVariant defaultValue() const { return mDefault; }
651
658 void setDefaultValue( const QVariant &value ) { mDefault = value; }
659
672 QVariant guiDefaultValueOverride() const;
673
689 void setGuiDefaultValueOverride( const QVariant &value ) { mGuiDefault = value; }
690
699 QVariant defaultValueForGui() const;
700
705 Qgis::ProcessingParameterFlags flags() const { return mFlags; }
706
711 void setFlags( Qgis::ProcessingParameterFlags flags ) { mFlags = flags; }
712
720 virtual bool checkValueIsAcceptable( const QVariant &input, QgsProcessingContext *context = nullptr ) const;
721
729 virtual QString valueAsPythonString( const QVariant &value, QgsProcessingContext &context ) const;
730
742 virtual QVariant valueAsJsonObject( const QVariant &value, QgsProcessingContext &context ) const;
743
757 virtual QString valueAsString( const QVariant &value, QgsProcessingContext &context, bool &ok SIP_OUT ) const;
758
772 virtual QStringList valueAsStringList( const QVariant &value, QgsProcessingContext &context, bool &ok SIP_OUT ) const;
773
779 virtual QString valueAsPythonComment( const QVariant &value, QgsProcessingContext &context ) const;
780
785 virtual QString asScriptCode() const;
786
796 virtual QString asPythonString( QgsProcessing::PythonOutputType outputType = QgsProcessing::PythonOutputType::PythonQgsProcessingAlgorithmSubclass ) const;
797
803 virtual QVariantMap toVariantMap() const;
804
810 virtual bool fromVariantMap( const QVariantMap &map );
811
818 SIP_SKIP QVariantMap metadata() const { return mMetadata; }
819
825 QVariantMap &metadata() { return mMetadata; }
826
832 void setMetadata( const QVariantMap &metadata ) { mMetadata = metadata; }
833
838 virtual QStringList dependsOnOtherParameters() const { return QStringList(); }
839
845 QgsProcessingAlgorithm *algorithm() const;
846
852 QgsProcessingProvider *provider() const;
853
858 virtual QString toolTip() const;
859
867 bool isDynamic() const { return mIsDynamic; }
868
876 void setIsDynamic( bool dynamic ) { mIsDynamic = dynamic; }
877
884 QgsPropertyDefinition dynamicPropertyDefinition() const { return mPropertyDefinition; }
885
892 void setDynamicPropertyDefinition( const QgsPropertyDefinition &definition ) { mPropertyDefinition = definition; }
893
905 QString dynamicLayerParameterName() const { return mDynamicLayerParameterName; }
906
918 void setDynamicLayerParameterName( const QString &name ) { mDynamicLayerParameterName = name; }
919
933 QStringList additionalExpressionContextVariables() const { return mAdditionalExpressionVariables; }
934
952 void setAdditionalExpressionContextVariables( const QStringList &variables ) { mAdditionalExpressionVariables = variables; }
953
954#ifndef SIP_RUN
955
963 enum class ValueAsStringFlag : int
964 {
965 AllowMapLayerValues = 1 << 0,
966 };
967 Q_DECLARE_FLAGS( ValueAsStringFlags, ValueAsStringFlag )
968#endif
969
970 protected:
971
972#ifndef SIP_RUN
973
980 QString valueAsStringPrivate( const QVariant &value, QgsProcessingContext &context, bool &ok, ValueAsStringFlags flags ) const;
981
988 QVariant valueAsJsonObjectPrivate( const QVariant &value, QgsProcessingContext &context, ValueAsStringFlags flags ) const;
989#endif
990
997 QVariant defaultGuiValueFromSetting() const;
998
1000 QString mName;
1001
1003 QString mDescription;
1004
1006 QString mHelp;
1007
1009 QVariant mDefault;
1010
1012 QVariant mGuiDefault;
1013
1015 Qgis::ProcessingParameterFlags mFlags;
1016
1018 QVariantMap mMetadata;
1019
1021 QgsProcessingAlgorithm *mAlgorithm = nullptr;
1022
1024 bool mIsDynamic = false;
1025
1027 QgsPropertyDefinition mPropertyDefinition;
1028
1030 QString mDynamicLayerParameterName;
1031
1033 QStringList mAdditionalExpressionVariables;
1034
1035 // To allow access to mAlgorithm. We don't want a public setter for this!
1036 friend class QgsProcessingAlgorithm;
1037
1038};
1039
1040#ifndef SIP_RUN
1041Q_DECLARE_OPERATORS_FOR_FLAGS( QgsProcessingParameterDefinition::ValueAsStringFlags )
1042#endif
1043
1045typedef QList< const QgsProcessingParameterDefinition * > QgsProcessingParameterDefinitions;
1046
1063
1064class CORE_EXPORT QgsProcessingParameters
1065{
1066
1067 public:
1068
1073 static bool isDynamic( const QVariantMap &parameters, const QString &name );
1074
1078 static QString parameterAsString( const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters, const QgsProcessingContext &context );
1079
1084 static QString parameterAsString( const QgsProcessingParameterDefinition *definition, const QVariant &value, const QgsProcessingContext &context );
1085
1089 static QString parameterAsExpression( const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters, const QgsProcessingContext &context );
1090
1095 static QString parameterAsExpression( const QgsProcessingParameterDefinition *definition, const QVariant &value, const QgsProcessingContext &context );
1096
1100 static double parameterAsDouble( const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters, const QgsProcessingContext &context );
1101
1106 static double parameterAsDouble( const QgsProcessingParameterDefinition *definition, const QVariant &value, const QgsProcessingContext &context );
1107
1111 static int parameterAsInt( const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters, const QgsProcessingContext &context );
1112
1117 static int parameterAsInt( const QgsProcessingParameterDefinition *definition, const QVariant &value, const QgsProcessingContext &context );
1118
1123 static QList<int> parameterAsInts( const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters, const QgsProcessingContext &context );
1124
1129 static QList<int> parameterAsInts( const QgsProcessingParameterDefinition *definition, const QVariant &value, const QgsProcessingContext &context );
1130
1139 static QDateTime parameterAsDateTime( const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters, const QgsProcessingContext &context );
1140
1149 static QDateTime parameterAsDateTime( const QgsProcessingParameterDefinition *definition, const QVariant &value, const QgsProcessingContext &context );
1150
1159 static QDate parameterAsDate( const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters, const QgsProcessingContext &context );
1160
1169 static QDate parameterAsDate( const QgsProcessingParameterDefinition *definition, const QVariant &value, const QgsProcessingContext &context );
1170
1179 static QTime parameterAsTime( const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters, const QgsProcessingContext &context );
1180
1189 static QTime parameterAsTime( const QgsProcessingParameterDefinition *definition, const QVariant &value, const QgsProcessingContext &context );
1190
1194 static int parameterAsEnum( const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters, const QgsProcessingContext &context );
1195
1200 static int parameterAsEnum( const QgsProcessingParameterDefinition *definition, const QVariant &value, const QgsProcessingContext &context );
1201
1205 static QList<int> parameterAsEnums( const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters, const QgsProcessingContext &context );
1206
1211 static QList<int> parameterAsEnums( const QgsProcessingParameterDefinition *definition, const QVariant &value, const QgsProcessingContext &context );
1212
1217 static QString parameterAsEnumString( const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters, const QgsProcessingContext &context );
1218
1223 static QString parameterAsEnumString( const QgsProcessingParameterDefinition *definition, const QVariant &value, const QgsProcessingContext &context );
1224
1229 static QStringList parameterAsEnumStrings( const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters, const QgsProcessingContext &context );
1230
1235 static QStringList parameterAsEnumStrings( const QgsProcessingParameterDefinition *definition, const QVariant &value, const QgsProcessingContext &context );
1236
1240 static bool parameterAsBool( const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters, const QgsProcessingContext &context );
1241
1247 static bool parameterAsBoolean( const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters, const QgsProcessingContext &context );
1248
1253 static bool parameterAsBool( const QgsProcessingParameterDefinition *definition, const QVariant &value, const QgsProcessingContext &context );
1254
1259 static bool parameterAsBoolean( const QgsProcessingParameterDefinition *definition, const QVariant &value, const QgsProcessingContext &context );
1260
1278 static QgsFeatureSink *parameterAsSink( const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters,
1279 const QgsFields &fields, Qgis::WkbType geometryType, const QgsCoordinateReferenceSystem &crs,
1280 QgsProcessingContext &context, QString &destinationIdentifier SIP_OUT, QgsFeatureSink::SinkFlags sinkFlags = QgsFeatureSink::SinkFlags(), const QVariantMap &createOptions = QVariantMap(), const QStringList &datasourceOptions = QStringList(), const QStringList &layerOptions = QStringList() ) SIP_FACTORY;
1281
1301 static QgsFeatureSink *parameterAsSink( const QgsProcessingParameterDefinition *definition, const QVariant &value,
1302 const QgsFields &fields, Qgis::WkbType geometryType, const QgsCoordinateReferenceSystem &crs,
1303 QgsProcessingContext &context, QString &destinationIdentifier SIP_OUT, QgsFeatureSink::SinkFlags sinkFlags = QgsFeatureSink::SinkFlags(), const QVariantMap &createOptions = QVariantMap(), const QStringList &datasourceOptions = QStringList(), const QStringList &layerOptions = QStringList() ) SIP_THROW( QgsProcessingException ) SIP_FACTORY;
1304
1313 static QgsProcessingFeatureSource *parameterAsSource( const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters, QgsProcessingContext &context ) SIP_FACTORY;
1314
1325 static QgsProcessingFeatureSource *parameterAsSource( const QgsProcessingParameterDefinition *definition, const QVariant &value, QgsProcessingContext &context ) SIP_FACTORY;
1326
1342 static QString parameterAsCompatibleSourceLayerPath( const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters,
1343 QgsProcessingContext &context, const QStringList &compatibleFormats, const QString &preferredFormat = QString( "shp" ), QgsProcessingFeedback *feedback = nullptr );
1344
1374 static QString parameterAsCompatibleSourceLayerPathAndLayerName( const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters,
1375 QgsProcessingContext &context, const QStringList &compatibleFormats, const QString &preferredFormat = QString( "shp" ), QgsProcessingFeedback *feedback = nullptr, QString *layerName SIP_OUT = nullptr );
1376
1384 static QgsMapLayer *parameterAsLayer( const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingUtils::LayerHint layerHint = QgsProcessingUtils::LayerHint::UnknownType, QgsProcessing::LayerOptionsFlags flags = QgsProcessing::LayerOptionsFlags() );
1385
1395 static QgsMapLayer *parameterAsLayer( const QgsProcessingParameterDefinition *definition, const QVariant &value, QgsProcessingContext &context, QgsProcessingUtils::LayerHint layerHint = QgsProcessingUtils::LayerHint::UnknownType, QgsProcessing::LayerOptionsFlags flags = QgsProcessing::LayerOptionsFlags() );
1396
1404 static QgsRasterLayer *parameterAsRasterLayer( const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters, QgsProcessingContext &context );
1405
1415 static QgsRasterLayer *parameterAsRasterLayer( const QgsProcessingParameterDefinition *definition, const QVariant &value, QgsProcessingContext &context );
1416
1420 static QString parameterAsOutputLayer( const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters, QgsProcessingContext &context );
1421
1430 static QString parameterAsOutputLayer( const QgsProcessingParameterDefinition *definition, const QVariant &value, QgsProcessingContext &context, bool testOnly = false );
1431
1435 static QString parameterAsFileOutput( const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters, QgsProcessingContext &context );
1436
1441 static QString parameterAsFileOutput( const QgsProcessingParameterDefinition *definition, const QVariant &value, QgsProcessingContext &context );
1442
1450 static QgsVectorLayer *parameterAsVectorLayer( const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters, QgsProcessingContext &context );
1451
1461 static QgsVectorLayer *parameterAsVectorLayer( const QgsProcessingParameterDefinition *definition, const QVariant &value, QgsProcessingContext &context );
1462
1472 static QgsMeshLayer *parameterAsMeshLayer( const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters, QgsProcessingContext &context );
1473
1483 static QgsMeshLayer *parameterAsMeshLayer( const QgsProcessingParameterDefinition *definition, const QVariant &value, QgsProcessingContext &context );
1484
1488 static QgsCoordinateReferenceSystem parameterAsCrs( const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters, QgsProcessingContext &context );
1489
1494 static QgsCoordinateReferenceSystem parameterAsCrs( const QgsProcessingParameterDefinition *definition, const QVariant &value, QgsProcessingContext &context );
1495
1505 static QgsRectangle parameterAsExtent( const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters, QgsProcessingContext &context,
1506 const QgsCoordinateReferenceSystem &crs = QgsCoordinateReferenceSystem() );
1507
1519 static QgsRectangle parameterAsExtent( const QgsProcessingParameterDefinition *definition, const QVariant &value, QgsProcessingContext &context,
1520 const QgsCoordinateReferenceSystem &crs = QgsCoordinateReferenceSystem() );
1521
1533 static QgsGeometry parameterAsExtentGeometry( const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters, QgsProcessingContext &context,
1534 const QgsCoordinateReferenceSystem &crs = QgsCoordinateReferenceSystem() );
1535
1541 static QgsCoordinateReferenceSystem parameterAsExtentCrs( const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters, QgsProcessingContext &context );
1542
1548 static QgsCoordinateReferenceSystem parameterAsExtentCrs( const QgsProcessingParameterDefinition *definition, const QVariant &value, QgsProcessingContext &context );
1549
1550
1558 static QgsPointXY parameterAsPoint( const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters, QgsProcessingContext &context,
1559 const QgsCoordinateReferenceSystem &crs = QgsCoordinateReferenceSystem() );
1560
1569 static QgsPointXY parameterAsPoint( const QgsProcessingParameterDefinition *definition, const QVariant &value, QgsProcessingContext &context,
1570 const QgsCoordinateReferenceSystem &crs = QgsCoordinateReferenceSystem() );
1571
1577 static QgsCoordinateReferenceSystem parameterAsPointCrs( const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters, QgsProcessingContext &context );
1578
1585 static QgsCoordinateReferenceSystem parameterAsPointCrs( const QgsProcessingParameterDefinition *definition, const QVariant &value, QgsProcessingContext &context );
1586
1592 static QgsGeometry parameterAsGeometry( const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters, QgsProcessingContext &context, const QgsCoordinateReferenceSystem &crs = QgsCoordinateReferenceSystem() );
1593
1599 static QgsGeometry parameterAsGeometry( const QgsProcessingParameterDefinition *definition, const QVariant &value, QgsProcessingContext &context, const QgsCoordinateReferenceSystem &crs = QgsCoordinateReferenceSystem() );
1600
1607 static QgsCoordinateReferenceSystem parameterAsGeometryCrs( const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters, QgsProcessingContext &context );
1608
1615 static QgsCoordinateReferenceSystem parameterAsGeometryCrs( const QgsProcessingParameterDefinition *definition, const QVariant &value, QgsProcessingContext &context );
1616
1620 static QString parameterAsFile( const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters, QgsProcessingContext &context );
1621
1626 static QString parameterAsFile( const QgsProcessingParameterDefinition *definition, const QVariant &value, QgsProcessingContext &context );
1627
1632 static QVariantList parameterAsMatrix( const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters, QgsProcessingContext &context );
1633
1639 static QVariantList parameterAsMatrix( const QgsProcessingParameterDefinition *definition, const QVariant &value, QgsProcessingContext &context );
1640
1645 static QList< QgsMapLayer *> parameterAsLayerList( const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessing::LayerOptionsFlags flags = QgsProcessing::LayerOptionsFlags() );
1646
1652 static QList< QgsMapLayer *> parameterAsLayerList( const QgsProcessingParameterDefinition *definition, const QVariant &value, QgsProcessingContext &context, QgsProcessing::LayerOptionsFlags flags = QgsProcessing::LayerOptionsFlags() );
1653
1659 static QStringList parameterAsFileList( const QgsProcessingParameterDefinition *definition, const QVariant &value, QgsProcessingContext &context );
1660
1666 static QStringList parameterAsFileList( const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters, QgsProcessingContext &context );
1667
1671 static QList<double> parameterAsRange( const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters, QgsProcessingContext &context );
1672
1677 static QList<double> parameterAsRange( const QgsProcessingParameterDefinition *definition, const QVariant &value, QgsProcessingContext &context );
1678
1684 Q_DECL_DEPRECATED static QStringList parameterAsFields( const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters, QgsProcessingContext &context ) SIP_DEPRECATED;
1685
1692 Q_DECL_DEPRECATED static QStringList parameterAsFields( const QgsProcessingParameterDefinition *definition, const QVariant &value, QgsProcessingContext &context ) SIP_DEPRECATED;
1693
1699 static QStringList parameterAsStrings( const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters, QgsProcessingContext &context );
1700
1706 static QStringList parameterAsStrings( const QgsProcessingParameterDefinition *definition, const QVariant &value, QgsProcessingContext &context );
1707
1716 static QgsPrintLayout *parameterAsLayout( const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters, QgsProcessingContext &context );
1717
1726 static QgsPrintLayout *parameterAsLayout( const QgsProcessingParameterDefinition *definition, const QVariant &value, QgsProcessingContext &context );
1727
1736 static QgsLayoutItem *parameterAsLayoutItem( const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters, QgsProcessingContext &context, QgsPrintLayout *layout );
1737
1746 static QgsLayoutItem *parameterAsLayoutItem( const QgsProcessingParameterDefinition *definition, const QVariant &value, QgsProcessingContext &context, QgsPrintLayout *layout );
1747
1753 static QColor parameterAsColor( const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters, QgsProcessingContext &context );
1754
1760 static QColor parameterAsColor( const QgsProcessingParameterDefinition *definition, const QVariant &value, QgsProcessingContext &context );
1761
1767 static QString parameterAsConnectionName( const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters, const QgsProcessingContext &context );
1768
1774 static QString parameterAsConnectionName( const QgsProcessingParameterDefinition *definition, const QVariant &value, const QgsProcessingContext &context );
1775
1781 static QString parameterAsSchema( const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters, const QgsProcessingContext &context );
1782
1788 static QString parameterAsSchema( const QgsProcessingParameterDefinition *definition, const QVariant &value, const QgsProcessingContext &context );
1789
1795 static QString parameterAsDatabaseTableName( const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters, const QgsProcessingContext &context );
1796
1802 static QString parameterAsDatabaseTableName( const QgsProcessingParameterDefinition *definition, const QVariant &value, const QgsProcessingContext &context );
1803
1814 static QgsPointCloudLayer *parameterAsPointCloudLayer( const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessing::LayerOptionsFlags flags = QgsProcessing::LayerOptionsFlags() );
1815
1826 static QgsPointCloudLayer *parameterAsPointCloudLayer( const QgsProcessingParameterDefinition *definition, const QVariant &value, QgsProcessingContext &context, QgsProcessing::LayerOptionsFlags flags = QgsProcessing::LayerOptionsFlags() );
1827
1841 static QgsAnnotationLayer *parameterAsAnnotationLayer( const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters, QgsProcessingContext &context );
1842
1856 static QgsAnnotationLayer *parameterAsAnnotationLayer( const QgsProcessingParameterDefinition *definition, const QVariant &value, QgsProcessingContext &context );
1857
1863 static QgsProcessingParameterDefinition *parameterFromVariantMap( const QVariantMap &map ) SIP_FACTORY;
1864
1868 static QString descriptionFromName( const QString &name );
1869
1875 static QgsProcessingParameterDefinition *parameterFromScriptCode( const QString &code ) SIP_FACTORY;
1876
1877 private:
1878
1879 static bool parseScriptCodeParameterOptions( const QString &code, bool &isOptional, QString &name, QString &type, QString &definition );
1880};
1881
1882
1883
1889class CORE_EXPORT QgsProcessingParameterBoolean : public QgsProcessingParameterDefinition
1890{
1891 public:
1892
1896 QgsProcessingParameterBoolean( const QString &name, const QString &description = QString(), const QVariant &defaultValue = QVariant(),
1897 bool optional = false );
1898
1902 static QString typeName() { return QStringLiteral( "boolean" ); }
1903 QgsProcessingParameterDefinition *clone() const override SIP_FACTORY;
1904 QString type() const override { return typeName(); }
1905 QString valueAsPythonString( const QVariant &value, QgsProcessingContext &context ) const override;
1906 QString asScriptCode() const override;
1907
1911 static QgsProcessingParameterBoolean *fromScriptCode( const QString &name, const QString &description, bool isOptional, const QString &definition ) SIP_FACTORY;
1912};
1913
1919class CORE_EXPORT QgsProcessingParameterCrs : public QgsProcessingParameterDefinition
1920{
1921 public:
1922
1926 QgsProcessingParameterCrs( const QString &name, const QString &description = QString(), const QVariant &defaultValue = QVariant(),
1927 bool optional = false );
1928
1929 QString userFriendlyString( const QVariant &value ) const override;
1930
1934 static QString typeName() { return QStringLiteral( "crs" ); }
1935 QgsProcessingParameterDefinition *clone() const override SIP_FACTORY;
1936 QString type() const override { return typeName(); }
1937 bool checkValueIsAcceptable( const QVariant &input, QgsProcessingContext *context = nullptr ) const override;
1938 QString valueAsPythonString( const QVariant &value, QgsProcessingContext &context ) const override;
1939 QString valueAsString( const QVariant &value, QgsProcessingContext &context, bool &ok SIP_OUT ) const override;
1940 QVariant valueAsJsonObject( const QVariant &value, QgsProcessingContext &context ) const override;
1941
1945 static QgsProcessingParameterCrs *fromScriptCode( const QString &name, const QString &description, bool isOptional, const QString &definition ) SIP_FACTORY;
1946
1947};
1948
1954class CORE_EXPORT QgsProcessingParameterExtent : public QgsProcessingParameterDefinition
1955{
1956 public:
1957
1961 QgsProcessingParameterExtent( const QString &name, const QString &description = QString(), const QVariant &defaultValue = QVariant(),
1962 bool optional = false );
1963
1967 static QString typeName() { return QStringLiteral( "extent" ); }
1968 QgsProcessingParameterDefinition *clone() const override SIP_FACTORY;
1969 QString type() const override { return typeName(); }
1970 bool checkValueIsAcceptable( const QVariant &input, QgsProcessingContext *context = nullptr ) const override;
1971 QString valueAsPythonString( const QVariant &value, QgsProcessingContext &context ) const override;
1972 QString valueAsString( const QVariant &value, QgsProcessingContext &context, bool &ok SIP_OUT ) const override;
1973 QVariant valueAsJsonObject( const QVariant &value, QgsProcessingContext &context ) const override;
1974
1978 static QgsProcessingParameterExtent *fromScriptCode( const QString &name, const QString &description, bool isOptional, const QString &definition ) SIP_FACTORY;
1979
1980 private:
1981
1987 static bool variantIsValidStringForExtent( const QVariant &value );
1988
1989};
1990
1991
1997class CORE_EXPORT QgsProcessingParameterPoint : public QgsProcessingParameterDefinition
1998{
1999 public:
2000
2004 QgsProcessingParameterPoint( const QString &name, const QString &description = QString(), const QVariant &defaultValue = QVariant(),
2005 bool optional = false );
2006
2010 static QString typeName() { return QStringLiteral( "point" ); }
2011 QgsProcessingParameterDefinition *clone() const override SIP_FACTORY;
2012 QString type() const override { return typeName(); }
2013 bool checkValueIsAcceptable( const QVariant &input, QgsProcessingContext *context = nullptr ) const override;
2014 QString valueAsPythonString( const QVariant &value, QgsProcessingContext &context ) const override;
2015
2019 static QgsProcessingParameterPoint *fromScriptCode( const QString &name, const QString &description, bool isOptional, const QString &definition ) SIP_FACTORY;
2020
2021};
2022
2029class CORE_EXPORT QgsProcessingParameterGeometry : public QgsProcessingParameterDefinition
2030{
2031 public:
2032
2040 QgsProcessingParameterGeometry( const QString &name, const QString &description = QString(), const QVariant &defaultValue = QVariant(), bool optional = false, const QList< int > &geometryTypes = QList< int >(), bool allowMultipart = true );
2041
2045 static QString typeName() { return QStringLiteral( "geometry" ); }
2046 QgsProcessingParameterDefinition *clone() const override SIP_FACTORY;
2047 QString type() const override { return typeName(); }
2048 bool checkValueIsAcceptable( const QVariant &input, QgsProcessingContext *context = nullptr ) const override;
2049 QString valueAsPythonString( const QVariant &value, QgsProcessingContext &context ) const override;
2050 QString asScriptCode() const override;
2051 QString asPythonString( QgsProcessing::PythonOutputType outputType = QgsProcessing::PythonOutputType::PythonQgsProcessingAlgorithmSubclass ) const override;
2052 QVariantMap toVariantMap() const override;
2053 bool fromVariantMap( const QVariantMap &map ) override;
2054
2059 QList<int> geometryTypes() const { return mGeomTypes; }
2060
2065 void setGeometryTypes( const QList<int> &geometryTypes ) { mGeomTypes = geometryTypes; }
2066
2071 bool allowMultipart() const { return mAllowMultipart; }
2072
2077 void setAllowMultipart( bool allowMultipart ) { mAllowMultipart = allowMultipart; }
2078
2079 QString userFriendlyString( const QVariant &value ) const override;
2080
2084 static QgsProcessingParameterGeometry *fromScriptCode( const QString &name, const QString &description, bool isOptional, const QString &definition ) SIP_FACTORY;
2085
2086 private:
2087
2088 QList<int> mGeomTypes;
2089 bool mAllowMultipart;
2090
2091};
2092
2098class CORE_EXPORT QgsProcessingParameterFile : public QgsProcessingParameterDefinition, public QgsFileFilterGenerator
2099{
2100 public:
2101
2109 QgsProcessingParameterFile( const QString &name, const QString &description = QString(), Qgis::ProcessingFileParameterBehavior behavior = Qgis::ProcessingFileParameterBehavior::File, const QString &extension = QString(), const QVariant &defaultValue = QVariant(),
2110 bool optional = false, const QString &fileFilter = QString() );
2111
2115 static QString typeName() { return QStringLiteral( "file" ); }
2116 QgsProcessingParameterDefinition *clone() const override SIP_FACTORY;
2117 QString type() const override { return typeName(); }
2118 bool checkValueIsAcceptable( const QVariant &input, QgsProcessingContext *context = nullptr ) const override;
2119 QString asScriptCode() const override;
2120 QString asPythonString( QgsProcessing::PythonOutputType outputType = QgsProcessing::PythonOutputType::PythonQgsProcessingAlgorithmSubclass ) const override;
2121 QString createFileFilter() const override;
2122
2127 Qgis::ProcessingFileParameterBehavior behavior() const { return mBehavior; }
2128
2133 void setBehavior( Qgis::ProcessingFileParameterBehavior behavior ) { mBehavior = behavior; }
2134
2142 QString extension() const { return mExtension; }
2143
2153 void setExtension( const QString &extension );
2154
2161 QString fileFilter() const;
2162
2172 void setFileFilter( const QString &filter );
2173
2174 QVariantMap toVariantMap() const override;
2175 bool fromVariantMap( const QVariantMap &map ) override;
2176
2180 static QgsProcessingParameterFile *fromScriptCode( const QString &name, const QString &description, bool isOptional, const QString &definition, Qgis::ProcessingFileParameterBehavior behavior = Qgis::ProcessingFileParameterBehavior::File ) SIP_FACTORY;
2181
2182 private:
2183
2184 Qgis::ProcessingFileParameterBehavior mBehavior = Qgis::ProcessingFileParameterBehavior::File;
2185 QString mExtension;
2186 QString mFileFilter;
2187};
2188
2194class CORE_EXPORT QgsProcessingParameterMatrix : public QgsProcessingParameterDefinition
2195{
2196 public:
2197
2201 QgsProcessingParameterMatrix( const QString &name, const QString &description = QString(), int numberRows = 3,
2202 bool hasFixedNumberRows = false, const QStringList &headers = QStringList(),
2203 const QVariant &defaultValue = QVariant(),
2204 bool optional = false );
2205
2209 static QString typeName() { return QStringLiteral( "matrix" ); }
2210
2211 QgsProcessingParameterDefinition *clone() const override SIP_FACTORY;
2212 QString type() const override { return typeName(); }
2213 bool checkValueIsAcceptable( const QVariant &input, QgsProcessingContext *context = nullptr ) const override;
2214 QString valueAsPythonString( const QVariant &value, QgsProcessingContext &context ) const override;
2215 QString asPythonString( QgsProcessing::PythonOutputType outputType = QgsProcessing::PythonOutputType::PythonQgsProcessingAlgorithmSubclass ) const override;
2216
2221 QStringList headers() const;
2222
2227 void setHeaders( const QStringList &headers );
2228
2235 int numberRows() const;
2236
2243 void setNumberRows( int rows );
2244
2250 bool hasFixedNumberRows() const;
2251
2257 void setHasFixedNumberRows( bool hasFixedNumberRows );
2258
2259 QVariantMap toVariantMap() const override;
2260 bool fromVariantMap( const QVariantMap &map ) override;
2261
2265 static QgsProcessingParameterMatrix *fromScriptCode( const QString &name, const QString &description, bool isOptional, const QString &definition ) SIP_FACTORY;
2266
2267 private:
2268
2269 QStringList mHeaders;
2270 int mNumberRows = 3;
2271 bool mFixedNumberRows = false;
2272
2273};
2274
2280class CORE_EXPORT QgsProcessingParameterMultipleLayers : public QgsProcessingParameterDefinition, public QgsFileFilterGenerator
2281{
2282 public:
2283
2287 QgsProcessingParameterMultipleLayers( const QString &name, const QString &description = QString(), Qgis::ProcessingSourceType layerType = Qgis::ProcessingSourceType::VectorAnyGeometry,
2288 const QVariant &defaultValue = QVariant(),
2289 bool optional = false );
2290
2294 static QString typeName() { return QStringLiteral( "multilayer" ); }
2295 QgsProcessingParameterDefinition *clone() const override SIP_FACTORY;
2296 QString type() const override { return typeName(); }
2297 bool checkValueIsAcceptable( const QVariant &input, QgsProcessingContext *context = nullptr ) const override;
2298 QString valueAsPythonString( const QVariant &value, QgsProcessingContext &context ) const override;
2299 QString valueAsString( const QVariant &value, QgsProcessingContext &context, bool &ok SIP_OUT ) const override;
2300 QVariant valueAsJsonObject( const QVariant &value, QgsProcessingContext &context ) const override;
2301 QString asScriptCode() const override;
2302 QString asPythonString( QgsProcessing::PythonOutputType outputType = QgsProcessing::PythonOutputType::PythonQgsProcessingAlgorithmSubclass ) const override;
2303 QString createFileFilter() const override;
2304
2309 Qgis::ProcessingSourceType layerType() const;
2310
2315 void setLayerType( Qgis::ProcessingSourceType type );
2316
2322 int minimumNumberInputs() const;
2323
2329 void setMinimumNumberInputs( int minimum );
2330
2331 QVariantMap toVariantMap() const override;
2332 bool fromVariantMap( const QVariantMap &map ) override;
2333
2337 static QgsProcessingParameterMultipleLayers *fromScriptCode( const QString &name, const QString &description, bool isOptional, const QString &definition ) SIP_FACTORY;
2338
2339 private:
2340
2341 Qgis::ProcessingSourceType mLayerType = Qgis::ProcessingSourceType::VectorAnyGeometry;
2342 int mMinimumNumberInputs = 0;
2343
2344};
2345
2363class CORE_EXPORT QgsProcessingParameterNumber : public QgsProcessingParameterDefinition
2364{
2365 public:
2366
2370 explicit QgsProcessingParameterNumber( const QString &name, const QString &description = QString(),
2371 Qgis::ProcessingNumberParameterType type = Qgis::ProcessingNumberParameterType::Integer,
2372 const QVariant &defaultValue = QVariant(),
2373 bool optional = false,
2374 double minValue = std::numeric_limits<double>::lowest() + 1,
2375 double maxValue = std::numeric_limits<double>::max()
2376 );
2377
2381 static QString typeName() { return QStringLiteral( "number" ); }
2382
2383 QgsProcessingParameterDefinition *clone() const override SIP_FACTORY;
2384 QString type() const override { return typeName(); }
2385 bool checkValueIsAcceptable( const QVariant &input, QgsProcessingContext *context = nullptr ) const override;
2386 QString valueAsPythonString( const QVariant &value, QgsProcessingContext &context ) const override;
2387 QString toolTip() const override;
2388 QString asPythonString( QgsProcessing::PythonOutputType outputType = QgsProcessing::PythonOutputType::PythonQgsProcessingAlgorithmSubclass ) const override;
2389
2394 double minimum() const;
2395
2400 void setMinimum( double minimum );
2401
2406 double maximum() const;
2407
2412 void setMaximum( double maximum );
2413
2418 Qgis::ProcessingNumberParameterType dataType() const;
2419
2424 void setDataType( Qgis::ProcessingNumberParameterType type );
2425
2426 QVariantMap toVariantMap() const override;
2427 bool fromVariantMap( const QVariantMap &map ) override;
2428
2432 static QgsProcessingParameterNumber *fromScriptCode( const QString &name, const QString &description, bool isOptional, const QString &definition ) SIP_FACTORY;
2433
2434 private:
2435
2436 double mMin = std::numeric_limits<double>::lowest() + 1;
2437 double mMax = std::numeric_limits<double>::max();
2438 Qgis::ProcessingNumberParameterType mDataType = Qgis::ProcessingNumberParameterType::Integer;
2439};
2440
2462class CORE_EXPORT QgsProcessingParameterDistance : public QgsProcessingParameterNumber
2463{
2464 public:
2465
2469 explicit QgsProcessingParameterDistance( const QString &name, const QString &description = QString(),
2470 const QVariant &defaultValue = QVariant(),
2471 const QString &parentParameterName = QString(),
2472 bool optional = false,
2473 double minValue = std::numeric_limits<double>::lowest() + 1,
2474 double maxValue = std::numeric_limits<double>::max() );
2475
2479 static QString typeName() { return QStringLiteral( "distance" ); } // cppcheck-suppress duplInheritedMember
2480
2481 QString userFriendlyString( const QVariant &value ) const override;
2482
2483 QgsProcessingParameterDistance *clone() const override SIP_FACTORY;
2484
2485 QString type() const override;
2486 QStringList dependsOnOtherParameters() const override;
2487 QString asPythonString( QgsProcessing::PythonOutputType outputType = QgsProcessing::PythonOutputType::PythonQgsProcessingAlgorithmSubclass ) const override;
2488
2493 QString parentParameterName() const;
2494
2499 void setParentParameterName( const QString &parentParameterName );
2500
2507 Qgis::DistanceUnit defaultUnit() const { return mDefaultUnit; }
2508
2515 void setDefaultUnit( Qgis::DistanceUnit unit ) { mDefaultUnit = unit; }
2516
2517 QVariantMap toVariantMap() const override;
2518 bool fromVariantMap( const QVariantMap &map ) override;
2519
2520 private:
2521
2522 QString mParentParameterName;
2523 Qgis::DistanceUnit mDefaultUnit = Qgis::DistanceUnit::Unknown;
2524
2525};
2526
2527
2549class CORE_EXPORT QgsProcessingParameterArea : public QgsProcessingParameterNumber
2550{
2551 public:
2552
2556 explicit QgsProcessingParameterArea( const QString &name, const QString &description = QString(),
2557 const QVariant &defaultValue = QVariant(),
2558 const QString &parentParameterName = QString(),
2559 bool optional = false,
2560 double minValue = 0,
2561 double maxValue = std::numeric_limits<double>::max() );
2562
2566 static QString typeName() { return QStringLiteral( "area" ); } // cppcheck-suppress duplInheritedMember
2567
2568 QgsProcessingParameterArea *clone() const override SIP_FACTORY;
2569
2570 QString type() const override;
2571 QStringList dependsOnOtherParameters() const override;
2572 QString asPythonString( QgsProcessing::PythonOutputType outputType = QgsProcessing::PythonOutputType::PythonQgsProcessingAlgorithmSubclass ) const override;
2573
2578 QString parentParameterName() const;
2579
2584 void setParentParameterName( const QString &parentParameterName );
2585
2591 Qgis::AreaUnit defaultUnit() const { return mDefaultUnit; }
2592
2598 void setDefaultUnit( Qgis::AreaUnit unit ) { mDefaultUnit = unit; }
2599
2600 QVariantMap toVariantMap() const override;
2601 bool fromVariantMap( const QVariantMap &map ) override;
2602 QString userFriendlyString( const QVariant &value ) const override;
2603
2604 private:
2605
2606 QString mParentParameterName;
2607 Qgis::AreaUnit mDefaultUnit = Qgis::AreaUnit::Unknown;
2608
2609};
2610
2611
2633class CORE_EXPORT QgsProcessingParameterVolume : public QgsProcessingParameterNumber
2634{
2635 public:
2636
2640 explicit QgsProcessingParameterVolume( const QString &name, const QString &description = QString(),
2641 const QVariant &defaultValue = QVariant(),
2642 const QString &parentParameterName = QString(),
2643 bool optional = false,
2644 double minValue = 0,
2645 double maxValue = std::numeric_limits<double>::max() );
2646
2650 static QString typeName() { return QStringLiteral( "volume" ); } // cppcheck-suppress duplInheritedMember
2651
2652 QgsProcessingParameterVolume *clone() const override SIP_FACTORY;
2653
2654 QString type() const override;
2655 QStringList dependsOnOtherParameters() const override;
2656 QString asPythonString( QgsProcessing::PythonOutputType outputType = QgsProcessing::PythonOutputType::PythonQgsProcessingAlgorithmSubclass ) const override;
2657
2662 QString parentParameterName() const;
2663
2668 void setParentParameterName( const QString &parentParameterName );
2669
2675 Qgis::VolumeUnit defaultUnit() const { return mDefaultUnit; }
2676
2682 void setDefaultUnit( Qgis::VolumeUnit unit ) { mDefaultUnit = unit; }
2683
2684 QVariantMap toVariantMap() const override;
2685 bool fromVariantMap( const QVariantMap &map ) override;
2686 QString userFriendlyString( const QVariant &value ) const override;
2687
2688 private:
2689
2690 QString mParentParameterName;
2691 Qgis::VolumeUnit mDefaultUnit = Qgis::VolumeUnit::Unknown;
2692
2693};
2694
2695
2704class CORE_EXPORT QgsProcessingParameterDuration : public QgsProcessingParameterNumber
2705{
2706 public:
2707
2711 explicit QgsProcessingParameterDuration( const QString &name, const QString &description = QString(),
2712 const QVariant &defaultValue = QVariant(),
2713 bool optional = false,
2714 double minValue = std::numeric_limits<double>::lowest() + 1,
2715 double maxValue = std::numeric_limits<double>::max() );
2716
2720 static QString typeName() { return QStringLiteral( "duration" ); } // cppcheck-suppress duplInheritedMember
2721
2722 QgsProcessingParameterDuration *clone() const override SIP_FACTORY;
2723
2724 QString type() const override;
2725 QString asPythonString( QgsProcessing::PythonOutputType outputType = QgsProcessing::PythonOutputType::PythonQgsProcessingAlgorithmSubclass ) const override;
2726
2732 Qgis::TemporalUnit defaultUnit() const { return mDefaultUnit; }
2733
2739 void setDefaultUnit( Qgis::TemporalUnit unit ) { mDefaultUnit = unit; }
2740
2741 QVariantMap toVariantMap() const override;
2742 bool fromVariantMap( const QVariantMap &map ) override;
2743 QString userFriendlyString( const QVariant &value ) const override;
2744
2745 private:
2746
2747 Qgis::TemporalUnit mDefaultUnit = Qgis::TemporalUnit::Milliseconds;
2748
2749};
2750
2761class CORE_EXPORT QgsProcessingParameterScale : public QgsProcessingParameterNumber
2762{
2763 public:
2764
2768 explicit QgsProcessingParameterScale( const QString &name, const QString &description = QString(),
2769 const QVariant &defaultValue = QVariant(),
2770 bool optional = false );
2771
2775 static QString typeName() { return QStringLiteral( "scale" ); } // cppcheck-suppress duplInheritedMember
2776
2777 QgsProcessingParameterScale *clone() const override SIP_FACTORY;
2778
2779 QString type() const override;
2780 QString asPythonString( QgsProcessing::PythonOutputType outputType = QgsProcessing::PythonOutputType::PythonQgsProcessingAlgorithmSubclass ) const override;
2781
2785 static QgsProcessingParameterScale *fromScriptCode( const QString &name, const QString &description, bool isOptional, const QString &definition ) SIP_FACTORY; // cppcheck-suppress duplInheritedMember
2786
2787};
2788
2794class CORE_EXPORT QgsProcessingParameterRange : public QgsProcessingParameterDefinition
2795{
2796 public:
2797
2801 QgsProcessingParameterRange( const QString &name, const QString &description = QString(),
2802 Qgis::ProcessingNumberParameterType type = Qgis::ProcessingNumberParameterType::Integer,
2803 const QVariant &defaultValue = QVariant(),
2804 bool optional = false );
2805
2809 static QString typeName() { return QStringLiteral( "range" ); }
2810
2811 QgsProcessingParameterDefinition *clone() const override SIP_FACTORY;
2812 QString type() const override { return typeName(); }
2813 bool checkValueIsAcceptable( const QVariant &input, QgsProcessingContext *context = nullptr ) const override;
2814 QString valueAsPythonString( const QVariant &value, QgsProcessingContext &context ) const override;
2815 QString asPythonString( QgsProcessing::PythonOutputType outputType = QgsProcessing::PythonOutputType::PythonQgsProcessingAlgorithmSubclass ) const override;
2816
2821 Qgis::ProcessingNumberParameterType dataType() const;
2822
2827 void setDataType( Qgis::ProcessingNumberParameterType dataType );
2828
2829 QVariantMap toVariantMap() const override;
2830 bool fromVariantMap( const QVariantMap &map ) override;
2831
2835 static QgsProcessingParameterRange *fromScriptCode( const QString &name, const QString &description, bool isOptional, const QString &definition ) SIP_FACTORY;
2836
2837 private:
2838
2839 Qgis::ProcessingNumberParameterType mDataType = Qgis::ProcessingNumberParameterType::Integer;
2840};
2841
2847class CORE_EXPORT QgsProcessingParameterRasterLayer : public QgsProcessingParameterDefinition, public QgsFileFilterGenerator
2848{
2849 public:
2850
2854 QgsProcessingParameterRasterLayer( const QString &name, const QString &description = QString(), const QVariant &defaultValue = QVariant(),
2855 bool optional = false );
2856
2860 static QString typeName() { return QStringLiteral( "raster" ); }
2861 QgsProcessingParameterDefinition *clone() const override SIP_FACTORY;
2862 QString type() const override { return typeName(); }
2863 bool checkValueIsAcceptable( const QVariant &input, QgsProcessingContext *context = nullptr ) const override;
2864 QString valueAsPythonString( const QVariant &value, QgsProcessingContext &context ) const override;
2865 QString valueAsString( const QVariant &value, QgsProcessingContext &context, bool &ok SIP_OUT ) const override;
2866 QVariant valueAsJsonObject( const QVariant &value, QgsProcessingContext &context ) const override;
2867 QString createFileFilter() const override;
2868
2872 static QgsProcessingParameterRasterLayer *fromScriptCode( const QString &name, const QString &description, bool isOptional, const QString &definition ) SIP_FACTORY;
2873
2880 void setParameterCapabilities( Qgis::RasterProcessingParameterCapabilities capabilities );
2881
2886 Qgis::RasterProcessingParameterCapabilities parameterCapabilities() const;
2887
2888 private:
2889 Qgis::RasterProcessingParameterCapabilities mCapabilities;
2890};
2891
2909class CORE_EXPORT QgsProcessingParameterEnum : public QgsProcessingParameterDefinition
2910{
2911 public:
2912
2916 QgsProcessingParameterEnum( const QString &name, const QString &description = QString(), const QStringList &options = QStringList(),
2917 bool allowMultiple = false,
2918 const QVariant &defaultValue = QVariant(),
2919 bool optional = false,
2920 bool usesStaticStrings = false );
2921
2922 QString userFriendlyString( const QVariant &value ) const override;
2923
2927 static QString typeName() { return QStringLiteral( "enum" ); }
2928 QgsProcessingParameterDefinition *clone() const override SIP_FACTORY;
2929 QString type() const override { return typeName(); }
2930 bool checkValueIsAcceptable( const QVariant &input, QgsProcessingContext *context = nullptr ) const override;
2931 QString valueAsPythonString( const QVariant &value, QgsProcessingContext &context ) const override;
2932 QString valueAsPythonComment( const QVariant &value, QgsProcessingContext &context ) const override;
2933 QString asScriptCode() const override;
2934 QString asPythonString( QgsProcessing::PythonOutputType outputType = QgsProcessing::PythonOutputType::PythonQgsProcessingAlgorithmSubclass ) const override;
2935
2940 QStringList options() const;
2941
2946 void setOptions( const QStringList &options );
2947
2952 bool allowMultiple() const;
2953
2958 void setAllowMultiple( bool allowMultiple );
2959
2966 bool usesStaticStrings() const;
2967
2974 void setUsesStaticStrings( bool usesStaticStrings );
2975
2976 QVariantMap toVariantMap() const override;
2977 bool fromVariantMap( const QVariantMap &map ) override;
2978
2982 static QgsProcessingParameterEnum *fromScriptCode( const QString &name, const QString &description, bool isOptional, const QString &definition ) SIP_FACTORY;
2983
2984 private:
2985
2986 QStringList mOptions;
2987 bool mAllowMultiple = false;
2988 bool mUsesStaticStrings = false;
2989};
2990
3017class CORE_EXPORT QgsProcessingParameterString : public QgsProcessingParameterDefinition
3018{
3019 public:
3020
3024 QgsProcessingParameterString( const QString &name, const QString &description = QString(), const QVariant &defaultValue = QVariant(),
3025 bool multiLine = false,
3026 bool optional = false );
3027
3031 static QString typeName() { return QStringLiteral( "string" ); }
3032 QgsProcessingParameterDefinition *clone() const override SIP_FACTORY;
3033 QString type() const override { return typeName(); }
3034 QString valueAsPythonString( const QVariant &value, QgsProcessingContext &context ) const override;
3035 QString asScriptCode() const override;
3036 QString asPythonString( QgsProcessing::PythonOutputType outputType = QgsProcessing::PythonOutputType::PythonQgsProcessingAlgorithmSubclass ) const override;
3037
3042 bool multiLine() const;
3043
3048 void setMultiLine( bool multiLine );
3049
3050 QVariantMap toVariantMap() const override;
3051 bool fromVariantMap( const QVariantMap &map ) override;
3052
3056 static QgsProcessingParameterString *fromScriptCode( const QString &name, const QString &description, bool isOptional, const QString &definition ) SIP_FACTORY;
3057
3058 private:
3059
3060 bool mMultiLine = false;
3061
3062};
3063
3064
3077class CORE_EXPORT QgsProcessingParameterAuthConfig : public QgsProcessingParameterDefinition
3078{
3079 public:
3080
3084 QgsProcessingParameterAuthConfig( const QString &name, const QString &description = QString(), const QVariant &defaultValue = QVariant(),
3085 bool optional = false );
3086
3090 static QString typeName() { return QStringLiteral( "authcfg" ); }
3091 QgsProcessingParameterDefinition *clone() const override SIP_FACTORY;
3092 QString type() const override { return typeName(); }
3093 QString valueAsPythonString( const QVariant &value, QgsProcessingContext &context ) const override;
3094 QString asScriptCode() const override;
3095
3099 static QgsProcessingParameterAuthConfig *fromScriptCode( const QString &name, const QString &description, bool isOptional, const QString &definition ) SIP_FACTORY;
3100
3101};
3102
3108class CORE_EXPORT QgsProcessingParameterExpression : public QgsProcessingParameterDefinition
3109{
3110 public:
3111
3115 QgsProcessingParameterExpression( const QString &name, const QString &description = QString(), const QVariant &defaultValue = QVariant(),
3116 const QString &parentLayerParameterName = QString(),
3117 bool optional = false, Qgis::ExpressionType type = Qgis::ExpressionType::Qgis );
3118
3122 static QString typeName() { return QStringLiteral( "expression" ); }
3123 QgsProcessingParameterDefinition *clone() const override SIP_FACTORY;
3124 QString type() const override { return typeName(); }
3125 QString valueAsPythonString( const QVariant &value, QgsProcessingContext &context ) const override;
3126 QStringList dependsOnOtherParameters() const override;
3127 QString asPythonString( QgsProcessing::PythonOutputType outputType = QgsProcessing::PythonOutputType::PythonQgsProcessingAlgorithmSubclass ) const override;
3128
3133 QString parentLayerParameterName() const;
3134
3139 void setParentLayerParameterName( const QString &parentLayerParameterName );
3140
3147 Qgis::ExpressionType expressionType() const;
3148
3155 void setExpressionType( Qgis::ExpressionType type );
3156
3157 QVariantMap toVariantMap() const override;
3158 bool fromVariantMap( const QVariantMap &map ) override;
3159
3163 static QgsProcessingParameterExpression *fromScriptCode( const QString &name, const QString &description, bool isOptional, const QString &definition ) SIP_FACTORY;
3164
3165 private:
3166
3167 QString mParentLayerParameterName;
3168 Qgis::ExpressionType mExpressionType = Qgis::ExpressionType::Qgis;
3169};
3170
3171
3177class CORE_EXPORT QgsProcessingParameterLimitedDataTypes
3178{
3179 public:
3180
3184 QgsProcessingParameterLimitedDataTypes( const QList< int > &types = QList< int >() );
3185
3190 QList< int > dataTypes() const;
3191
3196 void setDataTypes( const QList< int > &types );
3197
3198 protected:
3199
3201 QList< int > mDataTypes;
3202};
3203
3211class CORE_EXPORT QgsProcessingParameterVectorLayer : public QgsProcessingParameterDefinition, public QgsProcessingParameterLimitedDataTypes, public QgsFileFilterGenerator
3212{
3213 public:
3214
3218 QgsProcessingParameterVectorLayer( const QString &name,
3219 const QString &description = QString(),
3220 const QList< int > &types = QList< int >(),
3221 const QVariant &defaultValue = QVariant(),
3222 bool optional = false );
3223
3227 static QString typeName() { return QStringLiteral( "vector" ); }
3228 QgsProcessingParameterDefinition *clone() const override SIP_FACTORY;
3229 QString type() const override { return typeName(); }
3230 bool checkValueIsAcceptable( const QVariant &input, QgsProcessingContext *context = nullptr ) const override;
3231 QString valueAsPythonString( const QVariant &value, QgsProcessingContext &context ) const override;
3232 QString valueAsString( const QVariant &value, QgsProcessingContext &context, bool &ok SIP_OUT ) const override;
3233 QVariant valueAsJsonObject( const QVariant &value, QgsProcessingContext &context ) const override;
3234 QString asPythonString( QgsProcessing::PythonOutputType outputType = QgsProcessing::PythonOutputType::PythonQgsProcessingAlgorithmSubclass ) const override;
3235 QString createFileFilter() const override;
3236
3237 QVariantMap toVariantMap() const override;
3238 bool fromVariantMap( const QVariantMap &map ) override;
3239
3243 static QgsProcessingParameterVectorLayer *fromScriptCode( const QString &name, const QString &description, bool isOptional, const QString &definition ) SIP_FACTORY;
3244
3245};
3246
3253class CORE_EXPORT QgsProcessingParameterMeshLayer : public QgsProcessingParameterDefinition, public QgsFileFilterGenerator
3254{
3255 public:
3256
3260 QgsProcessingParameterMeshLayer( const QString &name,
3261 const QString &description = QString(),
3262 const QVariant &defaultValue = QVariant(),
3263 bool optional = false );
3264
3268 static QString typeName() { return QStringLiteral( "mesh" ); }
3269 QgsProcessingParameterDefinition *clone() const override SIP_FACTORY;
3270 QString type() const override { return typeName(); }
3271 bool checkValueIsAcceptable( const QVariant &input, QgsProcessingContext *context = nullptr ) const override;
3272 QString valueAsPythonString( const QVariant &value, QgsProcessingContext &context ) const override;
3273 QString valueAsString( const QVariant &value, QgsProcessingContext &context, bool &ok SIP_OUT ) const override;
3274 QVariant valueAsJsonObject( const QVariant &value, QgsProcessingContext &context ) const override;
3275 QString createFileFilter() const override;
3276
3280 static QgsProcessingParameterMeshLayer *fromScriptCode( const QString &name, const QString &description, bool isOptional, const QString &definition ) SIP_FACTORY;
3281};
3282
3288class CORE_EXPORT QgsProcessingParameterMapLayer : public QgsProcessingParameterDefinition, public QgsProcessingParameterLimitedDataTypes, public QgsFileFilterGenerator
3289{
3290 public:
3291
3295 QgsProcessingParameterMapLayer( const QString &name, const QString &description = QString(), const QVariant &defaultValue = QVariant(),
3296 bool optional = false,
3297 const QList< int > &types = QList< int >() );
3298
3302 static QString typeName() { return QStringLiteral( "layer" ); }
3303 QgsProcessingParameterDefinition *clone() const override SIP_FACTORY;
3304 QString type() const override { return typeName(); }
3305 bool checkValueIsAcceptable( const QVariant &input, QgsProcessingContext *context = nullptr ) const override;
3306 QString valueAsPythonString( const QVariant &value, QgsProcessingContext &context ) const override;
3307 QString valueAsString( const QVariant &value, QgsProcessingContext &context, bool &ok SIP_OUT ) const override;
3308 QVariant valueAsJsonObject( const QVariant &value, QgsProcessingContext &context ) const override;
3309 QString asScriptCode() const override;
3310 QString asPythonString( QgsProcessing::PythonOutputType outputType = QgsProcessing::PythonOutputType::PythonQgsProcessingAlgorithmSubclass ) const override;
3311 QString createFileFilter() const override;
3312
3313 QVariantMap toVariantMap() const override;
3314 bool fromVariantMap( const QVariantMap &map ) override;
3315
3319 static QgsProcessingParameterMapLayer *fromScriptCode( const QString &name, const QString &description, bool isOptional, const QString &definition ) SIP_FACTORY;
3320
3321};
3322
3328class CORE_EXPORT QgsProcessingParameterField : public QgsProcessingParameterDefinition
3329{
3330 public:
3331
3335 QgsProcessingParameterField( const QString &name, const QString &description = QString(), const QVariant &defaultValue = QVariant(),
3336 const QString &parentLayerParameterName = QString(),
3337 Qgis::ProcessingFieldParameterDataType type = Qgis::ProcessingFieldParameterDataType::Any,
3338 bool allowMultiple = false,
3339 bool optional = false,
3340 bool defaultToAllFields = false );
3341
3345 static QString typeName() { return QStringLiteral( "field" ); }
3346 QgsProcessingParameterDefinition *clone() const override SIP_FACTORY;
3347 QString type() const override { return typeName(); }
3348 bool checkValueIsAcceptable( const QVariant &input, QgsProcessingContext *context = nullptr ) const override;
3349 QString valueAsPythonString( const QVariant &value, QgsProcessingContext &context ) const override;
3350 QString asScriptCode() const override;
3351 QString asPythonString( QgsProcessing::PythonOutputType outputType = QgsProcessing::PythonOutputType::PythonQgsProcessingAlgorithmSubclass ) const override;
3352 QStringList dependsOnOtherParameters() const override;
3353
3358 QString parentLayerParameterName() const;
3359
3364 void setParentLayerParameterName( const QString &parentLayerParameterName );
3365
3370 Qgis::ProcessingFieldParameterDataType dataType() const;
3371
3376 void setDataType( Qgis::ProcessingFieldParameterDataType type );
3377
3382 bool allowMultiple() const;
3383
3388 void setAllowMultiple( bool allowMultiple );
3389
3399 bool defaultToAllFields() const;
3400
3410 void setDefaultToAllFields( bool enabled );
3411
3412 QVariantMap toVariantMap() const override;
3413 bool fromVariantMap( const QVariantMap &map ) override;
3414
3418 static QgsProcessingParameterField *fromScriptCode( const QString &name, const QString &description, bool isOptional, const QString &definition ) SIP_FACTORY;
3419
3420 private:
3421
3422 QString mParentLayerParameterName;
3423 Qgis::ProcessingFieldParameterDataType mDataType = Qgis::ProcessingFieldParameterDataType::Any;
3424 bool mAllowMultiple = false;
3425 bool mDefaultToAllFields = false;
3426
3427};
3428
3429
3435class CORE_EXPORT QgsProcessingParameterFeatureSource : public QgsProcessingParameterDefinition, public QgsProcessingParameterLimitedDataTypes, public QgsFileFilterGenerator
3436{
3437 public:
3438
3442 QgsProcessingParameterFeatureSource( const QString &name, const QString &description = QString(),
3443 const QList< int > &types = QList< int >(),
3444 const QVariant &defaultValue = QVariant(), bool optional = false );
3445
3449 static QString typeName() { return QStringLiteral( "source" ); }
3450 QgsProcessingParameterDefinition *clone() const override SIP_FACTORY;
3451 QString type() const override { return typeName(); }
3452 bool checkValueIsAcceptable( const QVariant &input, QgsProcessingContext *context = nullptr ) const override;
3453 QString valueAsPythonString( const QVariant &value, QgsProcessingContext &context ) const override;
3454 QString valueAsString( const QVariant &value, QgsProcessingContext &context, bool &ok SIP_OUT ) const override;
3455 QVariant valueAsJsonObject( const QVariant &value, QgsProcessingContext &context ) const override;
3456 QString asScriptCode() const override;
3457 QString asPythonString( QgsProcessing::PythonOutputType outputType = QgsProcessing::PythonOutputType::PythonQgsProcessingAlgorithmSubclass ) const override;
3458 QString createFileFilter() const override;
3459
3460 QVariantMap toVariantMap() const override;
3461 bool fromVariantMap( const QVariantMap &map ) override;
3462
3466 static QgsProcessingParameterFeatureSource *fromScriptCode( const QString &name, const QString &description, bool isOptional, const QString &definition ) SIP_FACTORY;
3467
3468};
3469
3476class CORE_EXPORT QgsProcessingDestinationParameter : public QgsProcessingParameterDefinition, public QgsFileFilterGenerator
3477{
3478 public:
3479
3486 QgsProcessingDestinationParameter( const QString &name, const QString &description = QString(), const QVariant &defaultValue = QVariant(),
3487 bool optional = false, bool createByDefault = true );
3488
3489 bool isDestination() const override { return true; }
3490 QVariantMap toVariantMap() const override;
3491 bool fromVariantMap( const QVariantMap &map ) override;
3492 QString asPythonString( QgsProcessing::PythonOutputType outputType = QgsProcessing::PythonOutputType::PythonQgsProcessingAlgorithmSubclass ) const override;
3493 QString createFileFilter() const override;
3494
3499 virtual QgsProcessingOutputDefinition *toOutputDefinition() const = 0 SIP_FACTORY;
3500
3506 bool supportsNonFileBasedOutput() const { return mSupportsNonFileBasedOutputs; }
3507
3513 void setSupportsNonFileBasedOutput( bool supportsNonFileBasedOutput ) { mSupportsNonFileBasedOutputs = supportsNonFileBasedOutput; }
3514
3519 virtual QString defaultFileExtension() const = 0;
3520
3526 virtual QString generateTemporaryDestination( const QgsProcessingContext *context = nullptr ) const;
3527
3542 virtual bool isSupportedOutputValue( const QVariant &value, QgsProcessingContext &context, QString &error SIP_OUT ) const;
3543
3549 bool createByDefault() const;
3550
3556 void setCreateByDefault( bool createByDefault );
3557
3558 protected:
3559
3568 QgsProcessingProvider *originalProvider() const { return mOriginalProvider; }
3569
3570 private:
3571
3579 QgsProcessingProvider *mOriginalProvider = nullptr;
3580
3581 bool mSupportsNonFileBasedOutputs = true;
3582 bool mCreateByDefault = true;
3583
3584 friend class QgsProcessingModelAlgorithm;
3585 friend class TestQgsProcessing;
3586 friend class TestQgsProcessingModelAlgorithm;
3587};
3588
3589
3597class CORE_EXPORT QgsProcessingParameterFeatureSink : public QgsProcessingDestinationParameter
3598{
3599 public:
3600
3607 QgsProcessingParameterFeatureSink( const QString &name, const QString &description = QString(), Qgis::ProcessingSourceType type = Qgis::ProcessingSourceType::VectorAnyGeometry, const QVariant &defaultValue = QVariant(),
3608 bool optional = false, bool createByDefault = true, bool supportsAppend = false );
3609
3613 static QString typeName() { return QStringLiteral( "sink" ); }
3614 QgsProcessingParameterDefinition *clone() const override SIP_FACTORY;
3615 QString type() const override { return typeName(); }
3616 bool checkValueIsAcceptable( const QVariant &input, QgsProcessingContext *context = nullptr ) const override;
3617 QString valueAsPythonString( const QVariant &value, QgsProcessingContext &context ) const override;
3618 QString asScriptCode() const override;
3619 QgsProcessingOutputDefinition *toOutputDefinition() const override SIP_FACTORY;
3620 QString defaultFileExtension() const override;
3621 QString asPythonString( QgsProcessing::PythonOutputType outputType = QgsProcessing::PythonOutputType::PythonQgsProcessingAlgorithmSubclass ) const override;
3622 QString createFileFilter() const override;
3623
3629 virtual QStringList supportedOutputVectorLayerExtensions() const;
3630
3635 Qgis::ProcessingSourceType dataType() const;
3636
3641 bool hasGeometry() const;
3642
3647 void setDataType( Qgis::ProcessingSourceType type );
3648
3657 bool supportsAppend() const;
3658
3667 void setSupportsAppend( bool supportsAppend );
3668
3669 QVariantMap toVariantMap() const override;
3670 bool fromVariantMap( const QVariantMap &map ) override;
3671 QString generateTemporaryDestination( const QgsProcessingContext *context = nullptr ) const override;
3672
3676 static QgsProcessingParameterFeatureSink *fromScriptCode( const QString &name, const QString &description, bool isOptional, const QString &definition ) SIP_FACTORY;
3677
3678 private:
3679
3680 Qgis::ProcessingSourceType mDataType = Qgis::ProcessingSourceType::VectorAnyGeometry;
3681 bool mSupportsAppend = false;
3682};
3683
3684
3694class CORE_EXPORT QgsProcessingParameterVectorDestination : public QgsProcessingDestinationParameter
3695{
3696 public:
3697
3704 QgsProcessingParameterVectorDestination( const QString &name, const QString &description = QString(), Qgis::ProcessingSourceType type = Qgis::ProcessingSourceType::VectorAnyGeometry, const QVariant &defaultValue = QVariant(),
3705 bool optional = false, bool createByDefault = true );
3706
3710 static QString typeName() { return QStringLiteral( "vectorDestination" ); }
3711 QgsProcessingParameterDefinition *clone() const override SIP_FACTORY;
3712 QString type() const override { return typeName(); }
3713 bool checkValueIsAcceptable( const QVariant &input, QgsProcessingContext *context = nullptr ) const override;
3714 QString valueAsPythonString( const QVariant &value, QgsProcessingContext &context ) const override;
3715 QString asScriptCode() const override;
3716 QgsProcessingOutputDefinition *toOutputDefinition() const override SIP_FACTORY;
3717 QString defaultFileExtension() const override;
3718 QString asPythonString( QgsProcessing::PythonOutputType outputType = QgsProcessing::PythonOutputType::PythonQgsProcessingAlgorithmSubclass ) const override;
3719 QString createFileFilter() const override;
3720
3726 virtual QStringList supportedOutputVectorLayerExtensions() const;
3727
3732 Qgis::ProcessingSourceType dataType() const;
3733
3738 bool hasGeometry() const;
3739
3744 void setDataType( Qgis::ProcessingSourceType type );
3745
3746 QVariantMap toVariantMap() const override;
3747 bool fromVariantMap( const QVariantMap &map ) override;
3748
3752 static QgsProcessingParameterVectorDestination *fromScriptCode( const QString &name, const QString &description, bool isOptional, const QString &definition ) SIP_FACTORY;
3753
3754
3755 private:
3756
3757 Qgis::ProcessingSourceType mDataType = Qgis::ProcessingSourceType::VectorAnyGeometry;
3758};
3759
3766class CORE_EXPORT QgsProcessingParameterRasterDestination : public QgsProcessingDestinationParameter
3767{
3768 public:
3769
3776 QgsProcessingParameterRasterDestination( const QString &name, const QString &description = QString(),
3777 const QVariant &defaultValue = QVariant(),
3778 bool optional = false,
3779 bool createByDefault = true );
3780
3784 static QString typeName() { return QStringLiteral( "rasterDestination" ); }
3785 QgsProcessingParameterDefinition *clone() const override SIP_FACTORY;
3786 QString type() const override { return typeName(); }
3787 bool checkValueIsAcceptable( const QVariant &input, QgsProcessingContext *context = nullptr ) const override;
3788 QString valueAsPythonString( const QVariant &value, QgsProcessingContext &context ) const override;
3789 QgsProcessingOutputDefinition *toOutputDefinition() const override SIP_FACTORY;
3790 QString defaultFileExtension() const override;
3791 QString createFileFilter() const override;
3792
3798 virtual QStringList supportedOutputRasterLayerExtensions() const;
3799
3803 static QgsProcessingParameterRasterDestination *fromScriptCode( const QString &name, const QString &description, bool isOptional, const QString &definition ) SIP_FACTORY;
3804};
3805
3826class CORE_EXPORT QgsProcessingParameterFileDestination : public QgsProcessingDestinationParameter
3827{
3828 public:
3829
3836 QgsProcessingParameterFileDestination( const QString &name, const QString &description = QString(),
3837 const QString &fileFilter = QString(),
3838 const QVariant &defaultValue = QVariant(),
3839 bool optional = false,
3840 bool createByDefault = true );
3841
3845 static QString typeName() { return QStringLiteral( "fileDestination" ); }
3846 QgsProcessingParameterDefinition *clone() const override SIP_FACTORY;
3847 QString type() const override { return typeName(); }
3848 bool checkValueIsAcceptable( const QVariant &input, QgsProcessingContext *context = nullptr ) const override;
3849 QString valueAsPythonString( const QVariant &value, QgsProcessingContext &context ) const override;
3850 QgsProcessingOutputDefinition *toOutputDefinition() const override SIP_FACTORY;
3851 QString defaultFileExtension() const override;
3852 QString asPythonString( QgsProcessing::PythonOutputType outputType = QgsProcessing::PythonOutputType::PythonQgsProcessingAlgorithmSubclass ) const override;
3853 QString createFileFilter() const override;
3854
3859 QString fileFilter() const;
3860
3865 void setFileFilter( const QString &filter );
3866
3867 QVariantMap toVariantMap() const override;
3868 bool fromVariantMap( const QVariantMap &map ) override;
3869
3873 static QgsProcessingParameterFileDestination *fromScriptCode( const QString &name, const QString &description, bool isOptional, const QString &definition ) SIP_FACTORY;
3874
3875
3876 private:
3877
3878 QString mFileFilter;
3879};
3880
3887class CORE_EXPORT QgsProcessingParameterFolderDestination : public QgsProcessingDestinationParameter
3888{
3889 public:
3890
3894 QgsProcessingParameterFolderDestination( const QString &name, const QString &description = QString(),
3895 const QVariant &defaultValue = QVariant(),
3896 bool optional = false,
3897 bool createByDefault = true );
3898
3902 static QString typeName() { return QStringLiteral( "folderDestination" ); }
3903 QgsProcessingParameterDefinition *clone() const override SIP_FACTORY;
3904 QString type() const override { return typeName(); }
3905 bool checkValueIsAcceptable( const QVariant &input, QgsProcessingContext *context = nullptr ) const override;
3906 QgsProcessingOutputDefinition *toOutputDefinition() const override SIP_FACTORY;
3907 QString defaultFileExtension() const override;
3908
3912 static QgsProcessingParameterFolderDestination *fromScriptCode( const QString &name, const QString &description, bool isOptional, const QString &definition ) SIP_FACTORY;
3913
3914};
3915
3921class CORE_EXPORT QgsProcessingParameterBand : public QgsProcessingParameterDefinition
3922{
3923 public:
3924
3928 QgsProcessingParameterBand( const QString &name, const QString &description = QString(), const QVariant &defaultValue = QVariant(),
3929 const QString &parentLayerParameterName = QString(),
3930 bool optional = false,
3931 bool allowMultiple = false );
3932
3936 static QString typeName() { return QStringLiteral( "band" ); }
3937 QgsProcessingParameterDefinition *clone() const override SIP_FACTORY;
3938 QString type() const override { return typeName(); }
3939 bool checkValueIsAcceptable( const QVariant &input, QgsProcessingContext *context = nullptr ) const override;
3940 QString valueAsPythonString( const QVariant &value, QgsProcessingContext &context ) const override;
3941 QString asScriptCode() const override;
3942 QStringList dependsOnOtherParameters() const override;
3943 QString asPythonString( QgsProcessing::PythonOutputType outputType = QgsProcessing::PythonOutputType::PythonQgsProcessingAlgorithmSubclass ) const override;
3944
3949 QString parentLayerParameterName() const;
3950
3955 void setParentLayerParameterName( const QString &parentLayerParameterName );
3956
3957 QVariantMap toVariantMap() const override;
3958 bool fromVariantMap( const QVariantMap &map ) override;
3959
3963 static QgsProcessingParameterBand *fromScriptCode( const QString &name, const QString &description, bool isOptional, const QString &definition ) SIP_FACTORY;
3964
3970 bool allowMultiple() const;
3971
3977 void setAllowMultiple( bool allowMultiple );
3978
3979 private:
3980
3981 QString mParentLayerParameterName;
3982 bool mAllowMultiple = false;
3983};
3984
3996class CORE_EXPORT QgsProcessingParameterLayout : public QgsProcessingParameterDefinition
3997{
3998 public:
3999
4003 QgsProcessingParameterLayout( const QString &name, const QString &description = QString(), const QVariant &defaultValue = QVariant(),
4004 bool optional = false );
4005
4009 static QString typeName() { return QStringLiteral( "layout" ); }
4010 QgsProcessingParameterDefinition *clone() const override SIP_FACTORY;
4011 QString type() const override { return typeName(); }
4012 QString valueAsPythonString( const QVariant &value, QgsProcessingContext &context ) const override;
4013 QString asScriptCode() const override;
4014 QString asPythonString( QgsProcessing::PythonOutputType outputType = QgsProcessing::PythonOutputType::PythonQgsProcessingAlgorithmSubclass ) const override;
4015
4019 static QgsProcessingParameterLayout *fromScriptCode( const QString &name, const QString &description, bool isOptional, const QString &definition ) SIP_FACTORY;
4020
4021};
4022
4034class CORE_EXPORT QgsProcessingParameterLayoutItem : public QgsProcessingParameterDefinition
4035{
4036 public:
4037
4041 QgsProcessingParameterLayoutItem( const QString &name, const QString &description = QString(), const QVariant &defaultValue = QVariant(),
4042 const QString &parentLayoutParameterName = QString(),
4043 int itemType = -1,
4044 bool optional = false );
4045
4049 static QString typeName() { return QStringLiteral( "layoutitem" ); }
4050 QgsProcessingParameterDefinition *clone() const override SIP_FACTORY;
4051 QString type() const override { return typeName(); }
4052 QString valueAsPythonString( const QVariant &value, QgsProcessingContext &context ) const override;
4053 QString asScriptCode() const override;
4054 QString asPythonString( QgsProcessing::PythonOutputType outputType = QgsProcessing::PythonOutputType::PythonQgsProcessingAlgorithmSubclass ) const override;
4055 QVariantMap toVariantMap() const override;
4056 bool fromVariantMap( const QVariantMap &map ) override;
4057 QStringList dependsOnOtherParameters() const override;
4058
4062 static QgsProcessingParameterLayoutItem *fromScriptCode( const QString &name, const QString &description, bool isOptional, const QString &definition ) SIP_FACTORY;
4063
4068 QString parentLayoutParameterName() const;
4069
4074 void setParentLayoutParameterName( const QString &name );
4075
4083 int itemType() const;
4084
4092 void setItemType( int type );
4093
4094 private:
4095 QString mParentLayoutParameterName;
4096 int mItemType = -1;
4097};
4098
4108class CORE_EXPORT QgsProcessingParameterColor : public QgsProcessingParameterDefinition
4109{
4110 public:
4111
4117 QgsProcessingParameterColor( const QString &name, const QString &description = QString(), const QVariant &defaultValue = QVariant(),
4118 bool opacityEnabled = true,
4119 bool optional = false );
4120
4124 static QString typeName() { return QStringLiteral( "color" ); }
4125
4126 QgsProcessingParameterDefinition *clone() const override SIP_FACTORY;
4127 QString type() const override { return typeName(); }
4128 QString valueAsPythonString( const QVariant &value, QgsProcessingContext &context ) const override;
4129 QString asScriptCode() const override;
4130 QString asPythonString( QgsProcessing::PythonOutputType outputType = QgsProcessing::PythonOutputType::PythonQgsProcessingAlgorithmSubclass ) const override;
4131 bool checkValueIsAcceptable( const QVariant &input, QgsProcessingContext *context = nullptr ) const override;
4132 QVariantMap toVariantMap() const override;
4133 bool fromVariantMap( const QVariantMap &map ) override;
4134
4141 bool opacityEnabled() const;
4142
4150 void setOpacityEnabled( bool enabled );
4151
4155 static QgsProcessingParameterColor *fromScriptCode( const QString &name, const QString &description, bool isOptional, const QString &definition ) SIP_FACTORY;
4156
4157 private:
4158
4159 bool mAllowOpacity = true;
4160
4161};
4162
4163
4175class CORE_EXPORT QgsProcessingParameterCoordinateOperation : public QgsProcessingParameterDefinition
4176{
4177 public:
4178
4182 QgsProcessingParameterCoordinateOperation( const QString &name, const QString &description = QString(), const QVariant &defaultValue = QVariant(),
4183 const QString &sourceCrsParameterName = QString(), const QString &destinationCrsParameterName = QString(),
4184 const QVariant &staticSourceCrs = QVariant(), const QVariant &staticDestinationCrs = QVariant(),
4185 bool optional = false );
4186
4190 static QString typeName() { return QStringLiteral( "coordinateoperation" ); }
4191 QgsProcessingParameterDefinition *clone() const override SIP_FACTORY;
4192 QString type() const override { return typeName(); }
4193 QString valueAsPythonString( const QVariant &value, QgsProcessingContext &context ) const override;
4194 QString asScriptCode() const override;
4195 QString asPythonString( QgsProcessing::PythonOutputType outputType = QgsProcessing::PythonOutputType::PythonQgsProcessingAlgorithmSubclass ) const override;
4196 QStringList dependsOnOtherParameters() const override;
4197
4198 QVariantMap toVariantMap() const override;
4199 bool fromVariantMap( const QVariantMap &map ) override;
4200
4204 static QgsProcessingParameterCoordinateOperation *fromScriptCode( const QString &name, const QString &description, bool isOptional, const QString &definition ) SIP_FACTORY;
4205
4211 QString sourceCrsParameterName() const { return mSourceParameterName; }
4212
4218 void setSourceCrsParameterName( const QString &name ) { mSourceParameterName = name; }
4219
4225 QString destinationCrsParameterName() const { return mDestParameterName; }
4226
4232 void setDestinationCrsParameterName( const QString &name ) { mDestParameterName = name; }
4233
4239 QVariant sourceCrs() const { return mSourceCrs; }
4240
4246 void setSourceCrs( const QVariant &crs ) { mSourceCrs = crs; }
4247
4253 QVariant destinationCrs() const { return mDestCrs; }
4254
4260 void setDestinationCrs( const QVariant &crs ) { mDestCrs = crs; }
4261
4262 private:
4263 QString valueAsPythonStringPrivate( const QVariant &value, QgsProcessingContext &context, bool allowNonStringValues ) const ;
4264
4265 QString mSourceParameterName;
4266 QString mDestParameterName;
4267 QVariant mSourceCrs;
4268 QVariant mDestCrs;
4269
4270};
4271
4272
4282class CORE_EXPORT QgsProcessingParameterMapTheme : public QgsProcessingParameterDefinition
4283{
4284 public:
4285
4289 QgsProcessingParameterMapTheme( const QString &name, const QString &description = QString(), const QVariant &defaultValue = QVariant(),
4290 bool optional = false );
4291
4295 static QString typeName() { return QStringLiteral( "maptheme" ); }
4296 QgsProcessingParameterDefinition *clone() const override SIP_FACTORY;
4297 QString type() const override { return typeName(); }
4298 bool checkValueIsAcceptable( const QVariant &input, QgsProcessingContext *context = nullptr ) const override;
4299 QString valueAsPythonString( const QVariant &value, QgsProcessingContext &context ) const override;
4300 QString asScriptCode() const override;
4301 QString asPythonString( QgsProcessing::PythonOutputType outputType = QgsProcessing::PythonOutputType::PythonQgsProcessingAlgorithmSubclass ) const override;
4302 QVariantMap toVariantMap() const override;
4303 bool fromVariantMap( const QVariantMap &map ) override;
4304
4308 static QgsProcessingParameterMapTheme *fromScriptCode( const QString &name, const QString &description, bool isOptional, const QString &definition ) SIP_FACTORY;
4309
4310 private:
4311
4312};
4313
4314
4325class CORE_EXPORT QgsProcessingParameterDateTime : public QgsProcessingParameterDefinition
4326{
4327 public:
4328
4332 explicit QgsProcessingParameterDateTime( const QString &name, const QString &description = QString(),
4333 Qgis::ProcessingDateTimeParameterDataType type = Qgis::ProcessingDateTimeParameterDataType::DateTime,
4334 const QVariant &defaultValue = QVariant(),
4335 bool optional = false,
4336 const QDateTime &minValue = QDateTime(),
4337 const QDateTime &maxValue = QDateTime()
4338 );
4339
4343 static QString typeName() { return QStringLiteral( "datetime" ); }
4344 QgsProcessingParameterDefinition *clone() const override SIP_FACTORY;
4345 QString type() const override { return typeName(); }
4346 bool checkValueIsAcceptable( const QVariant &input, QgsProcessingContext *context = nullptr ) const override;
4347 QString valueAsPythonString( const QVariant &value, QgsProcessingContext &context ) const override;
4348 QString toolTip() const override;
4349 QString asPythonString( QgsProcessing::PythonOutputType outputType = QgsProcessing::PythonOutputType::PythonQgsProcessingAlgorithmSubclass ) const override;
4350
4358 QDateTime minimum() const;
4359
4371 void setMinimum( const QDateTime &minimum );
4372
4380 QDateTime maximum() const;
4381
4393 void setMaximum( const QDateTime &maximum );
4394
4399 Qgis::ProcessingDateTimeParameterDataType dataType() const;
4400
4405 void setDataType( Qgis::ProcessingDateTimeParameterDataType type );
4406
4407 QVariantMap toVariantMap() const override;
4408 bool fromVariantMap( const QVariantMap &map ) override;
4409 QString userFriendlyString( const QVariant &value ) const override;
4410
4414 static QgsProcessingParameterDateTime *fromScriptCode( const QString &name, const QString &description, bool isOptional, const QString &definition ) SIP_FACTORY;
4415
4416 private:
4417
4418 QDateTime mMin;
4419 QDateTime mMax;
4420 Qgis::ProcessingDateTimeParameterDataType mDataType = Qgis::ProcessingDateTimeParameterDataType::DateTime;
4421};
4422
4423
4434class CORE_EXPORT QgsProcessingParameterProviderConnection : public QgsProcessingParameterDefinition
4435{
4436 public:
4437
4444 QgsProcessingParameterProviderConnection( const QString &name, const QString &description, const QString &provider, const QVariant &defaultValue = QVariant(),
4445 bool optional = false );
4446
4450 static QString typeName() { return QStringLiteral( "providerconnection" ); }
4451 QgsProcessingParameterDefinition *clone() const override SIP_FACTORY;
4452 QString type() const override { return typeName(); }
4453 bool checkValueIsAcceptable( const QVariant &input, QgsProcessingContext *context = nullptr ) const override;
4454 QString valueAsPythonString( const QVariant &value, QgsProcessingContext &context ) const override;
4455 QString asScriptCode() const override;
4456 QString asPythonString( QgsProcessing::PythonOutputType outputType = QgsProcessing::PythonOutputType::PythonQgsProcessingAlgorithmSubclass ) const override;
4457 QVariantMap toVariantMap() const override;
4458 bool fromVariantMap( const QVariantMap &map ) override;
4459
4464 QString providerId() const { return mProviderId; }
4465
4470 void setProviderId( const QString &provider ) { mProviderId = provider; }
4471
4475 static QgsProcessingParameterProviderConnection *fromScriptCode( const QString &name, const QString &description, bool isOptional, const QString &definition ) SIP_FACTORY;
4476
4477 private:
4478
4479 QString mProviderId;
4480};
4481
4482
4493class CORE_EXPORT QgsProcessingParameterDatabaseSchema : public QgsProcessingParameterDefinition
4494{
4495 public:
4496
4505 QgsProcessingParameterDatabaseSchema( const QString &name, const QString &description, const QString &connectionParameterName = QString(), const QVariant &defaultValue = QVariant(),
4506 bool optional = false );
4507
4511 static QString typeName() { return QStringLiteral( "databaseschema" ); }
4512 QgsProcessingParameterDefinition *clone() const override SIP_FACTORY;
4513 QString type() const override { return typeName(); }
4514 bool checkValueIsAcceptable( const QVariant &input, QgsProcessingContext *context = nullptr ) const override;
4515 QString valueAsPythonString( const QVariant &value, QgsProcessingContext &context ) const override;
4516 QString asScriptCode() const override;
4517 QString asPythonString( QgsProcessing::PythonOutputType outputType = QgsProcessing::PythonOutputType::PythonQgsProcessingAlgorithmSubclass ) const override;
4518 QVariantMap toVariantMap() const override;
4519 bool fromVariantMap( const QVariantMap &map ) override;
4520 QStringList dependsOnOtherParameters() const override;
4521
4526 QString parentConnectionParameterName() const;
4527
4532 void setParentConnectionParameterName( const QString &name );
4533
4537 static QgsProcessingParameterDatabaseSchema *fromScriptCode( const QString &name, const QString &description, bool isOptional, const QString &definition ) SIP_FACTORY;
4538
4539 private:
4540
4541 QString mParentConnectionParameterName;
4542};
4543
4544
4557class CORE_EXPORT QgsProcessingParameterDatabaseTable : public QgsProcessingParameterDefinition
4558{
4559 public:
4560
4570 QgsProcessingParameterDatabaseTable( const QString &name, const QString &description,
4571 const QString &connectionParameterName = QString(),
4572 const QString &schemaParameterName = QString(),
4573 const QVariant &defaultValue = QVariant(),
4574 bool optional = false,
4575 bool allowNewTableNames = false );
4576
4580 static QString typeName() { return QStringLiteral( "databasetable" ); }
4581 QgsProcessingParameterDefinition *clone() const override SIP_FACTORY;
4582 QString type() const override { return typeName(); }
4583 bool checkValueIsAcceptable( const QVariant &input, QgsProcessingContext *context = nullptr ) const override;
4584 QString valueAsPythonString( const QVariant &value, QgsProcessingContext &context ) const override;
4585 QString asScriptCode() const override;
4586 QString asPythonString( QgsProcessing::PythonOutputType outputType = QgsProcessing::PythonOutputType::PythonQgsProcessingAlgorithmSubclass ) const override;
4587 QVariantMap toVariantMap() const override;
4588 bool fromVariantMap( const QVariantMap &map ) override;
4589 QStringList dependsOnOtherParameters() const override;
4590
4595 QString parentConnectionParameterName() const;
4596
4601 void setParentConnectionParameterName( const QString &name );
4602
4607 QString parentSchemaParameterName() const;
4608
4613 void setParentSchemaParameterName( const QString &name );
4614
4618 static QgsProcessingParameterDatabaseTable *fromScriptCode( const QString &name, const QString &description, bool isOptional, const QString &definition ) SIP_FACTORY;
4619
4626 bool allowNewTableNames() const;
4627
4634 void setAllowNewTableNames( bool allowed );
4635
4636 private:
4637
4638 QString mParentConnectionParameterName;
4639 QString mParentSchemaParameterName;
4640 bool mAllowNewTableNames = false;
4641};
4642
4643
4650class CORE_EXPORT QgsProcessingParameterPointCloudLayer : public QgsProcessingParameterDefinition, public QgsFileFilterGenerator
4651{
4652 public:
4653
4657 QgsProcessingParameterPointCloudLayer( const QString &name, const QString &description = QString(),
4658 const QVariant &defaultValue = QVariant(), bool optional = false );
4659
4663 static QString typeName() { return QStringLiteral( "pointcloud" ); }
4664 QgsProcessingParameterDefinition *clone() const override SIP_FACTORY;
4665 QString type() const override { return typeName(); }
4666 bool checkValueIsAcceptable( const QVariant &input, QgsProcessingContext *context = nullptr ) const override;
4667 QString valueAsPythonString( const QVariant &value, QgsProcessingContext &context ) const override;
4668 QString valueAsString( const QVariant &value, QgsProcessingContext &context, bool &ok SIP_OUT ) const override;
4669 QVariant valueAsJsonObject( const QVariant &value, QgsProcessingContext &context ) const override;
4670 QString createFileFilter() const override;
4671
4675 static QgsProcessingParameterPointCloudLayer *fromScriptCode( const QString &name, const QString &description, bool isOptional, const QString &definition ) SIP_FACTORY;
4676};
4677
4678
4685class CORE_EXPORT QgsProcessingParameterAnnotationLayer : public QgsProcessingParameterDefinition
4686{
4687 public:
4688
4692 QgsProcessingParameterAnnotationLayer( const QString &name, const QString &description = QString(),
4693 const QVariant &defaultValue = QVariant(), bool optional = false );
4694
4698 static QString typeName() { return QStringLiteral( "annotation" ); }
4699 QgsProcessingParameterDefinition *clone() const override SIP_FACTORY;
4700 QString type() const override { return typeName(); }
4701 bool checkValueIsAcceptable( const QVariant &input, QgsProcessingContext *context = nullptr ) const override;
4702 QString valueAsPythonString( const QVariant &value, QgsProcessingContext &context ) const override;
4703 QString valueAsString( const QVariant &value, QgsProcessingContext &context, bool &ok SIP_OUT ) const override;
4704 QVariant valueAsJsonObject( const QVariant &value, QgsProcessingContext &context ) const override;
4705
4709 static QgsProcessingParameterAnnotationLayer *fromScriptCode( const QString &name, const QString &description, bool isOptional, const QString &definition ) SIP_FACTORY;
4710};
4711
4719class CORE_EXPORT QgsProcessingParameterPointCloudDestination : public QgsProcessingDestinationParameter
4720{
4721 public:
4722
4729 QgsProcessingParameterPointCloudDestination( const QString &name, const QString &description = QString(),
4730 const QVariant &defaultValue = QVariant(),
4731 bool optional = false,
4732 bool createByDefault = true );
4733
4737 static QString typeName() { return QStringLiteral( "pointCloudDestination" ); }
4738 QgsProcessingParameterDefinition *clone() const override SIP_FACTORY;
4739 QString type() const override { return typeName(); }
4740 bool checkValueIsAcceptable( const QVariant &input, QgsProcessingContext *context = nullptr ) const override;
4741 QString valueAsPythonString( const QVariant &value, QgsProcessingContext &context ) const override;
4742 QgsProcessingOutputDefinition *toOutputDefinition() const override SIP_FACTORY;
4743 QString defaultFileExtension() const override;
4744 QString createFileFilter() const override;
4745
4750 virtual QStringList supportedOutputPointCloudLayerExtensions() const;
4751
4755 static QgsProcessingParameterPointCloudDestination *fromScriptCode( const QString &name, const QString &description, bool isOptional, const QString &definition ) SIP_FACTORY;
4756};
4757
4764class CORE_EXPORT QgsProcessingParameterPointCloudAttribute : public QgsProcessingParameterDefinition
4765{
4766 public:
4767
4771 QgsProcessingParameterPointCloudAttribute( const QString &name, const QString &description = QString(), const QVariant &defaultValue = QVariant(),
4772 const QString &parentLayerParameterName = QString(),
4773 bool allowMultiple = false,
4774 bool optional = false,
4775 bool defaultToAllAttributes = false );
4776
4780 static QString typeName() { return QStringLiteral( "attribute" ); }
4781 QgsProcessingParameterDefinition *clone() const override SIP_FACTORY;
4782 QString type() const override { return typeName(); }
4783 bool checkValueIsAcceptable( const QVariant &input, QgsProcessingContext *context = nullptr ) const override;
4784 QString valueAsPythonString( const QVariant &value, QgsProcessingContext &context ) const override;
4785 QString asScriptCode() const override;
4786 QString asPythonString( QgsProcessing::PythonOutputType outputType = QgsProcessing::PythonOutputType::PythonQgsProcessingAlgorithmSubclass ) const override;
4787 QStringList dependsOnOtherParameters() const override;
4788
4793 QString parentLayerParameterName() const;
4794
4799 void setParentLayerParameterName( const QString &parentLayerParameterName );
4800
4805 bool allowMultiple() const;
4806
4811 void setAllowMultiple( bool allowMultiple );
4812
4821 bool defaultToAllAttributes() const;
4822
4831 void setDefaultToAllAttributes( bool enabled );
4832
4833 QVariantMap toVariantMap() const override;
4834 bool fromVariantMap( const QVariantMap &map ) override;
4835
4839 static QgsProcessingParameterPointCloudAttribute *fromScriptCode( const QString &name, const QString &description, bool isOptional, const QString &definition ) SIP_FACTORY;
4840
4841 private:
4842
4843 QString mParentLayerParameterName;
4844 bool mAllowMultiple = false;
4845 bool mDefaultToAllAttributes = false;
4846};
4847
4855class CORE_EXPORT QgsProcessingParameterVectorTileDestination : public QgsProcessingDestinationParameter
4856{
4857 public:
4858
4865 QgsProcessingParameterVectorTileDestination( const QString &name, const QString &description = QString(),
4866 const QVariant &defaultValue = QVariant(),
4867 bool optional = false,
4868 bool createByDefault = true );
4869
4873 static QString typeName() { return QStringLiteral( "vectorTileDestination" ); }
4874 QgsProcessingParameterDefinition *clone() const override SIP_FACTORY;
4875 QString type() const override { return typeName(); }
4876 bool checkValueIsAcceptable( const QVariant &input, QgsProcessingContext *context = nullptr ) const override;
4877 QString valueAsPythonString( const QVariant &value, QgsProcessingContext &context ) const override;
4878 QgsProcessingOutputDefinition *toOutputDefinition() const override SIP_FACTORY;
4879 QString defaultFileExtension() const override;
4880 QString createFileFilter() const override;
4881
4886 virtual QStringList supportedOutputVectorTileLayerExtensions() const;
4887
4891 static QgsProcessingParameterVectorTileDestination *fromScriptCode( const QString &name, const QString &description, bool isOptional, const QString &definition ) SIP_FACTORY;
4892};
4893
4894// clazy:excludeall=qstring-allocations
4895
4896#endif // QGSPROCESSINGPARAMETERS_H
4897
4898
Qgis
Provides global constants and enumerations for use throughout the application.
Definition qgis.h:56
Qgis::ProcessingSourceType
ProcessingSourceType
Processing data source types.
Definition qgis.h:3531
Qgis::ProcessingSourceType::VectorAnyGeometry
@ VectorAnyGeometry
Any vector layer with geometry.
Definition qgis.h:3533
Qgis::ProcessingFileParameterBehavior
ProcessingFileParameterBehavior
Flags which dictate the behavior of QgsProcessingParameterFile.
Definition qgis.h:3788
Qgis::ProcessingFileParameterBehavior::File
@ File
Parameter is a single file.
Definition qgis.h:3789
Qgis::ExpressionType
ExpressionType
Expression types.
Definition qgis.h:5542
Qgis::ExpressionType::Qgis
@ Qgis
Native QGIS expression.
Definition qgis.h:5543
Qgis::DistanceUnit
DistanceUnit
Units of distance.
Definition qgis.h:5013
Qgis::DistanceUnit::Unknown
@ Unknown
Unknown distance unit.
Definition qgis.h:5063
Qgis::RasterProcessingParameterCapabilities
QFlags< RasterProcessingParameterCapability > RasterProcessingParameterCapabilities
Raster layer processing parameter capabilities.
Definition qgis.h:6133
Qgis::ProcessingFieldParameterDataType
ProcessingFieldParameterDataType
Processing field parameter data types.
Definition qgis.h:3816
Qgis::AreaUnit
AreaUnit
Units of area.
Definition qgis.h:5090
Qgis::AreaUnit::Unknown
@ Unknown
Unknown areal unit.
Definition qgis.h:5103
Qgis::TemporalUnit
TemporalUnit
Temporal units.
Definition qgis.h:5159
Qgis::TemporalUnit::Milliseconds
@ Milliseconds
Milliseconds.
Definition qgis.h:5160
Qgis::ProcessingParameterFlags
QFlags< ProcessingParameterFlag > ProcessingParameterFlags
Flags which dictate the behavior of Processing parameters.
Definition qgis.h:3777
Qgis::VolumeUnit
VolumeUnit
Units of volume.
Definition qgis.h:5115
Qgis::VolumeUnit::Unknown
@ Unknown
Unknown volume unit.
Definition qgis.h:5126
Qgis::InvalidGeometryCheck
InvalidGeometryCheck
Methods for handling of features with invalid geometries.
Definition qgis.h:2238
Qgis::InvalidGeometryCheck::AbortOnInvalid
@ AbortOnInvalid
Close iterator on encountering any features with invalid geometry. This requires a slow geometry vali...
Definition qgis.h:2241
Qgis::ProcessingFeatureSourceDefinitionFlags
QFlags< ProcessingFeatureSourceDefinitionFlag > ProcessingFeatureSourceDefinitionFlags
Flags which control behavior for a Processing feature source.
Definition qgis.h:3699
Qgis::WkbType
WkbType
The WKB type describes the number of dimensions a geometry has.
Definition qgis.h:277
Qgis::ProcessingDateTimeParameterDataType
ProcessingDateTimeParameterDataType
Processing date time parameter data types.
Definition qgis.h:3834
Qgis::ProcessingNumberParameterType
ProcessingNumberParameterType
Processing numeric parameter data types.
Definition qgis.h:3802
QgsAnnotationLayer
Represents a map layer containing a set of georeferenced annotations, e.g.
Definition qgsannotationlayer.h:48
QgsCoordinateReferenceSystem
Represents a coordinate reference system (CRS).
Definition qgscoordinatereferencesystem.h:212
QgsFeatureSink
An interface for objects which accept features via addFeature(s) methods.
Definition qgsfeaturesink.h:33
QgsFeatureSink::SinkFlags
QFlags< SinkFlag > SinkFlags
Definition qgsfeaturesink.h:56
QgsFields
Container of fields for a vector layer.
Definition qgsfields.h:46
QgsFileFilterGenerator
Abstract interface for classes which generate a file filter string.
Definition qgsfilefiltergenerator.h:35
QgsGeometry
A geometry is the spatial representation of a feature.
Definition qgsgeometry.h:178
QgsLayoutItem
Base class for graphical items within a QgsLayout.
Definition qgslayoutitem.h:108
QgsMapLayer
Base class for all map layer types.
Definition qgsmaplayer.h:80
QgsMeshLayer
Represents a mesh layer supporting display of data on structured or unstructured meshes.
Definition qgsmeshlayer.h:101
QgsPointCloudLayer
Represents a map layer supporting display of point clouds.
Definition qgspointcloudlayer.h:47
QgsPointXY
Represents a 2D point.
Definition qgspointxy.h:60
QgsPrintLayout
Print layout, a QgsLayout subclass for static or atlas-based layouts.
Definition qgsprintlayout.h:30
QgsProcessingAlgorithm
Abstract base class for processing algorithms.
Definition qgsprocessingalgorithm.h:52
QgsProcessingContext
Contains information about the context in which a processing algorithm is executed.
Definition qgsprocessingcontext.h:45
QgsProcessingDestinationParameter::defaultFileExtension
virtual QString defaultFileExtension() const =0
Returns the default file extension for destination file paths associated with this parameter.
QgsProcessingDestinationParameter::setCreateByDefault
void setCreateByDefault(bool createByDefault)
Sets whether the destination should be created by default.
Definition qgsprocessingparameters.cpp:7463
QgsProcessingDestinationParameter::supportsNonFileBasedOutput
bool supportsNonFileBasedOutput() const
Returns true if the destination parameter supports non filed-based outputs, such as memory layers or ...
Definition qgsprocessingparameters.h:3506
QgsProcessingDestinationParameter::isDestination
bool isDestination() const override
Returns true if this parameter represents a file or layer destination, e.g.
Definition qgsprocessingparameters.h:3489
QgsProcessingDestinationParameter::createByDefault
bool createByDefault() const
Returns true if the destination should be created by default.
Definition qgsprocessingparameters.cpp:7458
QgsProcessingDestinationParameter::isSupportedOutputValue
virtual bool isSupportedOutputValue(const QVariant &value, QgsProcessingContext &context, QString &error) const
Tests whether a value is a supported value for this parameter.
Definition qgsprocessingparameters.cpp:7448
QgsProcessingDestinationParameter::generateTemporaryDestination
virtual QString generateTemporaryDestination(const QgsProcessingContext *context=nullptr) const
Generates a temporary destination value for this parameter.
Definition qgsprocessingparameters.cpp:7430
QgsProcessingDestinationParameter::toOutputDefinition
virtual QgsProcessingOutputDefinition * toOutputDefinition() const =0
Returns a new QgsProcessingOutputDefinition corresponding to the definition of the destination parame...
QgsProcessingDestinationParameter::originalProvider
QgsProcessingProvider * originalProvider() const
Original (source) provider which this parameter has been derived from.
Definition qgsprocessingparameters.h:3568
QgsProcessingDestinationParameter::setSupportsNonFileBasedOutput
void setSupportsNonFileBasedOutput(bool supportsNonFileBasedOutput)
Sets whether the destination parameter supports non filed-based outputs, such as memory layers or dir...
Definition qgsprocessingparameters.h:3513
QgsProcessingDestinationParameter::QgsProcessingDestinationParameter
QgsProcessingDestinationParameter(const QString &name, const QString &description=QString(), const QVariant &defaultValue=QVariant(), bool optional=false, bool createByDefault=true)
Constructor for QgsProcessingDestinationParameter.
Definition qgsprocessingparameters.cpp:7375
QgsProcessingException
Custom exception class for processing related exceptions.
Definition qgsexception.h:81
QgsProcessingFeatureSourceDefinition
Encapsulates settings relating to a feature source input to a processing algorithm.
Definition qgsprocessingparameters.h:59
QgsProcessingFeatureSourceDefinition::loadVariant
bool loadVariant(const QVariantMap &map)
Loads this source definition from a QVariantMap, wrapped in a QVariant.
Definition qgsprocessingparameters.cpp:62
QgsProcessingFeatureSourceDefinition::operator!=
bool operator!=(const QgsProcessingFeatureSourceDefinition &other) const
Definition qgsprocessingparameters.h:182
QgsProcessingFeatureSourceDefinition::selectedFeaturesOnly
bool selectedFeaturesOnly
true if only selected features in the source should be used by algorithms.
Definition qgsprocessingparameters.h:122
QgsProcessingFeatureSourceDefinition::operator==
bool operator==(const QgsProcessingFeatureSourceDefinition &other) const
Definition qgsprocessingparameters.h:172
QgsProcessingFeatureSourceDefinition::geometryCheck
Qgis::InvalidGeometryCheck geometryCheck
Geometry check method to apply to this source.
Definition qgsprocessingparameters.h:153
QgsProcessingFeatureSourceDefinition::QgsProcessingFeatureSourceDefinition
QgsProcessingFeatureSourceDefinition(const QgsProperty &source, bool selectedFeaturesOnly=false, long long featureLimit=-1, Qgis::ProcessingFeatureSourceDefinitionFlags flags=Qgis::ProcessingFeatureSourceDefinitionFlags(), Qgis::InvalidGeometryCheck geometryCheck=Qgis::InvalidGeometryCheck::AbortOnInvalid, const QString &filterExpression=QString())
Constructor for QgsProcessingFeatureSourceDefinition, accepting a QgsProperty source.
Definition qgsprocessingparameters.h:104
QgsProcessingFeatureSourceDefinition::QgsProcessingFeatureSourceDefinition
QgsProcessingFeatureSourceDefinition(const QString &source=QString(), bool selectedFeaturesOnly=false, long long featureLimit=-1, Qgis::ProcessingFeatureSourceDefinitionFlags flags=Qgis::ProcessingFeatureSourceDefinitionFlags(), Qgis::InvalidGeometryCheck geometryCheck=Qgis::InvalidGeometryCheck::AbortOnInvalid, const QString &filterExpression=QString())
Constructor for QgsProcessingFeatureSourceDefinition, accepting a static string source.
Definition qgsprocessingparameters.h:78
QgsProcessingFeatureSourceDefinition::flags
Qgis::ProcessingFeatureSourceDefinitionFlags flags
Flags which dictate source behavior.
Definition qgsprocessingparameters.h:144
QgsProcessingFeatureSourceDefinition::featureLimit
long long featureLimit
If set to a value > 0, places a limit on the maximum number of features which will be read from the s...
Definition qgsprocessingparameters.h:130
QgsProcessingFeatureSourceDefinition::toVariant
QVariant toVariant() const
Saves this source definition to a QVariantMap, wrapped in a QVariant.
Definition qgsprocessingparameters.cpp:50
QgsProcessingFeatureSourceDefinition::filterExpression
QString filterExpression
Optional expression filter to use for filtering features which will be read from the source.
Definition qgsprocessingparameters.h:137
QgsProcessingFeatureSource
QgsFeatureSource subclass which proxies methods to an underlying QgsFeatureSource,...
Definition qgsprocessingutils.h:692
QgsProcessingFeedback
Base class for providing feedback from a processing algorithm.
Definition qgsprocessingfeedback.h:38
QgsProcessingOutputDefinition
Base class for the definition of processing outputs.
Definition qgsprocessingoutputs.h:44
QgsProcessingOutputLayerDefinition
Encapsulates settings relating to a feature sink or output raster layer for a processing algorithm.
Definition qgsprocessingparameters.h:300
QgsProcessingOutputLayerDefinition::destinationProject
QgsProject * destinationProject
Destination project.
Definition qgsprocessingparameters.h:333
QgsProcessingOutputLayerDefinition::QgsProcessingOutputLayerDefinition
QgsProcessingOutputLayerDefinition(const QgsProperty &sink, QgsProject *destinationProject=nullptr)
Constructor for QgsProcessingOutputLayerDefinition, accepting a QgsProperty sink/layer.
Definition qgsprocessingparameters.h:318
QgsProcessingOutputLayerDefinition::sink
QgsProperty sink
Sink/layer definition.
Definition qgsprocessingparameters.h:326
QgsProcessingOutputLayerDefinition::useRemapping
bool useRemapping() const
Returns true if the output uses a remapping definition.
Definition qgsprocessingparameters.h:354
QgsProcessingOutputLayerDefinition::QgsProcessingOutputLayerDefinition
QgsProcessingOutputLayerDefinition(const QString &sink=QString(), QgsProject *destinationProject=nullptr)
Constructor for QgsProcessingOutputLayerDefinition, accepting a static sink/layer string.
Definition qgsprocessingparameters.h:308
QgsProcessingOutputLayerDefinition::remappingDefinition
QgsRemappingSinkDefinition remappingDefinition() const
Returns the output remapping definition, if useRemapping() is true.
Definition qgsprocessingparameters.h:363
QgsProcessingOutputLayerDefinition::destinationName
QString destinationName
Name to use for sink if it's to be loaded into a destination project.
Definition qgsprocessingparameters.h:338
QgsProcessingOutputLayerDefinition::createOptions
QVariantMap createOptions
Map of optional sink/layer creation options, which are passed to the underlying provider when creatin...
Definition qgsprocessingparameters.h:346
QgsProcessingParameterAnnotationLayer
An annotation layer parameter for processing algorithms.
Definition qgsprocessingparameters.h:4686
QgsProcessingParameterAnnotationLayer::QgsProcessingParameterAnnotationLayer
QgsProcessingParameterAnnotationLayer(const QString &name, const QString &description=QString(), const QVariant &defaultValue=QVariant(), bool optional=false)
Constructor for QgsProcessingParameterAnnotationLayer.
Definition qgsprocessingparameters.cpp:9650
QgsProcessingParameterAnnotationLayer::type
QString type() const override
Unique parameter type name.
Definition qgsprocessingparameters.h:4700
QgsProcessingParameterAnnotationLayer::typeName
static QString typeName()
Returns the type name for the parameter class.
Definition qgsprocessingparameters.h:4698
QgsProcessingParameterArea
A double numeric parameter for area values.
Definition qgsprocessingparameters.h:2550
QgsProcessingParameterArea::setDefaultUnit
void setDefaultUnit(Qgis::AreaUnit unit)
Sets the default area unit for the parameter.
Definition qgsprocessingparameters.h:2598
QgsProcessingParameterArea::parentParameterName
QString parentParameterName() const
Returns the name of the parent parameter, or an empty string if this is not set.
Definition qgsprocessingparameters.cpp:8062
QgsProcessingParameterArea::defaultUnit
Qgis::AreaUnit defaultUnit() const
Returns the default area unit for the parameter.
Definition qgsprocessingparameters.h:2591
QgsProcessingParameterArea::QgsProcessingParameterArea
QgsProcessingParameterArea(const QString &name, const QString &description=QString(), const QVariant &defaultValue=QVariant(), const QString &parentParameterName=QString(), bool optional=false, double minValue=0, double maxValue=std::numeric_limits< double >::max())
Constructor for QgsProcessingParameterArea.
Definition qgsprocessingparameters.cpp:8012
QgsProcessingParameterArea::typeName
static QString typeName()
Returns the type name for the parameter class.
Definition qgsprocessingparameters.h:2566
QgsProcessingParameterAuthConfig
A string parameter for authentication configuration ID values.
Definition qgsprocessingparameters.h:3078
QgsProcessingParameterAuthConfig::type
QString type() const override
Unique parameter type name.
Definition qgsprocessingparameters.h:3092
QgsProcessingParameterAuthConfig::QgsProcessingParameterAuthConfig
QgsProcessingParameterAuthConfig(const QString &name, const QString &description=QString(), const QVariant &defaultValue=QVariant(), bool optional=false)
Constructor for QgsProcessingParameterAuthConfig.
Definition qgsprocessingparameters.cpp:5722
QgsProcessingParameterAuthConfig::typeName
static QString typeName()
Returns the type name for the parameter class.
Definition qgsprocessingparameters.h:3090
QgsProcessingParameterBand
A raster band parameter for Processing algorithms.
Definition qgsprocessingparameters.h:3922
QgsProcessingParameterBand::type
QString type() const override
Unique parameter type name.
Definition qgsprocessingparameters.h:3938
QgsProcessingParameterBand::parentLayerParameterName
QString parentLayerParameterName() const
Returns the name of the parent layer parameter, or an empty string if this is not set.
Definition qgsprocessingparameters.cpp:7864
QgsProcessingParameterBand::QgsProcessingParameterBand
QgsProcessingParameterBand(const QString &name, const QString &description=QString(), const QVariant &defaultValue=QVariant(), const QString &parentLayerParameterName=QString(), bool optional=false, bool allowMultiple=false)
Constructor for QgsProcessingParameterBand.
Definition qgsprocessingparameters.cpp:7728
QgsProcessingParameterBand::typeName
static QString typeName()
Returns the type name for the parameter class.
Definition qgsprocessingparameters.h:3936
QgsProcessingParameterBand::allowMultiple
bool allowMultiple() const
Returns whether multiple band selections are permitted.
Definition qgsprocessingparameters.cpp:7776
QgsProcessingParameterBoolean
A boolean parameter for processing algorithms.
Definition qgsprocessingparameters.h:1890
QgsProcessingParameterBoolean::type
QString type() const override
Unique parameter type name.
Definition qgsprocessingparameters.h:1904
QgsProcessingParameterBoolean::typeName
static QString typeName()
Returns the type name for the parameter class.
Definition qgsprocessingparameters.h:1902
QgsProcessingParameterBoolean::QgsProcessingParameterBoolean
QgsProcessingParameterBoolean(const QString &name, const QString &description=QString(), const QVariant &defaultValue=QVariant(), bool optional=false)
Constructor for QgsProcessingParameterBoolean.
Definition qgsprocessingparameters.cpp:3065
QgsProcessingParameterColor
A color parameter for processing algorithms.
Definition qgsprocessingparameters.h:4109
QgsProcessingParameterColor::opacityEnabled
bool opacityEnabled() const
Returns true if the parameter allows opacity control.
Definition qgsprocessingparameters.cpp:8614
QgsProcessingParameterColor::QgsProcessingParameterColor
QgsProcessingParameterColor(const QString &name, const QString &description=QString(), const QVariant &defaultValue=QVariant(), bool opacityEnabled=true, bool optional=false)
Constructor for QgsProcessingParameterColor.
Definition qgsprocessingparameters.cpp:8505
QgsProcessingParameterColor::typeName
static QString typeName()
Returns the type name for the parameter class.
Definition qgsprocessingparameters.h:4124
QgsProcessingParameterColor::type
QString type() const override
Unique parameter type name.
Definition qgsprocessingparameters.h:4127
QgsProcessingParameterCoordinateOperation
A coordinate operation parameter for processing algorithms.
Definition qgsprocessingparameters.h:4176
QgsProcessingParameterCoordinateOperation::typeName
static QString typeName()
Returns the type name for the parameter class.
Definition qgsprocessingparameters.h:4190
QgsProcessingParameterCoordinateOperation::type
QString type() const override
Unique parameter type name.
Definition qgsprocessingparameters.h:4192
QgsProcessingParameterCoordinateOperation::sourceCrs
QVariant sourceCrs() const
Returns the static source CRS, or an invalid value if this is not set.
Definition qgsprocessingparameters.h:4239
QgsProcessingParameterCoordinateOperation::destinationCrsParameterName
QString destinationCrsParameterName() const
Returns the name of the destination CRS parameter, or an empty string if this is not set.
Definition qgsprocessingparameters.h:4225
QgsProcessingParameterCoordinateOperation::setDestinationCrsParameterName
void setDestinationCrsParameterName(const QString &name)
Sets the name of the destination CRS parameter.
Definition qgsprocessingparameters.h:4232
QgsProcessingParameterCoordinateOperation::setSourceCrs
void setSourceCrs(const QVariant &crs)
Sets the static source crs.
Definition qgsprocessingparameters.h:4246
QgsProcessingParameterCoordinateOperation::destinationCrs
QVariant destinationCrs() const
Returns the static destination CRS, or an invalid value if this is not set.
Definition qgsprocessingparameters.h:4253
QgsProcessingParameterCoordinateOperation::QgsProcessingParameterCoordinateOperation
QgsProcessingParameterCoordinateOperation(const QString &name, const QString &description=QString(), const QVariant &defaultValue=QVariant(), const QString &sourceCrsParameterName=QString(), const QString &destinationCrsParameterName=QString(), const QVariant &staticSourceCrs=QVariant(), const QVariant &staticDestinationCrs=QVariant(), bool optional=false)
Constructor for QgsProcessingParameterCoordinateOperation.
Definition qgsprocessingparameters.cpp:8650
QgsProcessingParameterCoordinateOperation::setDestinationCrs
void setDestinationCrs(const QVariant &crs)
Sets the static destination crs.
Definition qgsprocessingparameters.h:4260
QgsProcessingParameterCoordinateOperation::setSourceCrsParameterName
void setSourceCrsParameterName(const QString &name)
Sets the name of the source CRS parameter.
Definition qgsprocessingparameters.h:4218
QgsProcessingParameterCoordinateOperation::sourceCrsParameterName
QString sourceCrsParameterName() const
Returns the name of the source CRS parameter, or an empty string if this is not set.
Definition qgsprocessingparameters.h:4211
QgsProcessingParameterCrs
A coordinate reference system parameter for processing algorithms.
Definition qgsprocessingparameters.h:1920
QgsProcessingParameterCrs::QgsProcessingParameterCrs
QgsProcessingParameterCrs(const QString &name, const QString &description=QString(), const QVariant &defaultValue=QVariant(), bool optional=false)
Constructor for QgsProcessingParameterCrs.
Definition qgsprocessingparameters.cpp:3166
QgsProcessingParameterCrs::userFriendlyString
QString userFriendlyString(const QVariant &value) const override
Returns a user-friendly string representation of the provided parameter value.
Definition qgsprocessingparameters.cpp:3301
QgsProcessingParameterCrs::type
QString type() const override
Unique parameter type name.
Definition qgsprocessingparameters.h:1936
QgsProcessingParameterCrs::typeName
static QString typeName()
Returns the type name for the parameter class.
Definition qgsprocessingparameters.h:1934
QgsProcessingParameterDatabaseSchema
A database schema parameter for processing algorithms, allowing users to select from existing schemas...
Definition qgsprocessingparameters.h:4494
QgsProcessingParameterDatabaseSchema::type
QString type() const override
Unique parameter type name.
Definition qgsprocessingparameters.h:4513
QgsProcessingParameterDatabaseSchema::typeName
static QString typeName()
Returns the type name for the parameter class.
Definition qgsprocessingparameters.h:4511
QgsProcessingParameterDatabaseSchema::QgsProcessingParameterDatabaseSchema
QgsProcessingParameterDatabaseSchema(const QString &name, const QString &description, const QString &connectionParameterName=QString(), const QVariant &defaultValue=QVariant(), bool optional=false)
Constructor for QgsProcessingParameterDatabaseSchema.
Definition qgsprocessingparameters.cpp:9261
QgsProcessingParameterDatabaseTable
A database table name parameter for processing algorithms.
Definition qgsprocessingparameters.h:4558
QgsProcessingParameterDatabaseTable::QgsProcessingParameterDatabaseTable
QgsProcessingParameterDatabaseTable(const QString &name, const QString &description, const QString &connectionParameterName=QString(), const QString &schemaParameterName=QString(), const QVariant &defaultValue=QVariant(), bool optional=false, bool allowNewTableNames=false)
Constructor for QgsProcessingParameterDatabaseTable.
Definition qgsprocessingparameters.cpp:9390
QgsProcessingParameterDatabaseTable::typeName
static QString typeName()
Returns the type name for the parameter class.
Definition qgsprocessingparameters.h:4580
QgsProcessingParameterDatabaseTable::type
QString type() const override
Unique parameter type name.
Definition qgsprocessingparameters.h:4582
QgsProcessingParameterDatabaseTable::allowNewTableNames
bool allowNewTableNames() const
Returns true if the parameter allows users to enter names for a new (non-existing) tables.
Definition qgsprocessingparameters.cpp:9542
QgsProcessingParameterDateTime
A datetime (or pure date or time) parameter for processing algorithms.
Definition qgsprocessingparameters.h:4326
QgsProcessingParameterDateTime::type
QString type() const override
Unique parameter type name.
Definition qgsprocessingparameters.h:4345
QgsProcessingParameterDateTime::typeName
static QString typeName()
Returns the type name for the parameter class.
Definition qgsprocessingparameters.h:4343
QgsProcessingParameterDateTime::QgsProcessingParameterDateTime
QgsProcessingParameterDateTime(const QString &name, const QString &description=QString(), Qgis::ProcessingDateTimeParameterDataType type=Qgis::ProcessingDateTimeParameterDataType::DateTime, const QVariant &defaultValue=QVariant(), bool optional=false, const QDateTime &minValue=QDateTime(), const QDateTime &maxValue=QDateTime())
Constructor for QgsProcessingParameterDateTime.
Definition qgsprocessingparameters.cpp:8896
QgsProcessingParameterDefinition
Base class for the definition of processing parameters.
Definition qgsprocessingparameters.h:431
QgsProcessingParameterDefinition::mAlgorithm
QgsProcessingAlgorithm * mAlgorithm
Pointer to algorithm which owns this parameter.
Definition qgsprocessingparameters.h:1021
QgsProcessingParameterDefinition::defaultValue
QVariant defaultValue() const
Returns the default value for the parameter.
Definition qgsprocessingparameters.h:650
QgsProcessingParameterDefinition::setDefaultValue
void setDefaultValue(const QVariant &value)
Sets the default value for the parameter.
Definition qgsprocessingparameters.h:658
QgsProcessingParameterDefinition::valueAsStringPrivate
QString valueAsStringPrivate(const QVariant &value, QgsProcessingContext &context, bool &ok, ValueAsStringFlags flags) const
Internal method for evaluating values as string.
Definition qgsprocessingparameters.cpp:2775
QgsProcessingParameterDefinition::additionalExpressionContextVariables
QStringList additionalExpressionContextVariables() const
Returns a list of additional expression context variables which are available for use when evaluating...
Definition qgsprocessingparameters.h:933
QgsProcessingParameterDefinition::mAdditionalExpressionVariables
QStringList mAdditionalExpressionVariables
Additional expression context variables exposed for use by this parameter.
Definition qgsprocessingparameters.h:1033
QgsProcessingParameterDefinition::help
QString help() const
Returns the help for the parameter.
Definition qgsprocessingparameters.h:631
QgsProcessingParameterDefinition::mFlags
Qgis::ProcessingParameterFlags mFlags
Parameter flags.
Definition qgsprocessingparameters.h:1015
QgsProcessingParameterDefinition::userFriendlyString
virtual QString userFriendlyString(const QVariant &value) const
Returns a user-friendly string representation of the provided parameter value.
Definition qgsprocessingparameters.cpp:3085
QgsProcessingParameterDefinition::ValueAsStringFlags
QFlags< ValueAsStringFlag > ValueAsStringFlags
Definition qgsprocessingparameters.h:967
QgsProcessingParameterDefinition::setMetadata
void setMetadata(const QVariantMap &metadata)
Sets the parameter's freeform metadata.
Definition qgsprocessingparameters.h:832
QgsProcessingParameterDefinition::setFlags
void setFlags(Qgis::ProcessingParameterFlags flags)
Sets the flags associated with the parameter.
Definition qgsprocessingparameters.h:711
QgsProcessingParameterDefinition::provider
QgsProcessingProvider * provider() const
Returns a pointer to the provider for the algorithm which owns this parameter.
Definition qgsprocessingparameters.cpp:3049
QgsProcessingParameterDefinition::ValueAsStringFlag
ValueAsStringFlag
Flags for passing to the valueAsStringPrivate() method.
Definition qgsprocessingparameters.h:964
QgsProcessingParameterDefinition::setGuiDefaultValueOverride
void setGuiDefaultValueOverride(const QVariant &value)
Sets the default value to use for the parameter in GUI widgets.
Definition qgsprocessingparameters.h:689
QgsProcessingParameterDefinition::mIsDynamic
bool mIsDynamic
True for dynamic parameters, which can have data-defined (QgsProperty) based values.
Definition qgsprocessingparameters.h:1024
QgsProcessingParameterDefinition::metadata
QVariantMap metadata() const
Returns the parameter's freeform metadata.
Definition qgsprocessingparameters.h:818
QgsProcessingParameterDefinition::description
QString description() const
Returns the description for the parameter.
Definition qgsprocessingparameters.h:613
QgsProcessingParameterDefinition::QgsProcessingParameterDefinition
QgsProcessingParameterDefinition(const QString &name, const QString &description=QString(), const QVariant &defaultValue=QVariant(), bool optional=false, const QString &help=QString())
Constructor for QgsProcessingParameterDefinition.
Definition qgsprocessingparameters.cpp:2495
QgsProcessingParameterDefinition::mDynamicLayerParameterName
QString mDynamicLayerParameterName
Linked vector layer parameter name for dynamic properties.
Definition qgsprocessingparameters.h:1030
QgsProcessingParameterDefinition::isDestination
virtual bool isDestination() const
Returns true if this parameter represents a file or layer destination, e.g.
Definition qgsprocessingparameters.h:592
QgsProcessingParameterDefinition::setDescription
void setDescription(const QString &description)
Sets the description for the parameter.
Definition qgsprocessingparameters.h:620
QgsProcessingParameterDefinition::setDynamicLayerParameterName
void setDynamicLayerParameterName(const QString &name)
Sets the name for the parameter for a layer linked to a dynamic parameter, or an empty string if this...
Definition qgsprocessingparameters.h:918
QgsProcessingParameterDefinition::dynamicLayerParameterName
QString dynamicLayerParameterName() const
Returns the name of the parameter for a layer linked to a dynamic parameter, or an empty string if th...
Definition qgsprocessingparameters.h:905
QgsProcessingParameterDefinition::setAdditionalExpressionContextVariables
void setAdditionalExpressionContextVariables(const QStringList &variables)
Sets a list of additional expression context variables which are available for use when evaluating th...
Definition qgsprocessingparameters.h:952
QgsProcessingParameterDefinition::mMetadata
QVariantMap mMetadata
Freeform metadata for parameter. Mostly used by widget wrappers to customize their appearance and beh...
Definition qgsprocessingparameters.h:1018
QgsProcessingParameterDefinition::setName
void setName(const QString &name)
Sets the name of the parameter.
Definition qgsprocessingparameters.h:606
QgsProcessingParameterDefinition::mDescription
QString mDescription
Parameter description.
Definition qgsprocessingparameters.h:1003
QgsProcessingParameterDefinition::clone
virtual QgsProcessingParameterDefinition * clone() const =0
Creates a clone of the parameter definition.
QgsProcessingParameterDefinition::type
virtual QString type() const =0
Unique parameter type name.
QgsProcessingParameterDefinition::setDynamicPropertyDefinition
void setDynamicPropertyDefinition(const QgsPropertyDefinition &definition)
Sets the property definition for dynamic properties.
Definition qgsprocessingparameters.h:892
QgsProcessingParameterDefinition::setHelp
void setHelp(const QString &help)
Sets the help for the parameter.
Definition qgsprocessingparameters.h:642
QgsProcessingParameterDefinition::name
QString name() const
Returns the name of the parameter.
Definition qgsprocessingparameters.h:599
QgsProcessingParameterDefinition::mDefault
QVariant mDefault
Default value for parameter.
Definition qgsprocessingparameters.h:1009
QgsProcessingParameterDefinition::dependsOnOtherParameters
virtual QStringList dependsOnOtherParameters() const
Returns a list of other parameter names on which this parameter is dependent (e.g.
Definition qgsprocessingparameters.h:838
QgsProcessingParameterDefinition::setIsDynamic
void setIsDynamic(bool dynamic)
Sets whether the parameter is dynamic, and can support data-defined values (i.e.
Definition qgsprocessingparameters.h:876
QgsProcessingParameterDefinition::flags
Qgis::ProcessingParameterFlags flags() const
Returns any flags associated with the parameter.
Definition qgsprocessingparameters.h:705
QgsProcessingParameterDefinition::mGuiDefault
QVariant mGuiDefault
Default value for parameter in GUI.
Definition qgsprocessingparameters.h:1012
QgsProcessingParameterDefinition::mPropertyDefinition
QgsPropertyDefinition mPropertyDefinition
Data defined property definition.
Definition qgsprocessingparameters.h:1027
QgsProcessingParameterDefinition::defaultGuiValueFromSetting
QVariant defaultGuiValueFromSetting() const
Default gui value for an algorithm parameter from settings.
Definition qgsprocessingparameters.cpp:2523
QgsProcessingParameterDefinition::isDynamic
bool isDynamic() const
Returns true if the parameter supports is dynamic, and can support data-defined values (i....
Definition qgsprocessingparameters.h:867
QgsProcessingParameterDefinition::~QgsProcessingParameterDefinition
virtual ~QgsProcessingParameterDefinition()=default
QgsProcessingParameterDefinition::metadata
QVariantMap & metadata()
Returns the parameter's freeform metadata.
Definition qgsprocessingparameters.h:825
QgsProcessingParameterDefinition::valueAsJsonObjectPrivate
QVariant valueAsJsonObjectPrivate(const QVariant &value, QgsProcessingContext &context, ValueAsStringFlags flags) const
Internal method for evaluating values as JSON objects.
Definition qgsprocessingparameters.cpp:2565
QgsProcessingParameterDefinition::modelColor
virtual QColor modelColor() const
Returns the color to use for the parameter in model designer windows.
Definition qgsprocessingparameters.cpp:3074
QgsProcessingParameterDefinition::dynamicPropertyDefinition
QgsPropertyDefinition dynamicPropertyDefinition() const
Returns the property definition for dynamic properties.
Definition qgsprocessingparameters.h:884
QgsProcessingParameterDistance
A double numeric parameter for distance values.
Definition qgsprocessingparameters.h:2463
QgsProcessingParameterDistance::typeName
static QString typeName()
Returns the type name for the parameter class.
Definition qgsprocessingparameters.h:2479
QgsProcessingParameterDistance::setDefaultUnit
void setDefaultUnit(Qgis::DistanceUnit unit)
Sets the default distance unit for the parameter.
Definition qgsprocessingparameters.h:2515
QgsProcessingParameterDistance::parentParameterName
QString parentParameterName() const
Returns the name of the parent parameter, or an empty string if this is not set.
Definition qgsprocessingparameters.cpp:7972
QgsProcessingParameterDistance::defaultUnit
Qgis::DistanceUnit defaultUnit() const
Returns the default distance unit for the parameter.
Definition qgsprocessingparameters.h:2507
QgsProcessingParameterDistance::QgsProcessingParameterDistance
QgsProcessingParameterDistance(const QString &name, const QString &description=QString(), const QVariant &defaultValue=QVariant(), const QString &parentParameterName=QString(), bool optional=false, double minValue=std::numeric_limits< double >::lowest()+1, double maxValue=std::numeric_limits< double >::max())
Constructor for QgsProcessingParameterDistance.
Definition qgsprocessingparameters.cpp:7922
QgsProcessingParameterDuration
A double numeric parameter for duration values.
Definition qgsprocessingparameters.h:2705
QgsProcessingParameterDuration::setDefaultUnit
void setDefaultUnit(Qgis::TemporalUnit unit)
Sets the default duration unit for the parameter.
Definition qgsprocessingparameters.h:2739
QgsProcessingParameterDuration::defaultUnit
Qgis::TemporalUnit defaultUnit() const
Returns the default duration unit for the parameter.
Definition qgsprocessingparameters.h:2732
QgsProcessingParameterDuration::typeName
static QString typeName()
Returns the type name for the parameter class.
Definition qgsprocessingparameters.h:2720
QgsProcessingParameterDuration::QgsProcessingParameterDuration
QgsProcessingParameterDuration(const QString &name, const QString &description=QString(), const QVariant &defaultValue=QVariant(), bool optional=false, double minValue=std::numeric_limits< double >::lowest()+1, double maxValue=std::numeric_limits< double >::max())
Constructor for QgsProcessingParameterDuration.
Definition qgsprocessingparameters.cpp:8190
QgsProcessingParameterDxfLayers::typeName
static QString typeName()
Returns the type name for the parameter class.
Definition qgsprocessingparameterdxflayers.h:65
QgsProcessingParameterEnum
An enum based parameter for processing algorithms, allowing for selection from predefined values.
Definition qgsprocessingparameters.h:2910
QgsProcessingParameterEnum::userFriendlyString
QString userFriendlyString(const QVariant &value) const override
Returns a user-friendly string representation of the provided parameter value.
Definition qgsprocessingparameters.cpp:5527
QgsProcessingParameterEnum::allowMultiple
bool allowMultiple() const
Returns true if the parameter allows multiple selected values.
Definition qgsprocessingparameters.cpp:5545
QgsProcessingParameterEnum::options
QStringList options() const
Returns the list of acceptable options for the parameter.
Definition qgsprocessingparameters.cpp:5535
QgsProcessingParameterEnum::QgsProcessingParameterEnum
QgsProcessingParameterEnum(const QString &name, const QString &description=QString(), const QStringList &options=QStringList(), bool allowMultiple=false, const QVariant &defaultValue=QVariant(), bool optional=false, bool usesStaticStrings=false)
Constructor for QgsProcessingParameterEnum.
Definition qgsprocessingparameters.cpp:5232
QgsProcessingParameterEnum::type
QString type() const override
Unique parameter type name.
Definition qgsprocessingparameters.h:2929
QgsProcessingParameterEnum::usesStaticStrings
bool usesStaticStrings() const
Returns true if the parameter uses static (non-translated) string values for its enumeration choice l...
Definition qgsprocessingparameters.cpp:5555
QgsProcessingParameterEnum::typeName
static QString typeName()
Returns the type name for the parameter class.
Definition qgsprocessingparameters.h:2927
QgsProcessingParameterExpression
An expression parameter for processing algorithms.
Definition qgsprocessingparameters.h:3109
QgsProcessingParameterExpression::QgsProcessingParameterExpression
QgsProcessingParameterExpression(const QString &name, const QString &description=QString(), const QVariant &defaultValue=QVariant(), const QString &parentLayerParameterName=QString(), bool optional=false, Qgis::ExpressionType type=Qgis::ExpressionType::Qgis)
Constructor for QgsProcessingParameterExpression.
Definition qgsprocessingparameters.cpp:5774
QgsProcessingParameterExpression::parentLayerParameterName
QString parentLayerParameterName() const
Returns the name of the parent layer parameter, or an empty string if this is not set.
Definition qgsprocessingparameters.cpp:5842
QgsProcessingParameterExpression::type
QString type() const override
Unique parameter type name.
Definition qgsprocessingparameters.h:3124
QgsProcessingParameterExpression::typeName
static QString typeName()
Returns the type name for the parameter class.
Definition qgsprocessingparameters.h:3122
QgsProcessingParameterExtent
A rectangular map extent parameter for processing algorithms.
Definition qgsprocessingparameters.h:1955
QgsProcessingParameterExtent::QgsProcessingParameterExtent
QgsProcessingParameterExtent(const QString &name, const QString &description=QString(), const QVariant &defaultValue=QVariant(), bool optional=false)
Constructor for QgsProcessingParameterExtent.
Definition qgsprocessingparameters.cpp:3631
QgsProcessingParameterExtent::typeName
static QString typeName()
Returns the type name for the parameter class.
Definition qgsprocessingparameters.h:1967
QgsProcessingParameterExtent::type
QString type() const override
Unique parameter type name.
Definition qgsprocessingparameters.h:1969
QgsProcessingParameterFeatureSink
A feature sink output for processing algorithms.
Definition qgsprocessingparameters.h:3598
QgsProcessingParameterFeatureSink::QgsProcessingParameterFeatureSink
QgsProcessingParameterFeatureSink(const QString &name, const QString &description=QString(), Qgis::ProcessingSourceType type=Qgis::ProcessingSourceType::VectorAnyGeometry, const QVariant &defaultValue=QVariant(), bool optional=false, bool createByDefault=true, bool supportsAppend=false)
Constructor for QgsProcessingParameterFeatureSink.
Definition qgsprocessingparameters.cpp:6738
QgsProcessingParameterFeatureSink::type
QString type() const override
Unique parameter type name.
Definition qgsprocessingparameters.h:3615
QgsProcessingParameterFeatureSink::supportsAppend
bool supportsAppend() const
Returns true if the sink supports appending features to an existing table.
Definition qgsprocessingparameters.cpp:7020
QgsProcessingParameterFeatureSink::typeName
static QString typeName()
Returns the type name for the parameter class.
Definition qgsprocessingparameters.h:3613
QgsProcessingParameterFeatureSource
An input feature source (such as vector layers) parameter for processing algorithms.
Definition qgsprocessingparameters.h:3436
QgsProcessingParameterFeatureSource::QgsProcessingParameterFeatureSource
QgsProcessingParameterFeatureSource(const QString &name, const QString &description=QString(), const QList< int > &types=QList< int >(), const QVariant &defaultValue=QVariant(), bool optional=false)
Constructor for QgsProcessingParameterFeatureSource.
Definition qgsprocessingparameters.cpp:6446
QgsProcessingParameterFeatureSource::typeName
static QString typeName()
Returns the type name for the parameter class.
Definition qgsprocessingparameters.h:3449
QgsProcessingParameterFeatureSource::type
QString type() const override
Unique parameter type name.
Definition qgsprocessingparameters.h:3451
QgsProcessingParameterFieldMapping::typeName
static QString typeName()
Returns the type name for the parameter class.
Definition qgsprocessingparameterfieldmap.h:47
QgsProcessingParameterField
A vector layer or feature source field parameter for processing algorithms.
Definition qgsprocessingparameters.h:3329
QgsProcessingParameterField::parentLayerParameterName
QString parentLayerParameterName() const
Returns the name of the parent layer parameter, or an empty string if this is not set.
Definition qgsprocessingparameters.cpp:6324
QgsProcessingParameterField::allowMultiple
bool allowMultiple() const
Returns whether multiple field selections are permitted.
Definition qgsprocessingparameters.cpp:6344
QgsProcessingParameterField::type
QString type() const override
Unique parameter type name.
Definition qgsprocessingparameters.h:3347
QgsProcessingParameterField::defaultToAllFields
bool defaultToAllFields() const
Returns whether a parameter which allows multiple selections (see allowMultiple()) should automatical...
Definition qgsprocessingparameters.cpp:6354
QgsProcessingParameterField::typeName
static QString typeName()
Returns the type name for the parameter class.
Definition qgsprocessingparameters.h:3345
QgsProcessingParameterField::QgsProcessingParameterField
QgsProcessingParameterField(const QString &name, const QString &description=QString(), const QVariant &defaultValue=QVariant(), const QString &parentLayerParameterName=QString(), Qgis::ProcessingFieldParameterDataType type=Qgis::ProcessingFieldParameterDataType::Any, bool allowMultiple=false, bool optional=false, bool defaultToAllFields=false)
Constructor for QgsProcessingParameterField.
Definition qgsprocessingparameters.cpp:6126
QgsProcessingParameterFileDestination
A generic file based destination parameter, for specifying the destination path for a file (non-map l...
Definition qgsprocessingparameters.h:3827
QgsProcessingParameterFileDestination::QgsProcessingParameterFileDestination
QgsProcessingParameterFileDestination(const QString &name, const QString &description=QString(), const QString &fileFilter=QString(), const QVariant &defaultValue=QVariant(), bool optional=false, bool createByDefault=true)
Constructor for QgsProcessingParameterFileDestination.
Definition qgsprocessingparameters.cpp:7157
QgsProcessingParameterFileDestination::type
QString type() const override
Unique parameter type name.
Definition qgsprocessingparameters.h:3847
QgsProcessingParameterFileDestination::typeName
static QString typeName()
Returns the type name for the parameter class.
Definition qgsprocessingparameters.h:3845
QgsProcessingParameterFileDestination::fileFilter
QString fileFilter() const
Returns the file filter string for file destinations compatible with this parameter.
Definition qgsprocessingparameters.cpp:7288
QgsProcessingParameterFile
An input file or folder parameter for processing algorithms.
Definition qgsprocessingparameters.h:2099
QgsProcessingParameterFile::extension
QString extension() const
Returns any specified file extension for the parameter.
Definition qgsprocessingparameters.h:2142
QgsProcessingParameterFile::typeName
static QString typeName()
Returns the type name for the parameter class.
Definition qgsprocessingparameters.h:2115
QgsProcessingParameterFile::QgsProcessingParameterFile
QgsProcessingParameterFile(const QString &name, const QString &description=QString(), Qgis::ProcessingFileParameterBehavior behavior=Qgis::ProcessingFileParameterBehavior::File, const QString &extension=QString(), const QVariant &defaultValue=QVariant(), bool optional=false, const QString &fileFilter=QString())
Constructor for QgsProcessingParameterFile.
Definition qgsprocessingparameters.cpp:4209
QgsProcessingParameterFile::setBehavior
void setBehavior(Qgis::ProcessingFileParameterBehavior behavior)
Sets the parameter behavior (e.g.
Definition qgsprocessingparameters.h:2133
QgsProcessingParameterFile::type
QString type() const override
Unique parameter type name.
Definition qgsprocessingparameters.h:2117
QgsProcessingParameterFile::fileFilter
QString fileFilter() const
Returns the file filter string for file destinations compatible with this parameter.
Definition qgsprocessingparameters.cpp:4328
QgsProcessingParameterFile::behavior
Qgis::ProcessingFileParameterBehavior behavior() const
Returns the parameter behavior (e.g.
Definition qgsprocessingparameters.h:2127
QgsProcessingParameterFolderDestination
A folder destination parameter, for specifying the destination path for a folder created by the algor...
Definition qgsprocessingparameters.h:3888
QgsProcessingParameterFolderDestination::type
QString type() const override
Unique parameter type name.
Definition qgsprocessingparameters.h:3904
QgsProcessingParameterFolderDestination::typeName
static QString typeName()
Returns the type name for the parameter class.
Definition qgsprocessingparameters.h:3902
QgsProcessingParameterFolderDestination::QgsProcessingParameterFolderDestination
QgsProcessingParameterFolderDestination(const QString &name, const QString &description=QString(), const QVariant &defaultValue=QVariant(), bool optional=false, bool createByDefault=true)
Constructor for QgsProcessingParameterFolderDestination.
Definition qgsprocessingparameters.cpp:7318
QgsProcessingParameterGeometry
A geometry parameter for processing algorithms.
Definition qgsprocessingparameters.h:2030
QgsProcessingParameterGeometry::setGeometryTypes
void setGeometryTypes(const QList< int > &geometryTypes)
Sets the allowed geometryTypes, as a list of Qgis::GeometryType values.
Definition qgsprocessingparameters.h:2065
QgsProcessingParameterGeometry::type
QString type() const override
Unique parameter type name.
Definition qgsprocessingparameters.h:2047
QgsProcessingParameterGeometry::allowMultipart
bool allowMultipart() const
Returns the parameter allow multipart geometries.
Definition qgsprocessingparameters.h:2071
QgsProcessingParameterGeometry::QgsProcessingParameterGeometry
QgsProcessingParameterGeometry(const QString &name, const QString &description=QString(), const QVariant &defaultValue=QVariant(), bool optional=false, const QList< int > &geometryTypes=QList< int >(), bool allowMultipart=true)
Constructor for QgsProcessingParameterGeometry.
Definition qgsprocessingparameters.cpp:3899
QgsProcessingParameterGeometry::geometryTypes
QList< int > geometryTypes() const
Returns the parameter allowed geometries, as a list of Qgis::GeometryType values.
Definition qgsprocessingparameters.h:2059
QgsProcessingParameterGeometry::setAllowMultipart
void setAllowMultipart(bool allowMultipart)
Sets the allow multipart geometries.
Definition qgsprocessingparameters.h:2077
QgsProcessingParameterGeometry::typeName
static QString typeName()
Returns the type name for the parameter class.
Definition qgsprocessingparameters.h:2045
QgsProcessingParameterLayoutItem
A print layout item parameter, allowing users to select a particular item from a print layout.
Definition qgsprocessingparameters.h:4035
QgsProcessingParameterLayoutItem::type
QString type() const override
Unique parameter type name.
Definition qgsprocessingparameters.h:4051
QgsProcessingParameterLayoutItem::QgsProcessingParameterLayoutItem
QgsProcessingParameterLayoutItem(const QString &name, const QString &description=QString(), const QVariant &defaultValue=QVariant(), const QString &parentLayoutParameterName=QString(), int itemType=-1, bool optional=false)
Constructor for QgsProcessingParameterLayoutItem.
Definition qgsprocessingparameters.cpp:8371
QgsProcessingParameterLayoutItem::parentLayoutParameterName
QString parentLayoutParameterName() const
Returns the name of the parent layout parameter, or an empty string if this is not set.
Definition qgsprocessingparameters.cpp:8481
QgsProcessingParameterLayoutItem::typeName
static QString typeName()
Returns the type name for the parameter class.
Definition qgsprocessingparameters.h:4049
QgsProcessingParameterLayoutItem::itemType
int itemType() const
Returns the acceptable item type, or -1 if any item type is allowed.
Definition qgsprocessingparameters.cpp:8491
QgsProcessingParameterLayout
A print layout parameter, allowing users to select a print layout.
Definition qgsprocessingparameters.h:3997
QgsProcessingParameterLayout::QgsProcessingParameterLayout
QgsProcessingParameterLayout(const QString &name, const QString &description=QString(), const QVariant &defaultValue=QVariant(), bool optional=false)
Constructor for QgsProcessingParameterLayout.
Definition qgsprocessingparameters.cpp:8300
QgsProcessingParameterLayout::typeName
static QString typeName()
Returns the type name for the parameter class.
Definition qgsprocessingparameters.h:4009
QgsProcessingParameterLayout::type
QString type() const override
Unique parameter type name.
Definition qgsprocessingparameters.h:4011
QgsProcessingParameterLimitedDataTypes::setDataTypes
void setDataTypes(const QList< int > &types)
Sets the geometry types for sources acceptable by the parameter.
Definition qgsprocessingparameters.cpp:6001
QgsProcessingParameterLimitedDataTypes::QgsProcessingParameterLimitedDataTypes
QgsProcessingParameterLimitedDataTypes(const QList< int > &types=QList< int >())
Constructor for QgsProcessingParameterLimitedDataTypes, with a list of acceptable data types.
Definition qgsprocessingparameters.cpp:6678
QgsProcessingParameterLimitedDataTypes::mDataTypes
QList< int > mDataTypes
List of acceptable data types for the parameter.
Definition qgsprocessingparameters.h:3201
QgsProcessingParameterLimitedDataTypes::dataTypes
QList< int > dataTypes() const
Returns the geometry types for sources acceptable by the parameter.
Definition qgsprocessingparameters.cpp:5996
QgsProcessingParameterMapLayer
A map layer parameter for processing algorithms.
Definition qgsprocessingparameters.h:3289
QgsProcessingParameterMapLayer::type
QString type() const override
Unique parameter type name.
Definition qgsprocessingparameters.h:3304
QgsProcessingParameterMapLayer::QgsProcessingParameterMapLayer
QgsProcessingParameterMapLayer(const QString &name, const QString &description=QString(), const QVariant &defaultValue=QVariant(), bool optional=false, const QList< int > &types=QList< int >())
Constructor for QgsProcessingParameterMapLayer.
Definition qgsprocessingparameters.cpp:3315
QgsProcessingParameterMapLayer::typeName
static QString typeName()
Returns the type name for the parameter class.
Definition qgsprocessingparameters.h:3302
QgsProcessingParameterMapTheme
A map theme parameter for processing algorithms, allowing users to select an existing map theme from ...
Definition qgsprocessingparameters.h:4283
QgsProcessingParameterMapTheme::type
QString type() const override
Unique parameter type name.
Definition qgsprocessingparameters.h:4297
QgsProcessingParameterMapTheme::typeName
static QString typeName()
Returns the type name for the parameter class.
Definition qgsprocessingparameters.h:4295
QgsProcessingParameterMapTheme::QgsProcessingParameterMapTheme
QgsProcessingParameterMapTheme(const QString &name, const QString &description=QString(), const QVariant &defaultValue=QVariant(), bool optional=false)
Constructor for QgsProcessingParameterMapTheme.
Definition qgsprocessingparameters.cpp:8797
QgsProcessingParameterMatrix
A table (matrix) parameter for processing algorithms.
Definition qgsprocessingparameters.h:2195
QgsProcessingParameterMatrix::headers
QStringList headers() const
Returns a list of column headers (if set).
Definition qgsprocessingparameters.cpp:4449
QgsProcessingParameterMatrix::numberRows
int numberRows() const
Returns the fixed number of rows in the table.
Definition qgsprocessingparameters.cpp:4459
QgsProcessingParameterMatrix::typeName
static QString typeName()
Returns the type name for the parameter class.
Definition qgsprocessingparameters.h:2209
QgsProcessingParameterMatrix::QgsProcessingParameterMatrix
QgsProcessingParameterMatrix(const QString &name, const QString &description=QString(), int numberRows=3, bool hasFixedNumberRows=false, const QStringList &headers=QStringList(), const QVariant &defaultValue=QVariant(), bool optional=false)
Constructor for QgsProcessingParameterMatrix.
Definition qgsprocessingparameters.cpp:4362
QgsProcessingParameterMatrix::type
QString type() const override
Unique parameter type name.
Definition qgsprocessingparameters.h:2212
QgsProcessingParameterMatrix::hasFixedNumberRows
bool hasFixedNumberRows() const
Returns whether the table has a fixed number of rows.
Definition qgsprocessingparameters.cpp:4469
QgsProcessingParameterMeshDatasetGroups::typeName
static QString typeName()
Returns the type name for the parameter class.
Definition qgsprocessingparametermeshdataset.h:63
QgsProcessingParameterMeshDatasetTime::typeName
static QString typeName()
Returns the type name for the parameter class.
Definition qgsprocessingparametermeshdataset.h:186
QgsProcessingParameterMeshLayer
A mesh layer parameter for processing algorithms.
Definition qgsprocessingparameters.h:3254
QgsProcessingParameterMeshLayer::QgsProcessingParameterMeshLayer
QgsProcessingParameterMeshLayer(const QString &name, const QString &description=QString(), const QVariant &defaultValue=QVariant(), bool optional=false)
Constructor for QgsProcessingParameterMeshLayer.
Definition qgsprocessingparameters.cpp:6035
QgsProcessingParameterMeshLayer::type
QString type() const override
Unique parameter type name.
Definition qgsprocessingparameters.h:3270
QgsProcessingParameterMeshLayer::typeName
static QString typeName()
Returns the type name for the parameter class.
Definition qgsprocessingparameters.h:3268
QgsProcessingParameterMultipleLayers
A parameter for processing algorithms which accepts multiple map layers.
Definition qgsprocessingparameters.h:2281
QgsProcessingParameterMultipleLayers::layerType
Qgis::ProcessingSourceType layerType() const
Returns the layer type for layers acceptable by the parameter.
Definition qgsprocessingparameters.cpp:4753
QgsProcessingParameterMultipleLayers::typeName
static QString typeName()
Returns the type name for the parameter class.
Definition qgsprocessingparameters.h:2294
QgsProcessingParameterMultipleLayers::QgsProcessingParameterMultipleLayers
QgsProcessingParameterMultipleLayers(const QString &name, const QString &description=QString(), Qgis::ProcessingSourceType layerType=Qgis::ProcessingSourceType::VectorAnyGeometry, const QVariant &defaultValue=QVariant(), bool optional=false)
Constructor for QgsProcessingParameterMultipleLayers.
Definition qgsprocessingparameters.cpp:4502
QgsProcessingParameterMultipleLayers::type
QString type() const override
Unique parameter type name.
Definition qgsprocessingparameters.h:2296
QgsProcessingParameterNumber
A numeric parameter for processing algorithms.
Definition qgsprocessingparameters.h:2364
QgsProcessingParameterNumber::type
QString type() const override
Unique parameter type name.
Definition qgsprocessingparameters.h:2384
QgsProcessingParameterNumber::typeName
static QString typeName()
Returns the type name for the parameter class.
Definition qgsprocessingparameters.h:2381
QgsProcessingParameterNumber::QgsProcessingParameterNumber
QgsProcessingParameterNumber(const QString &name, const QString &description=QString(), Qgis::ProcessingNumberParameterType type=Qgis::ProcessingNumberParameterType::Integer, const QVariant &defaultValue=QVariant(), bool optional=false, double minValue=std::numeric_limits< double >::lowest()+1, double maxValue=std::numeric_limits< double >::max())
Constructor for QgsProcessingParameterNumber.
Definition qgsprocessingparameters.cpp:4811
QgsProcessingParameterPointCloudAttribute
A point cloud layer attribute parameter for Processing algorithms.
Definition qgsprocessingparameters.h:4765
QgsProcessingParameterPointCloudAttribute::QgsProcessingParameterPointCloudAttribute
QgsProcessingParameterPointCloudAttribute(const QString &name, const QString &description=QString(), const QVariant &defaultValue=QVariant(), const QString &parentLayerParameterName=QString(), bool allowMultiple=false, bool optional=false, bool defaultToAllAttributes=false)
Constructor for QgsProcessingParameterField.
Definition qgsprocessingparameters.cpp:9865
QgsProcessingParameterPointCloudAttribute::type
QString type() const override
Unique parameter type name.
Definition qgsprocessingparameters.h:4782
QgsProcessingParameterPointCloudAttribute::parentLayerParameterName
QString parentLayerParameterName() const
Returns the name of the parent layer parameter, or an empty string if this is not set.
Definition qgsprocessingparameters.cpp:10005
QgsProcessingParameterPointCloudAttribute::typeName
static QString typeName()
Returns the type name for the parameter class.
Definition qgsprocessingparameters.h:4780
QgsProcessingParameterPointCloudAttribute::allowMultiple
bool allowMultiple() const
Returns whether multiple field selections are permitted.
Definition qgsprocessingparameters.cpp:10015
QgsProcessingParameterPointCloudAttribute::defaultToAllAttributes
bool defaultToAllAttributes() const
Returns whether a parameter which allows multiple selections (see allowMultiple()) should automatical...
Definition qgsprocessingparameters.cpp:10025
QgsProcessingParameterPointCloudDestination
A point cloud layer destination parameter, for specifying the destination path for a point cloud laye...
Definition qgsprocessingparameters.h:4720
QgsProcessingParameterPointCloudDestination::type
QString type() const override
Unique parameter type name.
Definition qgsprocessingparameters.h:4739
QgsProcessingParameterPointCloudDestination::typeName
static QString typeName()
Returns the type name for the parameter class.
Definition qgsprocessingparameters.h:4737
QgsProcessingParameterPointCloudDestination::QgsProcessingParameterPointCloudDestination
QgsProcessingParameterPointCloudDestination(const QString &name, const QString &description=QString(), const QVariant &defaultValue=QVariant(), bool optional=false, bool createByDefault=true)
Constructor for QgsProcessingParameterPointCloudDestination.
Definition qgsprocessingparameters.cpp:9734
QgsProcessingParameterPointCloudLayer
A point cloud layer parameter for processing algorithms.
Definition qgsprocessingparameters.h:4651
QgsProcessingParameterPointCloudLayer::type
QString type() const override
Unique parameter type name.
Definition qgsprocessingparameters.h:4665
QgsProcessingParameterPointCloudLayer::typeName
static QString typeName()
Returns the type name for the parameter class.
Definition qgsprocessingparameters.h:4663
QgsProcessingParameterPointCloudLayer::QgsProcessingParameterPointCloudLayer
QgsProcessingParameterPointCloudLayer(const QString &name, const QString &description=QString(), const QVariant &defaultValue=QVariant(), bool optional=false)
Constructor for QgsProcessingParameterPointCloudLayer.
Definition qgsprocessingparameters.cpp:9556
QgsProcessingParameterPoint
A point parameter for processing algorithms.
Definition qgsprocessingparameters.h:1998
QgsProcessingParameterPoint::type
QString type() const override
Unique parameter type name.
Definition qgsprocessingparameters.h:2012
QgsProcessingParameterPoint::QgsProcessingParameterPoint
QgsProcessingParameterPoint(const QString &name, const QString &description=QString(), const QVariant &defaultValue=QVariant(), bool optional=false)
Constructor for QgsProcessingParameterPoint.
Definition qgsprocessingparameters.cpp:3798
QgsProcessingParameterPoint::typeName
static QString typeName()
Returns the type name for the parameter class.
Definition qgsprocessingparameters.h:2010
QgsProcessingParameterProviderConnection
A data provider connection parameter for processing algorithms, allowing users to select from availab...
Definition qgsprocessingparameters.h:4435
QgsProcessingParameterProviderConnection::type
QString type() const override
Unique parameter type name.
Definition qgsprocessingparameters.h:4452
QgsProcessingParameterProviderConnection::QgsProcessingParameterProviderConnection
QgsProcessingParameterProviderConnection(const QString &name, const QString &description, const QString &provider, const QVariant &defaultValue=QVariant(), bool optional=false)
Constructor for QgsProcessingParameterProviderConnection, for the specified provider type.
Definition qgsprocessingparameters.cpp:9146
QgsProcessingParameterProviderConnection::typeName
static QString typeName()
Returns the type name for the parameter class.
Definition qgsprocessingparameters.h:4450
QgsProcessingParameterProviderConnection::setProviderId
void setProviderId(const QString &provider)
Sets the ID of the provider associated with the connections.
Definition qgsprocessingparameters.h:4470
QgsProcessingParameterProviderConnection::providerId
QString providerId() const
Returns the ID of the provider associated with the connections.
Definition qgsprocessingparameters.h:4464
QgsProcessingParameterRange
A numeric range parameter for processing algorithms.
Definition qgsprocessingparameters.h:2795
QgsProcessingParameterRange::typeName
static QString typeName()
Returns the type name for the parameter class.
Definition qgsprocessingparameters.h:2809
QgsProcessingParameterRange::QgsProcessingParameterRange
QgsProcessingParameterRange(const QString &name, const QString &description=QString(), Qgis::ProcessingNumberParameterType type=Qgis::ProcessingNumberParameterType::Integer, const QVariant &defaultValue=QVariant(), bool optional=false)
Constructor for QgsProcessingParameterRange.
Definition qgsprocessingparameters.cpp:4958
QgsProcessingParameterRange::type
QString type() const override
Unique parameter type name.
Definition qgsprocessingparameters.h:2812
QgsProcessingParameterRasterDestination
A raster layer destination parameter, for specifying the destination path for a raster layer created ...
Definition qgsprocessingparameters.h:3767
QgsProcessingParameterRasterDestination::type
QString type() const override
Unique parameter type name.
Definition qgsprocessingparameters.h:3786
QgsProcessingParameterRasterDestination::QgsProcessingParameterRasterDestination
QgsProcessingParameterRasterDestination(const QString &name, const QString &description=QString(), const QVariant &defaultValue=QVariant(), bool optional=false, bool createByDefault=true)
Constructor for QgsProcessingParameterRasterDestination.
Definition qgsprocessingparameters.cpp:7030
QgsProcessingParameterRasterDestination::typeName
static QString typeName()
Returns the type name for the parameter class.
Definition qgsprocessingparameters.h:3784
QgsProcessingParameterRasterLayer
A raster layer parameter for processing algorithms.
Definition qgsprocessingparameters.h:2848
QgsProcessingParameterRasterLayer::type
QString type() const override
Unique parameter type name.
Definition qgsprocessingparameters.h:2862
QgsProcessingParameterRasterLayer::typeName
static QString typeName()
Returns the type name for the parameter class.
Definition qgsprocessingparameters.h:2860
QgsProcessingParameterRasterLayer::QgsProcessingParameterRasterLayer
QgsProcessingParameterRasterLayer(const QString &name, const QString &description=QString(), const QVariant &defaultValue=QVariant(), bool optional=false)
Constructor for QgsProcessingParameterRasterLayer.
Definition qgsprocessingparameters.cpp:5088
QgsProcessingParameterScale
A double numeric parameter for map scale values.
Definition qgsprocessingparameters.h:2762
QgsProcessingParameterScale::typeName
static QString typeName()
Returns the type name for the parameter class.
Definition qgsprocessingparameters.h:2775
QgsProcessingParameterScale::QgsProcessingParameterScale
QgsProcessingParameterScale(const QString &name, const QString &description=QString(), const QVariant &defaultValue=QVariant(), bool optional=false)
Constructor for QgsProcessingParameterScale.
Definition qgsprocessingparameters.cpp:8255
QgsProcessingParameterString
A string parameter for processing algorithms.
Definition qgsprocessingparameters.h:3018
QgsProcessingParameterString::typeName
static QString typeName()
Returns the type name for the parameter class.
Definition qgsprocessingparameters.h:3031
QgsProcessingParameterString::type
QString type() const override
Unique parameter type name.
Definition qgsprocessingparameters.h:3033
QgsProcessingParameterString::multiLine
bool multiLine() const
Returns true if the parameter allows multiline strings.
Definition qgsprocessingparameters.cpp:5672
QgsProcessingParameterString::QgsProcessingParameterString
QgsProcessingParameterString(const QString &name, const QString &description=QString(), const QVariant &defaultValue=QVariant(), bool multiLine=false, bool optional=false)
Constructor for QgsProcessingParameterString.
Definition qgsprocessingparameters.cpp:5614
QgsProcessingParameterTinInputLayers::typeName
static QString typeName()
Returns the type name for the parameter class.
Definition qgsprocessingparametertininputlayers.h:63
QgsProcessingParameterVectorDestination
A vector layer destination parameter, for specifying the destination path for a vector layer created ...
Definition qgsprocessingparameters.h:3695
QgsProcessingParameterVectorDestination::QgsProcessingParameterVectorDestination
QgsProcessingParameterVectorDestination(const QString &name, const QString &description=QString(), Qgis::ProcessingSourceType type=Qgis::ProcessingSourceType::VectorAnyGeometry, const QVariant &defaultValue=QVariant(), bool optional=false, bool createByDefault=true)
Constructor for QgsProcessingParameterVectorDestination.
Definition qgsprocessingparameters.cpp:7468
QgsProcessingParameterVectorDestination::type
QString type() const override
Unique parameter type name.
Definition qgsprocessingparameters.h:3712
QgsProcessingParameterVectorDestination::typeName
static QString typeName()
Returns the type name for the parameter class.
Definition qgsprocessingparameters.h:3710
QgsProcessingParameterVectorLayer
A vector layer (with or without geometry) parameter for processing algorithms.
Definition qgsprocessingparameters.h:3212
QgsProcessingParameterVectorLayer::type
QString type() const override
Unique parameter type name.
Definition qgsprocessingparameters.h:3229
QgsProcessingParameterVectorLayer::QgsProcessingParameterVectorLayer
QgsProcessingParameterVectorLayer(const QString &name, const QString &description=QString(), const QList< int > &types=QList< int >(), const QVariant &defaultValue=QVariant(), bool optional=false)
Constructor for QgsProcessingParameterVectorLayer.
Definition qgsprocessingparameters.cpp:5884
QgsProcessingParameterVectorLayer::typeName
static QString typeName()
Returns the type name for the parameter class.
Definition qgsprocessingparameters.h:3227
QgsProcessingParameterVectorTileDestination
A vector tile layer destination parameter, for specifying the destination path for a vector tile laye...
Definition qgsprocessingparameters.h:4856
QgsProcessingParameterVectorTileDestination::QgsProcessingParameterVectorTileDestination
QgsProcessingParameterVectorTileDestination(const QString &name, const QString &description=QString(), const QVariant &defaultValue=QVariant(), bool optional=false, bool createByDefault=true)
Constructor for QgsProcessingParameterVectorTileDestination.
Definition qgsprocessingparameters.cpp:10092
QgsProcessingParameterVectorTileDestination::typeName
static QString typeName()
Returns the type name for the parameter class.
Definition qgsprocessingparameters.h:4873
QgsProcessingParameterVectorTileDestination::type
QString type() const override
Unique parameter type name.
Definition qgsprocessingparameters.h:4875
QgsProcessingParameterVectorTileWriterLayers::typeName
static QString typeName()
Returns the type name for the parameter class.
Definition qgsprocessingparametervectortilewriterlayers.h:60
QgsProcessingParameterVolume
A double numeric parameter for volume values.
Definition qgsprocessingparameters.h:2634
QgsProcessingParameterVolume::typeName
static QString typeName()
Returns the type name for the parameter class.
Definition qgsprocessingparameters.h:2650
QgsProcessingParameterVolume::QgsProcessingParameterVolume
QgsProcessingParameterVolume(const QString &name, const QString &description=QString(), const QVariant &defaultValue=QVariant(), const QString &parentParameterName=QString(), bool optional=false, double minValue=0, double maxValue=std::numeric_limits< double >::max())
Constructor for QgsProcessingParameterVolume.
Definition qgsprocessingparameters.cpp:8102
QgsProcessingParameterVolume::defaultUnit
Qgis::VolumeUnit defaultUnit() const
Returns the default volume unit for the parameter.
Definition qgsprocessingparameters.h:2675
QgsProcessingParameterVolume::setDefaultUnit
void setDefaultUnit(Qgis::VolumeUnit unit)
Sets the default volume unit for the parameter.
Definition qgsprocessingparameters.h:2682
QgsProcessingParameterVolume::parentParameterName
QString parentParameterName() const
Returns the name of the parent parameter, or an empty string if this is not set.
Definition qgsprocessingparameters.cpp:8152
QgsProcessingParameters
A collection of utilities for working with parameters when running a processing algorithm.
Definition qgsprocessingparameters.h:1065
QgsProcessingParameters::descriptionFromName
static QString descriptionFromName(const QString &name)
Creates an autogenerated parameter description from a parameter name.
Definition qgsprocessingparameters.cpp:2341
QgsProcessingParameters::parameterAsEnum
static int parameterAsEnum(const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters, const QgsProcessingContext &context)
Evaluates the parameter with matching definition to a enum value.
Definition qgsprocessingparameters.cpp:453
QgsProcessingParameters::parameterAsDouble
static double parameterAsDouble(const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters, const QgsProcessingContext &context)
Evaluates the parameter with matching definition to a static double value.
Definition qgsprocessingparameters.cpp:211
QgsProcessingParameters::parameterAsPoint
static QgsPointXY parameterAsPoint(const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters, QgsProcessingContext &context, const QgsCoordinateReferenceSystem &crs=QgsCoordinateReferenceSystem())
Evaluates the parameter with matching definition to a point.
Definition qgsprocessingparameters.cpp:1446
QgsProcessingParameters::parameterAsOutputLayer
static QString parameterAsOutputLayer(const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters, QgsProcessingContext &context)
Evaluates the parameter with matching definition to a output layer destination.
Definition qgsprocessingparameters.cpp:968
QgsProcessingParameters::parameterAsSink
static QgsFeatureSink * parameterAsSink(const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters, const QgsFields &fields, Qgis::WkbType geometryType, const QgsCoordinateReferenceSystem &crs, QgsProcessingContext &context, QString &destinationIdentifier, QgsFeatureSink::SinkFlags sinkFlags=QgsFeatureSink::SinkFlags(), const QVariantMap &createOptions=QVariantMap(), const QStringList &datasourceOptions=QStringList(), const QStringList &layerOptions=QStringList())
Evaluates the parameter with matching definition to a feature sink.
Definition qgsprocessingparameters.cpp:687
QgsProcessingParameters::parameterAsLayout
static QgsPrintLayout * parameterAsLayout(const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters, QgsProcessingContext &context)
Evaluates the parameter with matching definition to a print layout.
Definition qgsprocessingparameters.cpp:2088
QgsProcessingParameters::parameterAsLayerList
static QList< QgsMapLayer * > parameterAsLayerList(const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessing::LayerOptionsFlags flags=QgsProcessing::LayerOptionsFlags())
Evaluates the parameter with matching definition to a list of map layers.
Definition qgsprocessingparameters.cpp:1803
QgsProcessingParameters::parameterAsTime
static QTime parameterAsTime(const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters, const QgsProcessingContext &context)
Evaluates the parameter with matching definition to a static time value.
Definition qgsprocessingparameters.cpp:410
QgsProcessingParameters::parameterFromVariantMap
static QgsProcessingParameterDefinition * parameterFromVariantMap(const QVariantMap &map)
Creates a new QgsProcessingParameterDefinition using the configuration from a supplied variant map.
Definition qgsprocessingparameters.cpp:2250
QgsProcessingParameters::parameterAsExtent
static QgsRectangle parameterAsExtent(const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters, QgsProcessingContext &context, const QgsCoordinateReferenceSystem &crs=QgsCoordinateReferenceSystem())
Evaluates the parameter with matching definition to a rectangular extent.
Definition qgsprocessingparameters.cpp:1109
QgsProcessingParameters::parameterAsGeometryCrs
static QgsCoordinateReferenceSystem parameterAsGeometryCrs(const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters, QgsProcessingContext &context)
Returns the coordinate reference system associated with a geometry parameter value.
Definition qgsprocessingparameters.cpp:1684
QgsProcessingParameters::parameterAsAnnotationLayer
static QgsAnnotationLayer * parameterAsAnnotationLayer(const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters, QgsProcessingContext &context)
Evaluates the parameter with matching definition to an annotation layer.
Definition qgsprocessingparameters.cpp:2240
QgsProcessingParameters::parameterAsEnumString
static QString parameterAsEnumString(const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters, const QgsProcessingContext &context)
Evaluates the parameter with matching definition to a static enum string.
Definition qgsprocessingparameters.cpp:544
QgsProcessingParameters::parameterAsRange
static QList< double > parameterAsRange(const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters, QgsProcessingContext &context)
Evaluates the parameter with matching definition to a range of values.
Definition qgsprocessingparameters.cpp:1952
QgsProcessingParameters::parameterAsStrings
static QStringList parameterAsStrings(const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters, QgsProcessingContext &context)
Evaluates the parameter with matching definition to a list of strings (e.g.
Definition qgsprocessingparameters.cpp:2031
QgsProcessingParameters::parameterAsInts
static QList< int > parameterAsInts(const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters, const QgsProcessingContext &context)
Evaluates the parameter with matching definition to a list of integer values.
Definition qgsprocessingparameters.cpp:280
QgsProcessingParameters::parameterAsConnectionName
static QString parameterAsConnectionName(const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters, const QgsProcessingContext &context)
Evaluates the parameter with matching definition to a connection name string.
Definition qgsprocessingparameters.cpp:2185
QgsProcessingParameters::parameterAsSource
static QgsProcessingFeatureSource * parameterAsSource(const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters, QgsProcessingContext &context)
Evaluates the parameter with matching definition to a feature source.
Definition qgsprocessingparameters.cpp:776
QgsProcessingParameters::parameterAsFileOutput
static QString parameterAsFileOutput(const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters, QgsProcessingContext &context)
Evaluates the parameter with matching definition to a file based output destination.
Definition qgsprocessingparameters.cpp:1040
QgsProcessingParameters::parameterAsBoolean
static bool parameterAsBoolean(const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters, const QgsProcessingContext &context)
Evaluates the parameter with matching definition to a static boolean value.
Definition qgsprocessingparameters.cpp:647
QgsProcessingParameters::parameterAsPointCloudLayer
static QgsPointCloudLayer * parameterAsPointCloudLayer(const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessing::LayerOptionsFlags flags=QgsProcessing::LayerOptionsFlags())
Evaluates the parameter with matching definition to a point cloud layer.
Definition qgsprocessingparameters.cpp:2230
QgsProcessingParameters::parameterAsPointCrs
static QgsCoordinateReferenceSystem parameterAsPointCrs(const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters, QgsProcessingContext &context)
Returns the coordinate reference system associated with an point parameter value.
Definition qgsprocessingparameters.cpp:1530
QgsProcessingParameters::parameterAsLayoutItem
static QgsLayoutItem * parameterAsLayoutItem(const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters, QgsProcessingContext &context, QgsPrintLayout *layout)
Evaluates the parameter with matching definition to a print layout item, taken from the specified lay...
Definition qgsprocessingparameters.cpp:2112
QgsProcessingParameters::parameterAsBool
static bool parameterAsBool(const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters, const QgsProcessingContext &context)
Evaluates the parameter with matching definition to a static boolean value.
Definition qgsprocessingparameters.cpp:639
QgsProcessingParameters::parameterAsCompatibleSourceLayerPathAndLayerName
static QString parameterAsCompatibleSourceLayerPathAndLayerName(const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters, QgsProcessingContext &context, const QStringList &compatibleFormats, const QString &preferredFormat=QString("shp"), QgsProcessingFeedback *feedback=nullptr, QString *layerName=nullptr)
Evaluates the parameter with matching definition to a source vector layer file path and layer name of...
Definition qgsprocessingparameters.cpp:873
QgsProcessingParameters::parameterAsMeshLayer
static QgsMeshLayer * parameterAsMeshLayer(const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters, QgsProcessingContext &context)
Evaluates the parameter with matching definition and value to a mesh layer.
Definition qgsprocessingparameters.cpp:958
QgsProcessingParameters::parameterAsCompatibleSourceLayerPath
static QString parameterAsCompatibleSourceLayerPath(const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters, QgsProcessingContext &context, const QStringList &compatibleFormats, const QString &preferredFormat=QString("shp"), QgsProcessingFeedback *feedback=nullptr)
Evaluates the parameter with matching definition to a source vector layer file path of compatible for...
Definition qgsprocessingparameters.cpp:868
QgsProcessingParameters::parameterFromScriptCode
static QgsProcessingParameterDefinition * parameterFromScriptCode(const QString &code)
Creates a new QgsProcessingParameterDefinition using the configuration from a supplied script code st...
Definition qgsprocessingparameters.cpp:2348
QgsProcessingParameters::parameterAsColor
static QColor parameterAsColor(const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters, QgsProcessingContext &context)
Returns the color associated with an point parameter value, or an invalid color if the parameter was ...
Definition qgsprocessingparameters.cpp:2138
QgsProcessingParameters::parameterAsVectorLayer
static QgsVectorLayer * parameterAsVectorLayer(const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters, QgsProcessingContext &context)
Evaluates the parameter with matching definition to a vector layer.
Definition qgsprocessingparameters.cpp:1083
QgsProcessingParameters::parameterAsInt
static int parameterAsInt(const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters, const QgsProcessingContext &context)
Evaluates the parameter with matching definition to a static integer value.
Definition qgsprocessingparameters.cpp:238
QgsProcessingParameters::parameterAsDatabaseTableName
static QString parameterAsDatabaseTableName(const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters, const QgsProcessingContext &context)
Evaluates the parameter with matching definition to a database table name.
Definition qgsprocessingparameters.cpp:2215
QgsProcessingParameters::parameterAsSchema
static QString parameterAsSchema(const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters, const QgsProcessingContext &context)
Evaluates the parameter with matching definition to a database schema name.
Definition qgsprocessingparameters.cpp:2200
QgsProcessingParameters::parameterAsGeometry
static QgsGeometry parameterAsGeometry(const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters, QgsProcessingContext &context, const QgsCoordinateReferenceSystem &crs=QgsCoordinateReferenceSystem())
Evaluates the parameter with matching definition to a geometry.
Definition qgsprocessingparameters.cpp:1564
QgsProcessingParameters::parameterAsLayer
static QgsMapLayer * parameterAsLayer(const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingUtils::LayerHint layerHint=QgsProcessingUtils::LayerHint::UnknownType, QgsProcessing::LayerOptionsFlags flags=QgsProcessing::LayerOptionsFlags())
Evaluates the parameter with matching definition to a map layer.
Definition qgsprocessingparameters.cpp:885
QgsProcessingParameters::parameterAsExpression
static QString parameterAsExpression(const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters, const QgsProcessingContext &context)
Evaluates the parameter with matching definition to an expression.
Definition qgsprocessingparameters.cpp:183
QgsProcessingParameters::parameterAsString
static QString parameterAsString(const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters, const QgsProcessingContext &context)
Evaluates the parameter with matching definition to a static string value.
Definition qgsprocessingparameters.cpp:151
QgsProcessingParameters::parameterAsRasterLayer
static QgsRasterLayer * parameterAsRasterLayer(const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters, QgsProcessingContext &context)
Evaluates the parameter with matching definition to a raster layer.
Definition qgsprocessingparameters.cpp:948
QgsProcessingParameters::parameterAsEnums
static QList< int > parameterAsEnums(const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters, const QgsProcessingContext &context)
Evaluates the parameter with matching definition to list of enum values.
Definition qgsprocessingparameters.cpp:475
QgsProcessingParameters::parameterAsEnumStrings
static QStringList parameterAsEnumStrings(const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters, const QgsProcessingContext &context)
Evaluates the parameter with matching definition to list of static enum strings.
Definition qgsprocessingparameters.cpp:570
QgsProcessingParameters::parameterAsExtentGeometry
static QgsGeometry parameterAsExtentGeometry(const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters, QgsProcessingContext &context, const QgsCoordinateReferenceSystem &crs=QgsCoordinateReferenceSystem())
Evaluates the parameter with matching definition to a rectangular extent, and returns a geometry cove...
Definition qgsprocessingparameters.cpp:1242
QgsProcessingParameters::parameterAsFileList
static QStringList parameterAsFileList(const QgsProcessingParameterDefinition *definition, const QVariant &value, QgsProcessingContext &context)
Evaluates the parameter with matching definition to a list of files (for QgsProcessingParameterMultip...
Definition qgsprocessingparameters.cpp:1898
QgsProcessingParameters::isDynamic
static bool isDynamic(const QVariantMap &parameters, const QString &name)
Returns true if the parameter with matching name is a dynamic parameter, and must be evaluated once f...
Definition qgsprocessingparameters.cpp:142
QgsProcessingParameters::parameterAsFields
static Q_DECL_DEPRECATED QStringList parameterAsFields(const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters, QgsProcessingContext &context)
Evaluates the parameter with matching definition to a list of fields.
Definition qgsprocessingparameters.cpp:2018
QgsProcessingParameters::parameterAsExtentCrs
static QgsCoordinateReferenceSystem parameterAsExtentCrs(const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters, QgsProcessingContext &context)
Returns the coordinate reference system associated with an extent parameter value.
Definition qgsprocessingparameters.cpp:1364
QgsProcessingParameters::parameterAsDateTime
static QDateTime parameterAsDateTime(const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters, const QgsProcessingContext &context)
Evaluates the parameter with matching definition to a static datetime value.
Definition qgsprocessingparameters.cpp:336
QgsProcessingParameters::parameterAsFile
static QString parameterAsFile(const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters, QgsProcessingContext &context)
Evaluates the parameter with matching definition to a file/folder name.
Definition qgsprocessingparameters.cpp:1737
QgsProcessingParameters::parameterAsDate
static QDate parameterAsDate(const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters, const QgsProcessingContext &context)
Evaluates the parameter with matching definition to a static date value.
Definition qgsprocessingparameters.cpp:373
QgsProcessingParameters::parameterAsMatrix
static QVariantList parameterAsMatrix(const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters, QgsProcessingContext &context)
Evaluates the parameter with matching definition to a matrix/table of values.
Definition qgsprocessingparameters.cpp:1759
QgsProcessingParameters::parameterAsCrs
static QgsCoordinateReferenceSystem parameterAsCrs(const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters, QgsProcessingContext &context)
Evaluates the parameter with matching definition to a coordinate reference system.
Definition qgsprocessingparameters.cpp:1093
QgsProcessingProvider
Abstract base class for processing providers.
Definition qgsprocessingprovider.h:36
QgsProcessingRasterLayerDefinition
Encapsulates settings relating to a raster layer input to a processing algorithm.
Definition qgsprocessingparameters.h:206
QgsProcessingRasterLayerDefinition::referenceScale
double referenceScale
If set to a value > 0, sets a scale at which a raster (e.g., a WMS) should be requested or rendered.
Definition qgsprocessingparameters.h:247
QgsProcessingRasterLayerDefinition::dpi
int dpi
Indicates the resolution of the raster source (e.g., a WMS server).
Definition qgsprocessingparameters.h:252
QgsProcessingRasterLayerDefinition::operator==
bool operator==(const QgsProcessingRasterLayerDefinition &other) const
Definition qgsprocessingparameters.h:269
QgsProcessingRasterLayerDefinition::loadVariant
bool loadVariant(const QVariantMap &map)
Loads this raster layer definition from a QVariantMap, wrapped in a QVariant.
Definition qgsprocessingparameters.cpp:86
QgsProcessingRasterLayerDefinition::QgsProcessingRasterLayerDefinition
QgsProcessingRasterLayerDefinition(const QString &source=QString(), const double referenceScale=0, const int dpi=96)
Constructor for QgsProcessingRasterLayerDefinition, accepting a static string source.
Definition qgsprocessingparameters.h:218
QgsProcessingRasterLayerDefinition::toVariant
QVariant toVariant() const
Saves this raster layer definition to a QVariantMap, wrapped in a QVariant.
Definition qgsprocessingparameters.cpp:77
QgsProcessingRasterLayerDefinition::QgsProcessingRasterLayerDefinition
QgsProcessingRasterLayerDefinition(const QgsProperty &source, const double referenceScale=0, const int dpi=96)
Constructor for QgsProcessingRasterLayerDefinition, accepting a QgsProperty source.
Definition qgsprocessingparameters.h:233
QgsProcessingRasterLayerDefinition::operator!=
bool operator!=(const QgsProcessingRasterLayerDefinition &other) const
Definition qgsprocessingparameters.h:276
QgsProcessingUtils::LayerHint
LayerHint
Layer type hints.
Definition qgsprocessingutils.h:255
QgsProcessing
Contains enumerations and other constants for use in processing algorithms and parameters.
Definition qgsprocessing.h:42
QgsProcessing::LayerOptionsFlags
QFlags< LayerOptionsFlag > LayerOptionsFlags
Definition qgsprocessing.h:64
QgsProcessing::PythonOutputType
PythonOutputType
Available Python output types.
Definition qgsprocessing.h:49
QgsProcessing::PythonOutputType::PythonQgsProcessingAlgorithmSubclass
@ PythonQgsProcessingAlgorithmSubclass
Full Python QgsProcessingAlgorithm subclass.
Definition qgsprocessing.h:50
QgsProject
Encapsulates a QGIS project, including sets of map layers and their styles, layouts,...
Definition qgsproject.h:109
QgsPropertyDefinition
Definition for a property.
Definition qgsproperty.h:45
QgsProperty
A store for object properties.
Definition qgsproperty.h:228
QgsRasterLayer
Represents a raster layer.
Definition qgsrasterlayer.h:78
QgsRectangle
A rectangle specified with double values.
Definition qgsrectangle.h:44
QgsRemappingSinkDefinition
Defines the parameters used to remap features when creating a QgsRemappingProxyFeatureSink.
Definition qgsremappingproxyfeaturesink.h:39
QgsVectorLayer
Represents a vector layer which manages a vector based dataset.
Definition qgsvectorlayer.h:406
algorithm
As part of the API refactoring and improvements which landed in the Processing API was substantially reworked from the x version This was done in order to allow much of the underlying Processing framework to be ported into allowing algorithms to be written in pure substantial changes are required in order to port existing x Processing algorithms for QGIS x The most significant changes are outlined not GeoAlgorithm For algorithms which operate on features one by consider subclassing the QgsProcessingFeatureBasedAlgorithm class This class allows much of the boilerplate code for looping over features from a vector layer to be bypassed and instead requires implementation of a processFeature method Ensure that your algorithm(or algorithm 's parent class) implements the new pure virtual createInstance(self) call
SIP_CONVERT_TO_SUBCLASS_CODE
#define SIP_CONVERT_TO_SUBCLASS_CODE(code)
Definition qgis_sip.h:199
SIP_DEPRECATED
#define SIP_DEPRECATED
Definition qgis_sip.h:114
SIP_SKIP
#define SIP_SKIP
Definition qgis_sip.h:134
SIP_OUT
#define SIP_OUT
Definition qgis_sip.h:58
SIP_FACTORY
#define SIP_FACTORY
Definition qgis_sip.h:84
SIP_THROW
#define SIP_THROW(name,...)
Definition qgis_sip.h:211
SIP_END
#define SIP_END
Definition qgis_sip.h:216
Q_DECLARE_METATYPE
Q_DECLARE_METATYPE(QgsDatabaseQueryLogEntry)
operator==
bool operator==(const QgsFeatureIterator &fi1, const QgsFeatureIterator &fi2)
Definition qgsfeatureiterator.h:433
operator!=
bool operator!=(const QgsFeatureIterator &fi1, const QgsFeatureIterator &fi2)
Definition qgsfeatureiterator.h:438
QgsProcessingParameterDefinitions
QList< const QgsProcessingParameterDefinition * > QgsProcessingParameterDefinitions
List of processing parameters.
Definition qgsprocessingparameters.h:1045
Q_DECLARE_OPERATORS_FOR_FLAGS
Q_DECLARE_OPERATORS_FOR_FLAGS(QgsProjectionSelectionWidget::CrsOptions)
Generated on for QGIS API Documentation by doxygen 1.15.0