QGIS API Documentation 3.33.0-Master (49340299d2)
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 "qgis_core.h"
22#include "qgis.h"
23#include "qgsprocessing.h"
24#include "qgsproperty.h"
25#include "qgscoordinatereferencesystem.h"
26#include "qgsprocessingutils.h"
27#include "qgsfilefiltergenerator.h"
28#include "qgsremappingproxyfeaturesink.h"
29#include <QMap>
30#include <limits>
31
32class QgsProcessingContext;
33class QgsProcessingAlgorithm;
34class QgsRasterLayer;
35class QgsMeshLayer;
36class QgsVectorLayer;
37class QgsFeatureSink;
38class QgsProcessingFeatureSource;
39class QgsProcessingOutputDefinition;
40class QgsProcessingFeedback;
41class QgsProcessingProvider;
42class QgsPrintLayout;
43class QgsLayoutItem;
44class QgsPointCloudLayer;
45class QgsAnnotationLayer;
46
56class CORE_EXPORT QgsProcessingFeatureSourceDefinition
57{
58 public:
59
64 enum Flag
65 {
66 FlagOverrideDefaultGeometryCheck = 1 << 0,
67 FlagCreateIndividualOutputPerInputFeature = 1 << 1,
68 };
69 Q_DECLARE_FLAGS( Flags, Flag )
70
71
87 QgsProcessingFeatureSourceDefinition( const QString &source = QString(), bool selectedFeaturesOnly = false, long long featureLimit = -1,
88 QgsProcessingFeatureSourceDefinition::Flags flags = QgsProcessingFeatureSourceDefinition::Flags(), QgsFeatureRequest::InvalidGeometryCheck geometryCheck = QgsFeatureRequest::GeometryAbortOnInvalid, const QString &filterExpression = QString() )
89 : source( QgsProperty::fromValue( source ) )
90 , selectedFeaturesOnly( selectedFeaturesOnly )
91 , featureLimit( featureLimit )
92 , filterExpression( filterExpression )
93 , flags( flags )
94 , geometryCheck( geometryCheck )
95 {}
96
113 QgsProcessingFeatureSourceDefinition( const QgsProperty &source, bool selectedFeaturesOnly = false, long long featureLimit = -1,
114 QgsProcessingFeatureSourceDefinition::Flags flags = QgsProcessingFeatureSourceDefinition::Flags(), QgsFeatureRequest::InvalidGeometryCheck geometryCheck = QgsFeatureRequest::GeometryAbortOnInvalid, const QString &filterExpression = QString() )
115 : source( source )
116 , selectedFeaturesOnly( selectedFeaturesOnly )
117 , featureLimit( featureLimit )
118 , filterExpression( filterExpression )
119 , flags( flags )
120 , geometryCheck( geometryCheck )
121 {}
122
126 QgsProperty source;
127
131 bool selectedFeaturesOnly;
132
139 long long featureLimit = -1;
140
146 QString filterExpression;
147
153 Flags flags = Flags();
154
163 QgsFeatureRequest::InvalidGeometryCheck geometryCheck = QgsFeatureRequest::GeometryAbortOnInvalid;
164
171 QVariant toVariant() const;
172
179 bool loadVariant( const QVariantMap &map );
180
181 // TODO c++20 - replace with = default
182 bool operator==( const QgsProcessingFeatureSourceDefinition &other ) const
183 {
184 return source == other.source
185 && selectedFeaturesOnly == other.selectedFeaturesOnly
186 && featureLimit == other.featureLimit
187 && filterExpression == other.filterExpression
188 && flags == other.flags
189 && geometryCheck == other.geometryCheck;
190 }
191
192 bool operator!=( const QgsProcessingFeatureSourceDefinition &other ) const
193 {
194 return !( *this == other );
195 }
196
198 operator QVariant() const
199 {
200 return QVariant::fromValue( *this );
201 }
202
203};
204
205Q_DECLARE_METATYPE( QgsProcessingFeatureSourceDefinition )
206Q_DECLARE_OPERATORS_FOR_FLAGS( QgsProcessingFeatureSourceDefinition::Flags )
207
208
217class CORE_EXPORT QgsProcessingOutputLayerDefinition
218{
219 public:
220
226 QgsProcessingOutputLayerDefinition( const QString &sink = QString(), QgsProject *destinationProject = nullptr )
227 : sink( QgsProperty::fromValue( sink ) )
228 , destinationProject( destinationProject )
229 {}
230
236 QgsProcessingOutputLayerDefinition( const QgsProperty &sink, QgsProject *destinationProject = nullptr )
237 : sink( sink )
238 , destinationProject( destinationProject )
239 {}
240
244 QgsProperty sink;
245
251 QgsProject *destinationProject = nullptr;
252
256 QString destinationName;
257
264 QVariantMap createOptions;
265
272 bool useRemapping() const { return mUseRemapping; }
273
281 QgsRemappingSinkDefinition remappingDefinition() const { return mRemappingDefinition; }
282
293 void setRemappingDefinition( const QgsRemappingSinkDefinition &definition );
294
301 QVariant toVariant() const;
302
309 bool loadVariant( const QVariantMap &map );
310
312 operator QVariant() const
313 {
314 return QVariant::fromValue( *this );
315 }
316
317 // TODO c++20 - replace with = default
318 bool operator==( const QgsProcessingOutputLayerDefinition &other ) const;
319 bool operator!=( const QgsProcessingOutputLayerDefinition &other ) const;
320
321 private:
322
323 bool mUseRemapping = false;
324 QgsRemappingSinkDefinition mRemappingDefinition = QgsRemappingSinkDefinition();
325
326};
327
328Q_DECLARE_METATYPE( QgsProcessingOutputLayerDefinition )
329
330
331
332
333//
334// Parameter definitions
335//
336
337
349class CORE_EXPORT QgsProcessingParameterDefinition
350{
351
352#ifdef SIP_RUN
353 % TypeHeaderCode
354#include "qgsprocessingparameteraggregate.h"
355#include "qgsprocessingparameterdxflayers.h"
356#include "qgsprocessingparameterfieldmap.h"
357#include "qgsprocessingparametertininputlayers.h"
358#include "qgsprocessingparametervectortilewriterlayers.h"
359#include "qgsprocessingparametermeshdataset.h"
360 % End
361 SIP_CONVERT_TO_SUBCLASS_CODE
362 if ( sipCpp->type() == QgsProcessingParameterBoolean::typeName() )
363 sipType = sipType_QgsProcessingParameterBoolean;
364 else if ( sipCpp->type() == QgsProcessingParameterCrs::typeName() )
365 sipType = sipType_QgsProcessingParameterCrs;
366 else if ( sipCpp->type() == QgsProcessingParameterMapLayer::typeName() )
367 sipType = sipType_QgsProcessingParameterMapLayer;
368 else if ( sipCpp->type() == QgsProcessingParameterExtent::typeName() )
369 sipType = sipType_QgsProcessingParameterExtent;
370 else if ( sipCpp->type() == QgsProcessingParameterPoint::typeName() )
371 sipType = sipType_QgsProcessingParameterPoint;
372 else if ( sipCpp->type() == QgsProcessingParameterGeometry::typeName() )
373 sipType = sipType_QgsProcessingParameterGeometry;
374 else if ( sipCpp->type() == QgsProcessingParameterFile::typeName() )
375 sipType = sipType_QgsProcessingParameterFile;
376 else if ( sipCpp->type() == QgsProcessingParameterMatrix::typeName() )
377 sipType = sipType_QgsProcessingParameterMatrix;
378 else if ( sipCpp->type() == QgsProcessingParameterMultipleLayers::typeName() )
379 sipType = sipType_QgsProcessingParameterMultipleLayers;
380 else if ( sipCpp->type() == QgsProcessingParameterNumber::typeName() )
381 sipType = sipType_QgsProcessingParameterNumber;
382 else if ( sipCpp->type() == QgsProcessingParameterDistance::typeName() )
383 sipType = sipType_QgsProcessingParameterDistance;
384 else if ( sipCpp->type() == QgsProcessingParameterDuration::typeName() )
385 sipType = sipType_QgsProcessingParameterDuration;
386 else if ( sipCpp->type() == QgsProcessingParameterScale::typeName() )
387 sipType = sipType_QgsProcessingParameterScale;
388 else if ( sipCpp->type() == QgsProcessingParameterRange::typeName() )
389 sipType = sipType_QgsProcessingParameterRange;
390 else if ( sipCpp->type() == QgsProcessingParameterRasterLayer::typeName() )
391 sipType = sipType_QgsProcessingParameterRasterLayer;
392 else if ( sipCpp->type() == QgsProcessingParameterMeshLayer::typeName() )
393 sipType = sipType_QgsProcessingParameterMeshLayer;
394 else if ( sipCpp->type() == QgsProcessingParameterEnum::typeName() )
395 sipType = sipType_QgsProcessingParameterEnum;
396 else if ( sipCpp->type() == QgsProcessingParameterString::typeName() )
397 sipType = sipType_QgsProcessingParameterString;
398 else if ( sipCpp->type() == QgsProcessingParameterExpression::typeName() )
399 sipType = sipType_QgsProcessingParameterExpression;
400 else if ( sipCpp->type() == QgsProcessingParameterAuthConfig::typeName() )
401 sipType = sipType_QgsProcessingParameterAuthConfig;
402 else if ( sipCpp->type() == QgsProcessingParameterVectorLayer::typeName() )
403 sipType = sipType_QgsProcessingParameterVectorLayer;
404 else if ( sipCpp->type() == QgsProcessingParameterField::typeName() )
405 sipType = sipType_QgsProcessingParameterField;
406 else if ( sipCpp->type() == QgsProcessingParameterFeatureSource::typeName() )
407 sipType = sipType_QgsProcessingParameterFeatureSource;
408 else if ( sipCpp->type() == QgsProcessingParameterFeatureSink::typeName() )
409 sipType = sipType_QgsProcessingParameterFeatureSink;
410 else if ( sipCpp->type() == QgsProcessingParameterVectorDestination::typeName() )
411 sipType = sipType_QgsProcessingParameterVectorDestination;
412 else if ( sipCpp->type() == QgsProcessingParameterRasterDestination::typeName() )
413 sipType = sipType_QgsProcessingParameterRasterDestination;
414 else if ( sipCpp->type() == QgsProcessingParameterPointCloudDestination::typeName() )
415 sipType = sipType_QgsProcessingParameterPointCloudDestination;
416 else if ( sipCpp->type() == QgsProcessingParameterFileDestination::typeName() )
417 sipType = sipType_QgsProcessingParameterFileDestination;
418 else if ( sipCpp->type() == QgsProcessingParameterFolderDestination::typeName() )
419 sipType = sipType_QgsProcessingParameterFolderDestination;
420 else if ( sipCpp->type() == QgsProcessingParameterBand::typeName() )
421 sipType = sipType_QgsProcessingParameterBand;
422 else if ( sipCpp->type() == QgsProcessingParameterLayout::typeName() )
423 sipType = sipType_QgsProcessingParameterLayout;
424 else if ( sipCpp->type() == QgsProcessingParameterLayoutItem::typeName() )
425 sipType = sipType_QgsProcessingParameterLayoutItem;
426 else if ( sipCpp->type() == QgsProcessingParameterColor::typeName() )
427 sipType = sipType_QgsProcessingParameterColor;
428 else if ( sipCpp->type() == QgsProcessingParameterCoordinateOperation::typeName() )
429 sipType = sipType_QgsProcessingParameterCoordinateOperation;
430 else if ( sipCpp->type() == QgsProcessingParameterMapTheme::typeName() )
431 sipType = sipType_QgsProcessingParameterMapTheme;
432 else if ( sipCpp->type() == QgsProcessingParameterDateTime::typeName() )
433 sipType = sipType_QgsProcessingParameterDateTime;
434 else if ( sipCpp->type() == QgsProcessingParameterProviderConnection::typeName() )
435 sipType = sipType_QgsProcessingParameterProviderConnection;
436 else if ( sipCpp->type() == QgsProcessingParameterDatabaseSchema::typeName() )
437 sipType = sipType_QgsProcessingParameterDatabaseSchema;
438 else if ( sipCpp->type() == QgsProcessingParameterDatabaseTable::typeName() )
439 sipType = sipType_QgsProcessingParameterDatabaseTable;
440 else if ( sipCpp->type() == QgsProcessingParameterFieldMapping::typeName() )
441 sipType = sipType_QgsProcessingParameterFieldMapping;
442 else if ( sipCpp->type() == QgsProcessingParameterTinInputLayers::typeName() )
443 sipType = sipType_QgsProcessingParameterTinInputLayers;
444 else if ( sipCpp->type() == QgsProcessingParameterVectorTileWriterLayers::typeName() )
445 sipType = sipType_QgsProcessingParameterVectorTileWriterLayers;
446 else if ( sipCpp->type() == QgsProcessingParameterDxfLayers::typeName() )
447 sipType = sipType_QgsProcessingParameterDxfLayers;
448 else if ( sipCpp->type() == QgsProcessingParameterMeshDatasetGroups::typeName() )
449 sipType = sipType_QgsProcessingParameterMeshDatasetGroups;
450 else if ( sipCpp->type() == QgsProcessingParameterMeshDatasetTime::typeName() )
451 sipType = sipType_QgsProcessingParameterMeshDatasetTime;
452 else if ( sipCpp->type() == QgsProcessingParameterPointCloudLayer::typeName() )
453 sipType = sipType_QgsProcessingParameterPointCloudLayer;
454 else if ( sipCpp->type() == QgsProcessingParameterAnnotationLayer::typeName() )
455 sipType = sipType_QgsProcessingParameterAnnotationLayer;
456 else if ( sipCpp->type() == QgsProcessingParameterPointCloudAttribute::typeName() )
457 sipType = sipType_QgsProcessingParameterPointCloudAttribute;
458 else if ( sipCpp->type() == QgsProcessingParameterVectorTileDestination::typeName() )
459 sipType = sipType_QgsProcessingParameterVectorTileDestination;
460 else
461 sipType = nullptr;
462 SIP_END
463#endif
464
465 public:
466
468 enum Flag
469 {
470 FlagAdvanced = 1 << 1,
471 FlagHidden = 1 << 2,
472 FlagOptional = 1 << 3,
473 FlagIsModelOutput = 1 << 4,
474 };
475 Q_DECLARE_FLAGS( Flags, Flag )
476
477
480 QgsProcessingParameterDefinition( const QString &name, const QString &description = QString(), const QVariant &defaultValue = QVariant(),
481 bool optional = false, const QString &help = QString() );
482
483 virtual ~QgsProcessingParameterDefinition() = default;
484
488 virtual QgsProcessingParameterDefinition *clone() const = 0 SIP_FACTORY;
489
493 virtual QString type() const = 0;
494
500 virtual bool isDestination() const { return false; }
501
507 QString name() const { return mName; }
508
514 void setName( const QString &name ) { mName = name; }
515
521 QString description() const { return mDescription; }
522
528 void setDescription( const QString &description ) { mDescription = description; }
529
539 QString help() const { return mHelp; }
540
550 void setHelp( const QString &help ) { mHelp = help; }
551
558 QVariant defaultValue() const { return mDefault; }
559
566 void setDefaultValue( const QVariant &value ) { mDefault = value; }
567
580 QVariant guiDefaultValueOverride() const;
581
597 void setGuiDefaultValueOverride( const QVariant &value ) { mGuiDefault = value; }
598
607 QVariant defaultValueForGui() const;
608
613 Flags flags() const { return mFlags; }
614
619 void setFlags( Flags flags ) { mFlags = flags; }
620
628 virtual bool checkValueIsAcceptable( const QVariant &input, QgsProcessingContext *context = nullptr ) const;
629
637 virtual QString valueAsPythonString( const QVariant &value, QgsProcessingContext &context ) const;
638
650 virtual QVariant valueAsJsonObject( const QVariant &value, QgsProcessingContext &context ) const;
651
665 virtual QString valueAsString( const QVariant &value, QgsProcessingContext &context, bool &ok SIP_OUT ) const;
666
680 virtual QStringList valueAsStringList( const QVariant &value, QgsProcessingContext &context, bool &ok SIP_OUT ) const;
681
687 virtual QString valueAsPythonComment( const QVariant &value, QgsProcessingContext &context ) const;
688
693 virtual QString asScriptCode() const;
694
704 virtual QString asPythonString( QgsProcessing::PythonOutputType outputType = QgsProcessing::PythonQgsProcessingAlgorithmSubclass ) const;
705
711 virtual QVariantMap toVariantMap() const;
712
718 virtual bool fromVariantMap( const QVariantMap &map );
719
726 SIP_SKIP QVariantMap metadata() const { return mMetadata; }
727
733 QVariantMap &metadata() { return mMetadata; }
734
740 void setMetadata( const QVariantMap &metadata ) { mMetadata = metadata; }
741
746 virtual QStringList dependsOnOtherParameters() const { return QStringList(); }
747
753 QgsProcessingAlgorithm *algorithm() const;
754
760 QgsProcessingProvider *provider() const;
761
766 virtual QString toolTip() const;
767
775 bool isDynamic() const { return mIsDynamic; }
776
784 void setIsDynamic( bool dynamic ) { mIsDynamic = dynamic; }
785
792 QgsPropertyDefinition dynamicPropertyDefinition() const { return mPropertyDefinition; }
793
800 void setDynamicPropertyDefinition( const QgsPropertyDefinition &definition ) { mPropertyDefinition = definition; }
801
813 QString dynamicLayerParameterName() const { return mDynamicLayerParameterName; }
814
826 void setDynamicLayerParameterName( const QString &name ) { mDynamicLayerParameterName = name; }
827
841 QStringList additionalExpressionContextVariables() const { return mAdditionalExpressionVariables; }
842
860 void setAdditionalExpressionContextVariables( const QStringList &variables ) { mAdditionalExpressionVariables = variables; }
861
862#ifndef SIP_RUN
863
871 enum class ValueAsStringFlag : int
872 {
873 AllowMapLayerValues = 1 << 0,
874 };
875 Q_DECLARE_FLAGS( ValueAsStringFlags, ValueAsStringFlag )
876#endif
877
878 protected:
879
880#ifndef SIP_RUN
881
888 QString valueAsStringPrivate( const QVariant &value, QgsProcessingContext &context, bool &ok, ValueAsStringFlags flags ) const;
889
896 QVariant valueAsJsonObjectPrivate( const QVariant &value, QgsProcessingContext &context, ValueAsStringFlags flags ) const;
897#endif
898
905 QVariant defaultGuiValueFromSetting() const;
906
908 QString mName;
909
911 QString mDescription;
912
914 QString mHelp;
915
917 QVariant mDefault;
918
920 QVariant mGuiDefault;
921
923 Flags mFlags;
924
926 QVariantMap mMetadata;
927
929 QgsProcessingAlgorithm *mAlgorithm = nullptr;
930
932 bool mIsDynamic = false;
933
935 QgsPropertyDefinition mPropertyDefinition;
936
938 QString mDynamicLayerParameterName;
939
941 QStringList mAdditionalExpressionVariables;
942
943 // To allow access to mAlgorithm. We don't want a public setter for this!
944 friend class QgsProcessingAlgorithm;
945
946};
947
948Q_DECLARE_OPERATORS_FOR_FLAGS( QgsProcessingParameterDefinition::Flags )
949
950#ifndef SIP_RUN
951Q_DECLARE_OPERATORS_FOR_FLAGS( QgsProcessingParameterDefinition::ValueAsStringFlags )
952#endif
953
955typedef QList< const QgsProcessingParameterDefinition * > QgsProcessingParameterDefinitions;
956
975class CORE_EXPORT QgsProcessingParameters
976{
977
978 public:
979
984 static bool isDynamic( const QVariantMap &parameters, const QString &name );
985
989 static QString parameterAsString( const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters, const QgsProcessingContext &context );
990
995 static QString parameterAsString( const QgsProcessingParameterDefinition *definition, const QVariant &value, const QgsProcessingContext &context );
996
1000 static QString parameterAsExpression( const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters, const QgsProcessingContext &context );
1001
1006 static QString parameterAsExpression( const QgsProcessingParameterDefinition *definition, const QVariant &value, const QgsProcessingContext &context );
1007
1011 static double parameterAsDouble( const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters, const QgsProcessingContext &context );
1012
1017 static double parameterAsDouble( const QgsProcessingParameterDefinition *definition, const QVariant &value, const QgsProcessingContext &context );
1018
1022 static int parameterAsInt( const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters, const QgsProcessingContext &context );
1023
1028 static int parameterAsInt( const QgsProcessingParameterDefinition *definition, const QVariant &value, const QgsProcessingContext &context );
1029
1034 static QList<int> parameterAsInts( const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters, const QgsProcessingContext &context );
1035
1040 static QList<int> parameterAsInts( const QgsProcessingParameterDefinition *definition, const QVariant &value, const QgsProcessingContext &context );
1041
1050 static QDateTime parameterAsDateTime( const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters, const QgsProcessingContext &context );
1051
1060 static QDateTime parameterAsDateTime( const QgsProcessingParameterDefinition *definition, const QVariant &value, const QgsProcessingContext &context );
1061
1070 static QDate parameterAsDate( const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters, const QgsProcessingContext &context );
1071
1080 static QDate parameterAsDate( const QgsProcessingParameterDefinition *definition, const QVariant &value, const QgsProcessingContext &context );
1081
1090 static QTime parameterAsTime( const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters, const QgsProcessingContext &context );
1091
1100 static QTime parameterAsTime( const QgsProcessingParameterDefinition *definition, const QVariant &value, const QgsProcessingContext &context );
1101
1105 static int parameterAsEnum( const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters, const QgsProcessingContext &context );
1106
1111 static int parameterAsEnum( const QgsProcessingParameterDefinition *definition, const QVariant &value, const QgsProcessingContext &context );
1112
1116 static QList<int> parameterAsEnums( const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters, const QgsProcessingContext &context );
1117
1122 static QList<int> parameterAsEnums( const QgsProcessingParameterDefinition *definition, const QVariant &value, const QgsProcessingContext &context );
1123
1128 static QString parameterAsEnumString( const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters, const QgsProcessingContext &context );
1129
1134 static QString parameterAsEnumString( const QgsProcessingParameterDefinition *definition, const QVariant &value, const QgsProcessingContext &context );
1135
1140 static QStringList parameterAsEnumStrings( const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters, const QgsProcessingContext &context );
1141
1146 static QStringList parameterAsEnumStrings( const QgsProcessingParameterDefinition *definition, const QVariant &value, const QgsProcessingContext &context );
1147
1151 static bool parameterAsBool( const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters, const QgsProcessingContext &context );
1152
1158 static bool parameterAsBoolean( const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters, const QgsProcessingContext &context );
1159
1164 static bool parameterAsBool( const QgsProcessingParameterDefinition *definition, const QVariant &value, const QgsProcessingContext &context );
1165
1170 static bool parameterAsBoolean( const QgsProcessingParameterDefinition *definition, const QVariant &value, const QgsProcessingContext &context );
1171
1189 static QgsFeatureSink *parameterAsSink( const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters,
1190 const QgsFields &fields, Qgis::WkbType geometryType, const QgsCoordinateReferenceSystem &crs,
1191 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;
1192
1212 static QgsFeatureSink *parameterAsSink( const QgsProcessingParameterDefinition *definition, const QVariant &value,
1213 const QgsFields &fields, Qgis::WkbType geometryType, const QgsCoordinateReferenceSystem &crs,
1214 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;
1215
1224 static QgsProcessingFeatureSource *parameterAsSource( const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters, QgsProcessingContext &context ) SIP_FACTORY;
1225
1236 static QgsProcessingFeatureSource *parameterAsSource( const QgsProcessingParameterDefinition *definition, const QVariant &value, QgsProcessingContext &context ) SIP_FACTORY;
1237
1253 static QString parameterAsCompatibleSourceLayerPath( const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters,
1254 QgsProcessingContext &context, const QStringList &compatibleFormats, const QString &preferredFormat = QString( "shp" ), QgsProcessingFeedback *feedback = nullptr );
1255
1285 static QString parameterAsCompatibleSourceLayerPathAndLayerName( const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters,
1286 QgsProcessingContext &context, const QStringList &compatibleFormats, const QString &preferredFormat = QString( "shp" ), QgsProcessingFeedback *feedback = nullptr, QString *layerName SIP_OUT = nullptr );
1287
1295 static QgsMapLayer *parameterAsLayer( const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingUtils::LayerHint layerHint = QgsProcessingUtils::LayerHint::UnknownType, QgsProcessing::LayerOptionsFlags flags = QgsProcessing::LayerOptionsFlags() );
1296
1306 static QgsMapLayer *parameterAsLayer( const QgsProcessingParameterDefinition *definition, const QVariant &value, QgsProcessingContext &context, QgsProcessingUtils::LayerHint layerHint = QgsProcessingUtils::LayerHint::UnknownType, QgsProcessing::LayerOptionsFlags flags = QgsProcessing::LayerOptionsFlags() );
1307
1315 static QgsRasterLayer *parameterAsRasterLayer( const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters, QgsProcessingContext &context );
1316
1326 static QgsRasterLayer *parameterAsRasterLayer( const QgsProcessingParameterDefinition *definition, const QVariant &value, QgsProcessingContext &context );
1327
1331 static QString parameterAsOutputLayer( const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters, QgsProcessingContext &context );
1332
1337 static QString parameterAsOutputLayer( const QgsProcessingParameterDefinition *definition, const QVariant &value, QgsProcessingContext &context );
1338
1342 static QString parameterAsFileOutput( const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters, QgsProcessingContext &context );
1343
1348 static QString parameterAsFileOutput( const QgsProcessingParameterDefinition *definition, const QVariant &value, QgsProcessingContext &context );
1349
1357 static QgsVectorLayer *parameterAsVectorLayer( const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters, QgsProcessingContext &context );
1358
1368 static QgsVectorLayer *parameterAsVectorLayer( const QgsProcessingParameterDefinition *definition, const QVariant &value, QgsProcessingContext &context );
1369
1379 static QgsMeshLayer *parameterAsMeshLayer( const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters, QgsProcessingContext &context );
1380
1390 static QgsMeshLayer *parameterAsMeshLayer( const QgsProcessingParameterDefinition *definition, const QVariant &value, QgsProcessingContext &context );
1391
1395 static QgsCoordinateReferenceSystem parameterAsCrs( const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters, QgsProcessingContext &context );
1396
1401 static QgsCoordinateReferenceSystem parameterAsCrs( const QgsProcessingParameterDefinition *definition, const QVariant &value, QgsProcessingContext &context );
1402
1412 static QgsRectangle parameterAsExtent( const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters, QgsProcessingContext &context,
1413 const QgsCoordinateReferenceSystem &crs = QgsCoordinateReferenceSystem() );
1414
1426 static QgsRectangle parameterAsExtent( const QgsProcessingParameterDefinition *definition, const QVariant &value, QgsProcessingContext &context,
1427 const QgsCoordinateReferenceSystem &crs = QgsCoordinateReferenceSystem() );
1428
1440 static QgsGeometry parameterAsExtentGeometry( const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters, QgsProcessingContext &context,
1441 const QgsCoordinateReferenceSystem &crs = QgsCoordinateReferenceSystem() );
1442
1448 static QgsCoordinateReferenceSystem parameterAsExtentCrs( const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters, QgsProcessingContext &context );
1449
1455 static QgsCoordinateReferenceSystem parameterAsExtentCrs( const QgsProcessingParameterDefinition *definition, const QVariant &value, QgsProcessingContext &context );
1456
1457
1465 static QgsPointXY parameterAsPoint( const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters, QgsProcessingContext &context,
1466 const QgsCoordinateReferenceSystem &crs = QgsCoordinateReferenceSystem() );
1467
1476 static QgsPointXY parameterAsPoint( const QgsProcessingParameterDefinition *definition, const QVariant &value, QgsProcessingContext &context,
1477 const QgsCoordinateReferenceSystem &crs = QgsCoordinateReferenceSystem() );
1478
1484 static QgsCoordinateReferenceSystem parameterAsPointCrs( const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters, QgsProcessingContext &context );
1485
1492 static QgsCoordinateReferenceSystem parameterAsPointCrs( const QgsProcessingParameterDefinition *definition, const QVariant &value, QgsProcessingContext &context );
1493
1499 static QgsGeometry parameterAsGeometry( const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters, QgsProcessingContext &context, const QgsCoordinateReferenceSystem &crs = QgsCoordinateReferenceSystem() );
1500
1506 static QgsGeometry parameterAsGeometry( const QgsProcessingParameterDefinition *definition, const QVariant &value, QgsProcessingContext &context, const QgsCoordinateReferenceSystem &crs = QgsCoordinateReferenceSystem() );
1507
1514 static QgsCoordinateReferenceSystem parameterAsGeometryCrs( const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters, QgsProcessingContext &context );
1515
1522 static QgsCoordinateReferenceSystem parameterAsGeometryCrs( const QgsProcessingParameterDefinition *definition, const QVariant &value, QgsProcessingContext &context );
1523
1527 static QString parameterAsFile( const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters, QgsProcessingContext &context );
1528
1533 static QString parameterAsFile( const QgsProcessingParameterDefinition *definition, const QVariant &value, QgsProcessingContext &context );
1534
1539 static QVariantList parameterAsMatrix( const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters, QgsProcessingContext &context );
1540
1546 static QVariantList parameterAsMatrix( const QgsProcessingParameterDefinition *definition, const QVariant &value, QgsProcessingContext &context );
1547
1552 static QList< QgsMapLayer *> parameterAsLayerList( const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessing::LayerOptionsFlags flags = QgsProcessing::LayerOptionsFlags() );
1553
1559 static QList< QgsMapLayer *> parameterAsLayerList( const QgsProcessingParameterDefinition *definition, const QVariant &value, QgsProcessingContext &context, QgsProcessing::LayerOptionsFlags flags = QgsProcessing::LayerOptionsFlags() );
1560
1566 static QStringList parameterAsFileList( const QgsProcessingParameterDefinition *definition, const QVariant &value, QgsProcessingContext &context );
1567
1573 static QStringList parameterAsFileList( const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters, QgsProcessingContext &context );
1574
1578 static QList<double> parameterAsRange( const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters, QgsProcessingContext &context );
1579
1584 static QList<double> parameterAsRange( const QgsProcessingParameterDefinition *definition, const QVariant &value, QgsProcessingContext &context );
1585
1591 Q_DECL_DEPRECATED static QStringList parameterAsFields( const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters, QgsProcessingContext &context ) SIP_DEPRECATED;
1592
1599 Q_DECL_DEPRECATED static QStringList parameterAsFields( const QgsProcessingParameterDefinition *definition, const QVariant &value, QgsProcessingContext &context ) SIP_DEPRECATED;
1600
1606 static QStringList parameterAsStrings( const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters, QgsProcessingContext &context );
1607
1613 static QStringList parameterAsStrings( const QgsProcessingParameterDefinition *definition, const QVariant &value, QgsProcessingContext &context );
1614
1623 static QgsPrintLayout *parameterAsLayout( const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters, QgsProcessingContext &context );
1624
1633 static QgsPrintLayout *parameterAsLayout( const QgsProcessingParameterDefinition *definition, const QVariant &value, QgsProcessingContext &context );
1634
1643 static QgsLayoutItem *parameterAsLayoutItem( const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters, QgsProcessingContext &context, QgsPrintLayout *layout );
1644
1653 static QgsLayoutItem *parameterAsLayoutItem( const QgsProcessingParameterDefinition *definition, const QVariant &value, QgsProcessingContext &context, QgsPrintLayout *layout );
1654
1660 static QColor parameterAsColor( const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters, QgsProcessingContext &context );
1661
1667 static QColor parameterAsColor( const QgsProcessingParameterDefinition *definition, const QVariant &value, QgsProcessingContext &context );
1668
1674 static QString parameterAsConnectionName( const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters, const QgsProcessingContext &context );
1675
1681 static QString parameterAsConnectionName( const QgsProcessingParameterDefinition *definition, const QVariant &value, const QgsProcessingContext &context );
1682
1688 static QString parameterAsSchema( const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters, const QgsProcessingContext &context );
1689
1695 static QString parameterAsSchema( const QgsProcessingParameterDefinition *definition, const QVariant &value, const QgsProcessingContext &context );
1696
1702 static QString parameterAsDatabaseTableName( const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters, const QgsProcessingContext &context );
1703
1709 static QString parameterAsDatabaseTableName( const QgsProcessingParameterDefinition *definition, const QVariant &value, const QgsProcessingContext &context );
1710
1721 static QgsPointCloudLayer *parameterAsPointCloudLayer( const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessing::LayerOptionsFlags flags = QgsProcessing::LayerOptionsFlags() );
1722
1733 static QgsPointCloudLayer *parameterAsPointCloudLayer( const QgsProcessingParameterDefinition *definition, const QVariant &value, QgsProcessingContext &context, QgsProcessing::LayerOptionsFlags flags = QgsProcessing::LayerOptionsFlags() );
1734
1748 static QgsAnnotationLayer *parameterAsAnnotationLayer( const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters, QgsProcessingContext &context );
1749
1763 static QgsAnnotationLayer *parameterAsAnnotationLayer( const QgsProcessingParameterDefinition *definition, const QVariant &value, QgsProcessingContext &context );
1764
1770 static QgsProcessingParameterDefinition *parameterFromVariantMap( const QVariantMap &map ) SIP_FACTORY;
1771
1775 static QString descriptionFromName( const QString &name );
1776
1782 static QgsProcessingParameterDefinition *parameterFromScriptCode( const QString &code ) SIP_FACTORY;
1783
1784 private:
1785
1786 static bool parseScriptCodeParameterOptions( const QString &code, bool &isOptional, QString &name, QString &type, QString &definition );
1787};
1788
1789
1790
1797class CORE_EXPORT QgsProcessingParameterBoolean : public QgsProcessingParameterDefinition
1798{
1799 public:
1800
1804 QgsProcessingParameterBoolean( const QString &name, const QString &description = QString(), const QVariant &defaultValue = QVariant(),
1805 bool optional = false );
1806
1810 static QString typeName() { return QStringLiteral( "boolean" ); }
1811 QgsProcessingParameterDefinition *clone() const override SIP_FACTORY;
1812 QString type() const override { return typeName(); }
1813 QString valueAsPythonString( const QVariant &value, QgsProcessingContext &context ) const override;
1814 QString asScriptCode() const override;
1815
1819 static QgsProcessingParameterBoolean *fromScriptCode( const QString &name, const QString &description, bool isOptional, const QString &definition ) SIP_FACTORY;
1820};
1821
1828class CORE_EXPORT QgsProcessingParameterCrs : public QgsProcessingParameterDefinition
1829{
1830 public:
1831
1835 QgsProcessingParameterCrs( const QString &name, const QString &description = QString(), const QVariant &defaultValue = QVariant(),
1836 bool optional = false );
1837
1841 static QString typeName() { return QStringLiteral( "crs" ); }
1842 QgsProcessingParameterDefinition *clone() const override SIP_FACTORY;
1843 QString type() const override { return typeName(); }
1844 bool checkValueIsAcceptable( const QVariant &input, QgsProcessingContext *context = nullptr ) const override;
1845 QString valueAsPythonString( const QVariant &value, QgsProcessingContext &context ) const override;
1846 QString valueAsString( const QVariant &value, QgsProcessingContext &context, bool &ok SIP_OUT ) const override;
1847 QVariant valueAsJsonObject( const QVariant &value, QgsProcessingContext &context ) const override;
1848
1852 static QgsProcessingParameterCrs *fromScriptCode( const QString &name, const QString &description, bool isOptional, const QString &definition ) SIP_FACTORY;
1853
1854};
1855
1862class CORE_EXPORT QgsProcessingParameterExtent : public QgsProcessingParameterDefinition
1863{
1864 public:
1865
1869 QgsProcessingParameterExtent( const QString &name, const QString &description = QString(), const QVariant &defaultValue = QVariant(),
1870 bool optional = false );
1871
1875 static QString typeName() { return QStringLiteral( "extent" ); }
1876 QgsProcessingParameterDefinition *clone() const override SIP_FACTORY;
1877 QString type() const override { return typeName(); }
1878 bool checkValueIsAcceptable( const QVariant &input, QgsProcessingContext *context = nullptr ) const override;
1879 QString valueAsPythonString( const QVariant &value, QgsProcessingContext &context ) const override;
1880 QString valueAsString( const QVariant &value, QgsProcessingContext &context, bool &ok SIP_OUT ) const override;
1881 QVariant valueAsJsonObject( const QVariant &value, QgsProcessingContext &context ) const override;
1882
1886 static QgsProcessingParameterExtent *fromScriptCode( const QString &name, const QString &description, bool isOptional, const QString &definition ) SIP_FACTORY;
1887
1888};
1889
1890
1897class CORE_EXPORT QgsProcessingParameterPoint : public QgsProcessingParameterDefinition
1898{
1899 public:
1900
1904 QgsProcessingParameterPoint( const QString &name, const QString &description = QString(), const QVariant &defaultValue = QVariant(),
1905 bool optional = false );
1906
1910 static QString typeName() { return QStringLiteral( "point" ); }
1911 QgsProcessingParameterDefinition *clone() const override SIP_FACTORY;
1912 QString type() const override { return typeName(); }
1913 bool checkValueIsAcceptable( const QVariant &input, QgsProcessingContext *context = nullptr ) const override;
1914 QString valueAsPythonString( const QVariant &value, QgsProcessingContext &context ) const override;
1915
1919 static QgsProcessingParameterPoint *fromScriptCode( const QString &name, const QString &description, bool isOptional, const QString &definition ) SIP_FACTORY;
1920
1921};
1922
1929class CORE_EXPORT QgsProcessingParameterGeometry : public QgsProcessingParameterDefinition
1930{
1931 public:
1932
1940 QgsProcessingParameterGeometry( const QString &name, const QString &description = QString(), const QVariant &defaultValue = QVariant(), bool optional = false, const QList< int > &geometryTypes = QList< int >(), bool allowMultipart = true );
1941
1945 static QString typeName() { return QStringLiteral( "geometry" ); }
1946 QgsProcessingParameterDefinition *clone() const override SIP_FACTORY;
1947 QString type() const override { return typeName(); }
1948 bool checkValueIsAcceptable( const QVariant &input, QgsProcessingContext *context = nullptr ) const override;
1949 QString valueAsPythonString( const QVariant &value, QgsProcessingContext &context ) const override;
1950 QString asScriptCode() const override;
1951 QString asPythonString( QgsProcessing::PythonOutputType outputType = QgsProcessing::PythonQgsProcessingAlgorithmSubclass ) const override;
1952 QVariantMap toVariantMap() const override;
1953 bool fromVariantMap( const QVariantMap &map ) override;
1954
1959 QList<int> geometryTypes() const { return mGeomTypes; }
1960
1965 void setGeometryTypes( const QList<int> &geometryTypes ) { mGeomTypes = geometryTypes; }
1966
1971 bool allowMultipart() const { return mAllowMultipart; }
1972
1977 void setAllowMultipart( bool allowMultipart ) { mAllowMultipart = allowMultipart; }
1978
1979
1980
1984 static QgsProcessingParameterGeometry *fromScriptCode( const QString &name, const QString &description, bool isOptional, const QString &definition ) SIP_FACTORY;
1985
1986 private:
1987
1988 QList<int> mGeomTypes;
1989 bool mAllowMultipart;
1990
1991};
1992
1999class CORE_EXPORT QgsProcessingParameterFile : public QgsProcessingParameterDefinition, public QgsFileFilterGenerator
2000{
2001 public:
2002
2004 enum Behavior
2005 {
2006 File = 0,
2007 Folder,
2008 };
2009
2017 QgsProcessingParameterFile( const QString &name, const QString &description = QString(), Behavior behavior = File, const QString &extension = QString(), const QVariant &defaultValue = QVariant(),
2018 bool optional = false, const QString &fileFilter = QString() );
2019
2023 static QString typeName() { return QStringLiteral( "file" ); }
2024 QgsProcessingParameterDefinition *clone() const override SIP_FACTORY;
2025 QString type() const override { return typeName(); }
2026 bool checkValueIsAcceptable( const QVariant &input, QgsProcessingContext *context = nullptr ) const override;
2027 QString asScriptCode() const override;
2028 QString asPythonString( QgsProcessing::PythonOutputType outputType = QgsProcessing::PythonQgsProcessingAlgorithmSubclass ) const override;
2029 QString createFileFilter() const override;
2030
2035 Behavior behavior() const { return mBehavior; }
2036
2041 void setBehavior( Behavior behavior ) { mBehavior = behavior; }
2042
2050 QString extension() const { return mExtension; }
2051
2061 void setExtension( const QString &extension );
2062
2069 QString fileFilter() const;
2070
2080 void setFileFilter( const QString &filter );
2081
2082 QVariantMap toVariantMap() const override;
2083 bool fromVariantMap( const QVariantMap &map ) override;
2084
2088 static QgsProcessingParameterFile *fromScriptCode( const QString &name, const QString &description, bool isOptional, const QString &definition, Behavior behavior = File ) SIP_FACTORY;
2089
2090 private:
2091
2092 Behavior mBehavior = File;
2093 QString mExtension;
2094 QString mFileFilter;
2095};
2096
2103class CORE_EXPORT QgsProcessingParameterMatrix : public QgsProcessingParameterDefinition
2104{
2105 public:
2106
2110 QgsProcessingParameterMatrix( const QString &name, const QString &description = QString(), int numberRows = 3,
2111 bool hasFixedNumberRows = false, const QStringList &headers = QStringList(),
2112 const QVariant &defaultValue = QVariant(),
2113 bool optional = false );
2114
2118 static QString typeName() { return QStringLiteral( "matrix" ); }
2119 QgsProcessingParameterDefinition *clone() const override SIP_FACTORY;
2120 QString type() const override { return typeName(); }
2121 bool checkValueIsAcceptable( const QVariant &input, QgsProcessingContext *context = nullptr ) const override;
2122 QString valueAsPythonString( const QVariant &value, QgsProcessingContext &context ) const override;
2123 QString asPythonString( QgsProcessing::PythonOutputType outputType = QgsProcessing::PythonQgsProcessingAlgorithmSubclass ) const override;
2124
2129 QStringList headers() const;
2130
2135 void setHeaders( const QStringList &headers );
2136
2143 int numberRows() const;
2144
2151 void setNumberRows( int rows );
2152
2158 bool hasFixedNumberRows() const;
2159
2165 void setHasFixedNumberRows( bool hasFixedNumberRows );
2166
2167 QVariantMap toVariantMap() const override;
2168 bool fromVariantMap( const QVariantMap &map ) override;
2169
2173 static QgsProcessingParameterMatrix *fromScriptCode( const QString &name, const QString &description, bool isOptional, const QString &definition ) SIP_FACTORY;
2174
2175 private:
2176
2177 QStringList mHeaders;
2178 int mNumberRows = 3;
2179 bool mFixedNumberRows = false;
2180
2181};
2182
2189class CORE_EXPORT QgsProcessingParameterMultipleLayers : public QgsProcessingParameterDefinition, public QgsFileFilterGenerator
2190{
2191 public:
2192
2196 QgsProcessingParameterMultipleLayers( const QString &name, const QString &description = QString(), QgsProcessing::SourceType layerType = QgsProcessing::TypeVectorAnyGeometry,
2197 const QVariant &defaultValue = QVariant(),
2198 bool optional = false );
2199
2203 static QString typeName() { return QStringLiteral( "multilayer" ); }
2204 QgsProcessingParameterDefinition *clone() const override SIP_FACTORY;
2205 QString type() const override { return typeName(); }
2206 bool checkValueIsAcceptable( const QVariant &input, QgsProcessingContext *context = nullptr ) const override;
2207 QString valueAsPythonString( const QVariant &value, QgsProcessingContext &context ) const override;
2208 QString valueAsString( const QVariant &value, QgsProcessingContext &context, bool &ok SIP_OUT ) const override;
2209 QVariant valueAsJsonObject( const QVariant &value, QgsProcessingContext &context ) const override;
2210 QString asScriptCode() const override;
2211 QString asPythonString( QgsProcessing::PythonOutputType outputType = QgsProcessing::PythonQgsProcessingAlgorithmSubclass ) const override;
2212 QString createFileFilter() const override;
2213
2218 QgsProcessing::SourceType layerType() const;
2219
2224 void setLayerType( QgsProcessing::SourceType type );
2225
2231 int minimumNumberInputs() const;
2232
2238 void setMinimumNumberInputs( int minimum );
2239
2240 QVariantMap toVariantMap() const override;
2241 bool fromVariantMap( const QVariantMap &map ) override;
2242
2246 static QgsProcessingParameterMultipleLayers *fromScriptCode( const QString &name, const QString &description, bool isOptional, const QString &definition ) SIP_FACTORY;
2247
2248 private:
2249
2250 QgsProcessing::SourceType mLayerType = QgsProcessing::TypeVectorAnyGeometry;
2251 int mMinimumNumberInputs = 0;
2252
2253};
2254
2273class CORE_EXPORT QgsProcessingParameterNumber : public QgsProcessingParameterDefinition
2274{
2275 public:
2276
2278 enum Type
2279 {
2280 Integer,
2281 Double,
2282 };
2283
2287 explicit QgsProcessingParameterNumber( const QString &name, const QString &description = QString(),
2288 Type type = Integer,
2289 const QVariant &defaultValue = QVariant(),
2290 bool optional = false,
2291 double minValue = std::numeric_limits<double>::lowest() + 1,
2292 double maxValue = std::numeric_limits<double>::max()
2293 );
2294
2298 static QString typeName() { return QStringLiteral( "number" ); }
2299 QgsProcessingParameterDefinition *clone() const override SIP_FACTORY;
2300 QString type() const override { return typeName(); }
2301 bool checkValueIsAcceptable( const QVariant &input, QgsProcessingContext *context = nullptr ) const override;
2302 QString valueAsPythonString( const QVariant &value, QgsProcessingContext &context ) const override;
2303 QString toolTip() const override;
2304 QString asPythonString( QgsProcessing::PythonOutputType outputType = QgsProcessing::PythonQgsProcessingAlgorithmSubclass ) const override;
2305
2310 double minimum() const;
2311
2316 void setMinimum( double minimum );
2317
2322 double maximum() const;
2323
2328 void setMaximum( double maximum );
2329
2334 Type dataType() const;
2335
2340 void setDataType( Type type );
2341
2342 QVariantMap toVariantMap() const override;
2343 bool fromVariantMap( const QVariantMap &map ) override;
2344
2348 static QgsProcessingParameterNumber *fromScriptCode( const QString &name, const QString &description, bool isOptional, const QString &definition ) SIP_FACTORY;
2349
2350 private:
2351
2352 double mMin = std::numeric_limits<double>::lowest() + 1;
2353 double mMax = std::numeric_limits<double>::max();
2354 Type mDataType = Integer;
2355};
2356
2376class CORE_EXPORT QgsProcessingParameterDistance : public QgsProcessingParameterNumber
2377{
2378 public:
2379
2383 explicit QgsProcessingParameterDistance( const QString &name, const QString &description = QString(),
2384 const QVariant &defaultValue = QVariant(),
2385 const QString &parentParameterName = QString(),
2386 bool optional = false,
2387 double minValue = std::numeric_limits<double>::lowest() + 1,
2388 double maxValue = std::numeric_limits<double>::max() );
2389
2393 static QString typeName() { return QStringLiteral( "distance" ); }
2394
2395 QgsProcessingParameterDistance *clone() const override SIP_FACTORY;
2396
2397 QString type() const override;
2398 QStringList dependsOnOtherParameters() const override;
2399 QString asPythonString( QgsProcessing::PythonOutputType outputType = QgsProcessing::PythonQgsProcessingAlgorithmSubclass ) const override;
2400
2405 QString parentParameterName() const;
2406
2411 void setParentParameterName( const QString &parentParameterName );
2412
2419 Qgis::DistanceUnit defaultUnit() const { return mDefaultUnit; }
2420
2427 void setDefaultUnit( Qgis::DistanceUnit unit ) { mDefaultUnit = unit; }
2428
2429 QVariantMap toVariantMap() const override;
2430 bool fromVariantMap( const QVariantMap &map ) override;
2431
2432 private:
2433
2434 QString mParentParameterName;
2435 Qgis::DistanceUnit mDefaultUnit = Qgis::DistanceUnit::Unknown;
2436
2437};
2438
2446class CORE_EXPORT QgsProcessingParameterDuration : public QgsProcessingParameterNumber
2447{
2448 public:
2449
2453 explicit QgsProcessingParameterDuration( const QString &name, const QString &description = QString(),
2454 const QVariant &defaultValue = QVariant(),
2455 bool optional = false,
2456 double minValue = std::numeric_limits<double>::lowest() + 1,
2457 double maxValue = std::numeric_limits<double>::max() );
2458
2462 static QString typeName() { return QStringLiteral( "duration" ); }
2463
2464 QgsProcessingParameterDuration *clone() const override SIP_FACTORY;
2465
2466 QString type() const override;
2467 QString asPythonString( QgsProcessing::PythonOutputType outputType = QgsProcessing::PythonQgsProcessingAlgorithmSubclass ) const override;
2468
2474 Qgis::TemporalUnit defaultUnit() const { return mDefaultUnit; }
2475
2481 void setDefaultUnit( Qgis::TemporalUnit unit ) { mDefaultUnit = unit; }
2482
2483 QVariantMap toVariantMap() const override;
2484 bool fromVariantMap( const QVariantMap &map ) override;
2485
2486 private:
2487
2488 Qgis::TemporalUnit mDefaultUnit = Qgis::TemporalUnit::Milliseconds;
2489
2490};
2491
2502class CORE_EXPORT QgsProcessingParameterScale : public QgsProcessingParameterNumber
2503{
2504 public:
2505
2509 explicit QgsProcessingParameterScale( const QString &name, const QString &description = QString(),
2510 const QVariant &defaultValue = QVariant(),
2511 bool optional = false );
2512
2516 static QString typeName() { return QStringLiteral( "scale" ); }
2517
2518 QgsProcessingParameterScale *clone() const override SIP_FACTORY;
2519
2520 QString type() const override;
2521 QString asPythonString( QgsProcessing::PythonOutputType outputType = QgsProcessing::PythonQgsProcessingAlgorithmSubclass ) const override;
2522
2526 static QgsProcessingParameterScale *fromScriptCode( const QString &name, const QString &description, bool isOptional, const QString &definition ) SIP_FACTORY;
2527
2528};
2529
2536class CORE_EXPORT QgsProcessingParameterRange : public QgsProcessingParameterDefinition
2537{
2538 public:
2539
2543 QgsProcessingParameterRange( const QString &name, const QString &description = QString(),
2544 QgsProcessingParameterNumber::Type type = QgsProcessingParameterNumber::Integer,
2545 const QVariant &defaultValue = QVariant(),
2546 bool optional = false );
2547
2551 static QString typeName() { return QStringLiteral( "range" ); }
2552 QgsProcessingParameterDefinition *clone() const override SIP_FACTORY;
2553 QString type() const override { return typeName(); }
2554 bool checkValueIsAcceptable( const QVariant &input, QgsProcessingContext *context = nullptr ) const override;
2555 QString valueAsPythonString( const QVariant &value, QgsProcessingContext &context ) const override;
2556 QString asPythonString( QgsProcessing::PythonOutputType outputType = QgsProcessing::PythonQgsProcessingAlgorithmSubclass ) const override;
2557
2562 QgsProcessingParameterNumber::Type dataType() const;
2563
2568 void setDataType( QgsProcessingParameterNumber::Type dataType );
2569
2570 QVariantMap toVariantMap() const override;
2571 bool fromVariantMap( const QVariantMap &map ) override;
2572
2576 static QgsProcessingParameterRange *fromScriptCode( const QString &name, const QString &description, bool isOptional, const QString &definition ) SIP_FACTORY;
2577
2578 private:
2579
2580 QgsProcessingParameterNumber::Type mDataType = QgsProcessingParameterNumber::Integer;
2581};
2582
2589class CORE_EXPORT QgsProcessingParameterRasterLayer : public QgsProcessingParameterDefinition, public QgsFileFilterGenerator
2590{
2591 public:
2592
2596 QgsProcessingParameterRasterLayer( const QString &name, const QString &description = QString(), const QVariant &defaultValue = QVariant(),
2597 bool optional = false );
2598
2602 static QString typeName() { return QStringLiteral( "raster" ); }
2603 QgsProcessingParameterDefinition *clone() const override SIP_FACTORY;
2604 QString type() const override { return typeName(); }
2605 bool checkValueIsAcceptable( const QVariant &input, QgsProcessingContext *context = nullptr ) const override;
2606 QString valueAsPythonString( const QVariant &value, QgsProcessingContext &context ) const override;
2607 QString valueAsString( const QVariant &value, QgsProcessingContext &context, bool &ok SIP_OUT ) const override;
2608 QVariant valueAsJsonObject( const QVariant &value, QgsProcessingContext &context ) const override;
2609 QString createFileFilter() const override;
2610
2614 static QgsProcessingParameterRasterLayer *fromScriptCode( const QString &name, const QString &description, bool isOptional, const QString &definition ) SIP_FACTORY;
2615
2616};
2617
2636class CORE_EXPORT QgsProcessingParameterEnum : public QgsProcessingParameterDefinition
2637{
2638 public:
2639
2643 QgsProcessingParameterEnum( const QString &name, const QString &description = QString(), const QStringList &options = QStringList(),
2644 bool allowMultiple = false,
2645 const QVariant &defaultValue = QVariant(),
2646 bool optional = false,
2647 bool usesStaticStrings = false );
2648
2652 static QString typeName() { return QStringLiteral( "enum" ); }
2653 QgsProcessingParameterDefinition *clone() const override SIP_FACTORY;
2654 QString type() const override { return typeName(); }
2655 bool checkValueIsAcceptable( const QVariant &input, QgsProcessingContext *context = nullptr ) const override;
2656 QString valueAsPythonString( const QVariant &value, QgsProcessingContext &context ) const override;
2657 QString valueAsPythonComment( const QVariant &value, QgsProcessingContext &context ) const override;
2658 QString asScriptCode() const override;
2659 QString asPythonString( QgsProcessing::PythonOutputType outputType = QgsProcessing::PythonQgsProcessingAlgorithmSubclass ) const override;
2660
2665 QStringList options() const;
2666
2671 void setOptions( const QStringList &options );
2672
2677 bool allowMultiple() const;
2678
2683 void setAllowMultiple( bool allowMultiple );
2684
2691 bool usesStaticStrings() const;
2692
2699 void setUsesStaticStrings( bool usesStaticStrings );
2700
2701 QVariantMap toVariantMap() const override;
2702 bool fromVariantMap( const QVariantMap &map ) override;
2703
2707 static QgsProcessingParameterEnum *fromScriptCode( const QString &name, const QString &description, bool isOptional, const QString &definition ) SIP_FACTORY;
2708
2709 private:
2710
2711 QStringList mOptions;
2712 bool mAllowMultiple = false;
2713 bool mUsesStaticStrings = false;
2714};
2715
2743class CORE_EXPORT QgsProcessingParameterString : public QgsProcessingParameterDefinition
2744{
2745 public:
2746
2750 QgsProcessingParameterString( const QString &name, const QString &description = QString(), const QVariant &defaultValue = QVariant(),
2751 bool multiLine = false,
2752 bool optional = false );
2753
2757 static QString typeName() { return QStringLiteral( "string" ); }
2758 QgsProcessingParameterDefinition *clone() const override SIP_FACTORY;
2759 QString type() const override { return typeName(); }
2760 QString valueAsPythonString( const QVariant &value, QgsProcessingContext &context ) const override;
2761 QString asScriptCode() const override;
2762 QString asPythonString( QgsProcessing::PythonOutputType outputType = QgsProcessing::PythonQgsProcessingAlgorithmSubclass ) const override;
2763
2768 bool multiLine() const;
2769
2774 void setMultiLine( bool multiLine );
2775
2776 QVariantMap toVariantMap() const override;
2777 bool fromVariantMap( const QVariantMap &map ) override;
2778
2782 static QgsProcessingParameterString *fromScriptCode( const QString &name, const QString &description, bool isOptional, const QString &definition ) SIP_FACTORY;
2783
2784 private:
2785
2786 bool mMultiLine = false;
2787
2788};
2789
2790
2803class CORE_EXPORT QgsProcessingParameterAuthConfig : public QgsProcessingParameterDefinition
2804{
2805 public:
2806
2810 QgsProcessingParameterAuthConfig( const QString &name, const QString &description = QString(), const QVariant &defaultValue = QVariant(),
2811 bool optional = false );
2812
2816 static QString typeName() { return QStringLiteral( "authcfg" ); }
2817 QgsProcessingParameterDefinition *clone() const override SIP_FACTORY;
2818 QString type() const override { return typeName(); }
2819 QString valueAsPythonString( const QVariant &value, QgsProcessingContext &context ) const override;
2820 QString asScriptCode() const override;
2821
2825 static QgsProcessingParameterAuthConfig *fromScriptCode( const QString &name, const QString &description, bool isOptional, const QString &definition ) SIP_FACTORY;
2826
2827};
2828
2835class CORE_EXPORT QgsProcessingParameterExpression : public QgsProcessingParameterDefinition
2836{
2837 public:
2838
2842 QgsProcessingParameterExpression( const QString &name, const QString &description = QString(), const QVariant &defaultValue = QVariant(),
2843 const QString &parentLayerParameterName = QString(),
2844 bool optional = false, Qgis::ExpressionType type = Qgis::ExpressionType::Qgis );
2845
2849 static QString typeName() { return QStringLiteral( "expression" ); }
2850 QgsProcessingParameterDefinition *clone() const override SIP_FACTORY;
2851 QString type() const override { return typeName(); }
2852 QString valueAsPythonString( const QVariant &value, QgsProcessingContext &context ) const override;
2853 QStringList dependsOnOtherParameters() const override;
2854 QString asPythonString( QgsProcessing::PythonOutputType outputType = QgsProcessing::PythonQgsProcessingAlgorithmSubclass ) const override;
2855
2860 QString parentLayerParameterName() const;
2861
2866 void setParentLayerParameterName( const QString &parentLayerParameterName );
2867
2874 Qgis::ExpressionType expressionType() const;
2875
2882 void setExpressionType( Qgis::ExpressionType type );
2883
2884 QVariantMap toVariantMap() const override;
2885 bool fromVariantMap( const QVariantMap &map ) override;
2886
2890 static QgsProcessingParameterExpression *fromScriptCode( const QString &name, const QString &description, bool isOptional, const QString &definition ) SIP_FACTORY;
2891
2892 private:
2893
2894 QString mParentLayerParameterName;
2895 Qgis::ExpressionType mExpressionType = Qgis::ExpressionType::Qgis;
2896};
2897
2898
2905class CORE_EXPORT QgsProcessingParameterLimitedDataTypes
2906{
2907 public:
2908
2912 QgsProcessingParameterLimitedDataTypes( const QList< int > &types = QList< int >() );
2913
2918 QList< int > dataTypes() const;
2919
2924 void setDataTypes( const QList< int > &types );
2925
2926 protected:
2927
2929 QList< int > mDataTypes;
2930};
2931
2939class CORE_EXPORT QgsProcessingParameterVectorLayer : public QgsProcessingParameterDefinition, public QgsProcessingParameterLimitedDataTypes, public QgsFileFilterGenerator
2940{
2941 public:
2942
2946 QgsProcessingParameterVectorLayer( const QString &name,
2947 const QString &description = QString(),
2948 const QList< int > &types = QList< int >(),
2949 const QVariant &defaultValue = QVariant(),
2950 bool optional = false );
2951
2955 static QString typeName() { return QStringLiteral( "vector" ); }
2956 QgsProcessingParameterDefinition *clone() const override SIP_FACTORY;
2957 QString type() const override { return typeName(); }
2958 bool checkValueIsAcceptable( const QVariant &input, QgsProcessingContext *context = nullptr ) const override;
2959 QString valueAsPythonString( const QVariant &value, QgsProcessingContext &context ) const override;
2960 QString valueAsString( const QVariant &value, QgsProcessingContext &context, bool &ok SIP_OUT ) const override;
2961 QVariant valueAsJsonObject( const QVariant &value, QgsProcessingContext &context ) const override;
2962 QString asPythonString( QgsProcessing::PythonOutputType outputType = QgsProcessing::PythonQgsProcessingAlgorithmSubclass ) const override;
2963 QString createFileFilter() const override;
2964
2965 QVariantMap toVariantMap() const override;
2966 bool fromVariantMap( const QVariantMap &map ) override;
2967
2971 static QgsProcessingParameterVectorLayer *fromScriptCode( const QString &name, const QString &description, bool isOptional, const QString &definition ) SIP_FACTORY;
2972
2973};
2974
2981class CORE_EXPORT QgsProcessingParameterMeshLayer : public QgsProcessingParameterDefinition, public QgsFileFilterGenerator
2982{
2983 public:
2984
2988 QgsProcessingParameterMeshLayer( const QString &name,
2989 const QString &description = QString(),
2990 const QVariant &defaultValue = QVariant(),
2991 bool optional = false );
2992
2996 static QString typeName() { return QStringLiteral( "mesh" ); }
2997 QgsProcessingParameterDefinition *clone() const override SIP_FACTORY;
2998 QString type() const override { return typeName(); }
2999 bool checkValueIsAcceptable( const QVariant &input, QgsProcessingContext *context = nullptr ) const override;
3000 QString valueAsPythonString( const QVariant &value, QgsProcessingContext &context ) const override;
3001 QString valueAsString( const QVariant &value, QgsProcessingContext &context, bool &ok SIP_OUT ) const override;
3002 QVariant valueAsJsonObject( const QVariant &value, QgsProcessingContext &context ) const override;
3003 QString createFileFilter() const override;
3004
3008 static QgsProcessingParameterMeshLayer *fromScriptCode( const QString &name, const QString &description, bool isOptional, const QString &definition ) SIP_FACTORY;
3009};
3010
3017class CORE_EXPORT QgsProcessingParameterMapLayer : public QgsProcessingParameterDefinition, public QgsProcessingParameterLimitedDataTypes, public QgsFileFilterGenerator
3018{
3019 public:
3020
3024 QgsProcessingParameterMapLayer( const QString &name, const QString &description = QString(), const QVariant &defaultValue = QVariant(),
3025 bool optional = false,
3026 const QList< int > &types = QList< int >() );
3027
3031 static QString typeName() { return QStringLiteral( "layer" ); }
3032 QgsProcessingParameterDefinition *clone() const override SIP_FACTORY;
3033 QString type() const override { return typeName(); }
3034 bool checkValueIsAcceptable( const QVariant &input, QgsProcessingContext *context = nullptr ) const override;
3035 QString valueAsPythonString( const QVariant &value, QgsProcessingContext &context ) const override;
3036 QString valueAsString( const QVariant &value, QgsProcessingContext &context, bool &ok SIP_OUT ) const override;
3037 QVariant valueAsJsonObject( const QVariant &value, QgsProcessingContext &context ) const override;
3038 QString asScriptCode() const override;
3039 QString asPythonString( QgsProcessing::PythonOutputType outputType = QgsProcessing::PythonQgsProcessingAlgorithmSubclass ) const override;
3040 QString createFileFilter() const override;
3041
3042 QVariantMap toVariantMap() const override;
3043 bool fromVariantMap( const QVariantMap &map ) override;
3044
3048 static QgsProcessingParameterMapLayer *fromScriptCode( const QString &name, const QString &description, bool isOptional, const QString &definition ) SIP_FACTORY;
3049
3050};
3051
3058class CORE_EXPORT QgsProcessingParameterField : public QgsProcessingParameterDefinition
3059{
3060 public:
3061
3063 enum DataType
3064 {
3065 Any = -1,
3066 Numeric = 0,
3067 String = 1,
3068 DateTime = 2,
3069 Binary = 3,
3070 Boolean = 4,
3071 };
3072
3076 QgsProcessingParameterField( const QString &name, const QString &description = QString(), const QVariant &defaultValue = QVariant(),
3077 const QString &parentLayerParameterName = QString(),
3078 DataType type = Any,
3079 bool allowMultiple = false,
3080 bool optional = false,
3081 bool defaultToAllFields = false );
3082
3086 static QString typeName() { return QStringLiteral( "field" ); }
3087 QgsProcessingParameterDefinition *clone() const override SIP_FACTORY;
3088 QString type() const override { return typeName(); }
3089 bool checkValueIsAcceptable( const QVariant &input, QgsProcessingContext *context = nullptr ) const override;
3090 QString valueAsPythonString( const QVariant &value, QgsProcessingContext &context ) const override;
3091 QString asScriptCode() const override;
3092 QString asPythonString( QgsProcessing::PythonOutputType outputType = QgsProcessing::PythonQgsProcessingAlgorithmSubclass ) const override;
3093 QStringList dependsOnOtherParameters() const override;
3094
3099 QString parentLayerParameterName() const;
3100
3105 void setParentLayerParameterName( const QString &parentLayerParameterName );
3106
3111 DataType dataType() const;
3112
3117 void setDataType( DataType type );
3118
3123 bool allowMultiple() const;
3124
3129 void setAllowMultiple( bool allowMultiple );
3130
3140 bool defaultToAllFields() const;
3141
3151 void setDefaultToAllFields( bool enabled );
3152
3153 QVariantMap toVariantMap() const override;
3154 bool fromVariantMap( const QVariantMap &map ) override;
3155
3159 static QgsProcessingParameterField *fromScriptCode( const QString &name, const QString &description, bool isOptional, const QString &definition ) SIP_FACTORY;
3160
3161 private:
3162
3163 QString mParentLayerParameterName;
3164 DataType mDataType = Any;
3165 bool mAllowMultiple = false;
3166 bool mDefaultToAllFields = false;
3167
3168};
3169
3170
3177class CORE_EXPORT QgsProcessingParameterFeatureSource : public QgsProcessingParameterDefinition, public QgsProcessingParameterLimitedDataTypes, public QgsFileFilterGenerator
3178{
3179 public:
3180
3184 QgsProcessingParameterFeatureSource( const QString &name, const QString &description = QString(),
3185 const QList< int > &types = QList< int >(),
3186 const QVariant &defaultValue = QVariant(), bool optional = false );
3187
3191 static QString typeName() { return QStringLiteral( "source" ); }
3192 QgsProcessingParameterDefinition *clone() const override SIP_FACTORY;
3193 QString type() const override { return typeName(); }
3194 bool checkValueIsAcceptable( const QVariant &input, QgsProcessingContext *context = nullptr ) const override;
3195 QString valueAsPythonString( const QVariant &value, QgsProcessingContext &context ) const override;
3196 QString valueAsString( const QVariant &value, QgsProcessingContext &context, bool &ok SIP_OUT ) const override;
3197 QVariant valueAsJsonObject( const QVariant &value, QgsProcessingContext &context ) const override;
3198 QString asScriptCode() const override;
3199 QString asPythonString( QgsProcessing::PythonOutputType outputType = QgsProcessing::PythonQgsProcessingAlgorithmSubclass ) const override;
3200 QString createFileFilter() const override;
3201
3202 QVariantMap toVariantMap() const override;
3203 bool fromVariantMap( const QVariantMap &map ) override;
3204
3208 static QgsProcessingParameterFeatureSource *fromScriptCode( const QString &name, const QString &description, bool isOptional, const QString &definition ) SIP_FACTORY;
3209
3210};
3211
3219class CORE_EXPORT QgsProcessingDestinationParameter : public QgsProcessingParameterDefinition, public QgsFileFilterGenerator
3220{
3221 public:
3222
3229 QgsProcessingDestinationParameter( const QString &name, const QString &description = QString(), const QVariant &defaultValue = QVariant(),
3230 bool optional = false, bool createByDefault = true );
3231
3232 bool isDestination() const override { return true; }
3233 QVariantMap toVariantMap() const override;
3234 bool fromVariantMap( const QVariantMap &map ) override;
3235 QString asPythonString( QgsProcessing::PythonOutputType outputType = QgsProcessing::PythonQgsProcessingAlgorithmSubclass ) const override;
3236 QString createFileFilter() const override;
3237
3242 virtual QgsProcessingOutputDefinition *toOutputDefinition() const = 0 SIP_FACTORY;
3243
3249 bool supportsNonFileBasedOutput() const { return mSupportsNonFileBasedOutputs; }
3250
3256 void setSupportsNonFileBasedOutput( bool supportsNonFileBasedOutput ) { mSupportsNonFileBasedOutputs = supportsNonFileBasedOutput; }
3257
3262 virtual QString defaultFileExtension() const = 0;
3263
3269 virtual QString generateTemporaryDestination( const QgsProcessingContext *context = nullptr ) const;
3270
3285 virtual bool isSupportedOutputValue( const QVariant &value, QgsProcessingContext &context, QString &error SIP_OUT ) const;
3286
3292 bool createByDefault() const;
3293
3299 void setCreateByDefault( bool createByDefault );
3300
3301 protected:
3302
3311 QgsProcessingProvider *originalProvider() const { return mOriginalProvider; }
3312
3313 private:
3314
3322 QgsProcessingProvider *mOriginalProvider = nullptr;
3323
3324 bool mSupportsNonFileBasedOutputs = true;
3325 bool mCreateByDefault = true;
3326
3327 friend class QgsProcessingModelAlgorithm;
3328 friend class TestQgsProcessing;
3329 friend class TestQgsProcessingModelAlgorithm;
3330};
3331
3332
3341class CORE_EXPORT QgsProcessingParameterFeatureSink : public QgsProcessingDestinationParameter
3342{
3343 public:
3344
3351 QgsProcessingParameterFeatureSink( const QString &name, const QString &description = QString(), QgsProcessing::SourceType type = QgsProcessing::TypeVectorAnyGeometry, const QVariant &defaultValue = QVariant(),
3352 bool optional = false, bool createByDefault = true, bool supportsAppend = false );
3353
3357 static QString typeName() { return QStringLiteral( "sink" ); }
3358 QgsProcessingParameterDefinition *clone() const override SIP_FACTORY;
3359 QString type() const override { return typeName(); }
3360 bool checkValueIsAcceptable( const QVariant &input, QgsProcessingContext *context = nullptr ) const override;
3361 QString valueAsPythonString( const QVariant &value, QgsProcessingContext &context ) const override;
3362 QString asScriptCode() const override;
3363 QgsProcessingOutputDefinition *toOutputDefinition() const override SIP_FACTORY;
3364 QString defaultFileExtension() const override;
3365 QString asPythonString( QgsProcessing::PythonOutputType outputType = QgsProcessing::PythonQgsProcessingAlgorithmSubclass ) const override;
3366 QString createFileFilter() const override;
3367
3373 virtual QStringList supportedOutputVectorLayerExtensions() const;
3374
3379 QgsProcessing::SourceType dataType() const;
3380
3385 bool hasGeometry() const;
3386
3391 void setDataType( QgsProcessing::SourceType type );
3392
3401 bool supportsAppend() const;
3402
3411 void setSupportsAppend( bool supportsAppend );
3412
3413 QVariantMap toVariantMap() const override;
3414 bool fromVariantMap( const QVariantMap &map ) override;
3415 QString generateTemporaryDestination( const QgsProcessingContext *context = nullptr ) const override;
3416
3420 static QgsProcessingParameterFeatureSink *fromScriptCode( const QString &name, const QString &description, bool isOptional, const QString &definition ) SIP_FACTORY;
3421
3422 private:
3423
3424 QgsProcessing::SourceType mDataType = QgsProcessing::TypeVectorAnyGeometry;
3425 bool mSupportsAppend = false;
3426};
3427
3428
3439class CORE_EXPORT QgsProcessingParameterVectorDestination : public QgsProcessingDestinationParameter
3440{
3441 public:
3442
3449 QgsProcessingParameterVectorDestination( const QString &name, const QString &description = QString(), QgsProcessing::SourceType type = QgsProcessing::TypeVectorAnyGeometry, const QVariant &defaultValue = QVariant(),
3450 bool optional = false, bool createByDefault = true );
3451
3455 static QString typeName() { return QStringLiteral( "vectorDestination" ); }
3456 QgsProcessingParameterDefinition *clone() const override SIP_FACTORY;
3457 QString type() const override { return typeName(); }
3458 bool checkValueIsAcceptable( const QVariant &input, QgsProcessingContext *context = nullptr ) const override;
3459 QString valueAsPythonString( const QVariant &value, QgsProcessingContext &context ) const override;
3460 QString asScriptCode() const override;
3461 QgsProcessingOutputDefinition *toOutputDefinition() const override SIP_FACTORY;
3462 QString defaultFileExtension() const override;
3463 QString asPythonString( QgsProcessing::PythonOutputType outputType = QgsProcessing::PythonQgsProcessingAlgorithmSubclass ) const override;
3464 QString createFileFilter() const override;
3465
3471 virtual QStringList supportedOutputVectorLayerExtensions() const;
3472
3477 QgsProcessing::SourceType dataType() const;
3478
3483 bool hasGeometry() const;
3484
3489 void setDataType( QgsProcessing::SourceType type );
3490
3491 QVariantMap toVariantMap() const override;
3492 bool fromVariantMap( const QVariantMap &map ) override;
3493
3497 static QgsProcessingParameterVectorDestination *fromScriptCode( const QString &name, const QString &description, bool isOptional, const QString &definition ) SIP_FACTORY;
3498
3499
3500 private:
3501
3502 QgsProcessing::SourceType mDataType = QgsProcessing::TypeVectorAnyGeometry;
3503};
3504
3512class CORE_EXPORT QgsProcessingParameterRasterDestination : public QgsProcessingDestinationParameter
3513{
3514 public:
3515
3522 QgsProcessingParameterRasterDestination( const QString &name, const QString &description = QString(),
3523 const QVariant &defaultValue = QVariant(),
3524 bool optional = false,
3525 bool createByDefault = true );
3526
3530 static QString typeName() { return QStringLiteral( "rasterDestination" ); }
3531 QgsProcessingParameterDefinition *clone() const override SIP_FACTORY;
3532 QString type() const override { return typeName(); }
3533 bool checkValueIsAcceptable( const QVariant &input, QgsProcessingContext *context = nullptr ) const override;
3534 QString valueAsPythonString( const QVariant &value, QgsProcessingContext &context ) const override;
3535 QgsProcessingOutputDefinition *toOutputDefinition() const override SIP_FACTORY;
3536 QString defaultFileExtension() const override;
3537 QString createFileFilter() const override;
3538
3544 virtual QStringList supportedOutputRasterLayerExtensions() const;
3545
3549 static QgsProcessingParameterRasterDestination *fromScriptCode( const QString &name, const QString &description, bool isOptional, const QString &definition ) SIP_FACTORY;
3550};
3551
3573class CORE_EXPORT QgsProcessingParameterFileDestination : public QgsProcessingDestinationParameter
3574{
3575 public:
3576
3583 QgsProcessingParameterFileDestination( const QString &name, const QString &description = QString(),
3584 const QString &fileFilter = QString(),
3585 const QVariant &defaultValue = QVariant(),
3586 bool optional = false,
3587 bool createByDefault = true );
3588
3592 static QString typeName() { return QStringLiteral( "fileDestination" ); }
3593 QgsProcessingParameterDefinition *clone() const override SIP_FACTORY;
3594 QString type() const override { return typeName(); }
3595 bool checkValueIsAcceptable( const QVariant &input, QgsProcessingContext *context = nullptr ) const override;
3596 QString valueAsPythonString( const QVariant &value, QgsProcessingContext &context ) const override;
3597 QgsProcessingOutputDefinition *toOutputDefinition() const override SIP_FACTORY;
3598 QString defaultFileExtension() const override;
3599 QString asPythonString( QgsProcessing::PythonOutputType outputType = QgsProcessing::PythonQgsProcessingAlgorithmSubclass ) const override;
3600 QString createFileFilter() const override;
3601
3606 QString fileFilter() const;
3607
3612 void setFileFilter( const QString &filter );
3613
3614 QVariantMap toVariantMap() const override;
3615 bool fromVariantMap( const QVariantMap &map ) override;
3616
3620 static QgsProcessingParameterFileDestination *fromScriptCode( const QString &name, const QString &description, bool isOptional, const QString &definition ) SIP_FACTORY;
3621
3622
3623 private:
3624
3625 QString mFileFilter;
3626};
3627
3635class CORE_EXPORT QgsProcessingParameterFolderDestination : public QgsProcessingDestinationParameter
3636{
3637 public:
3638
3642 QgsProcessingParameterFolderDestination( const QString &name, const QString &description = QString(),
3643 const QVariant &defaultValue = QVariant(),
3644 bool optional = false,
3645 bool createByDefault = true );
3646
3650 static QString typeName() { return QStringLiteral( "folderDestination" ); }
3651 QgsProcessingParameterDefinition *clone() const override SIP_FACTORY;
3652 QString type() const override { return typeName(); }
3653 bool checkValueIsAcceptable( const QVariant &input, QgsProcessingContext *context = nullptr ) const override;
3654 QgsProcessingOutputDefinition *toOutputDefinition() const override SIP_FACTORY;
3655 QString defaultFileExtension() const override;
3656
3660 static QgsProcessingParameterFolderDestination *fromScriptCode( const QString &name, const QString &description, bool isOptional, const QString &definition ) SIP_FACTORY;
3661
3662};
3663
3670class CORE_EXPORT QgsProcessingParameterBand : public QgsProcessingParameterDefinition
3671{
3672 public:
3673
3677 QgsProcessingParameterBand( const QString &name, const QString &description = QString(), const QVariant &defaultValue = QVariant(),
3678 const QString &parentLayerParameterName = QString(),
3679 bool optional = false,
3680 bool allowMultiple = false );
3681
3685 static QString typeName() { return QStringLiteral( "band" ); }
3686 QgsProcessingParameterDefinition *clone() const override SIP_FACTORY;
3687 QString type() const override { return typeName(); }
3688 bool checkValueIsAcceptable( const QVariant &input, QgsProcessingContext *context = nullptr ) const override;
3689 QString valueAsPythonString( const QVariant &value, QgsProcessingContext &context ) const override;
3690 QString asScriptCode() const override;
3691 QStringList dependsOnOtherParameters() const override;
3692 QString asPythonString( QgsProcessing::PythonOutputType outputType = QgsProcessing::PythonQgsProcessingAlgorithmSubclass ) const override;
3693
3698 QString parentLayerParameterName() const;
3699
3704 void setParentLayerParameterName( const QString &parentLayerParameterName );
3705
3706 QVariantMap toVariantMap() const override;
3707 bool fromVariantMap( const QVariantMap &map ) override;
3708
3712 static QgsProcessingParameterBand *fromScriptCode( const QString &name, const QString &description, bool isOptional, const QString &definition ) SIP_FACTORY;
3713
3719 bool allowMultiple() const;
3720
3726 void setAllowMultiple( bool allowMultiple );
3727
3728 private:
3729
3730 QString mParentLayerParameterName;
3731 bool mAllowMultiple = false;
3732};
3733
3745class CORE_EXPORT QgsProcessingParameterLayout : public QgsProcessingParameterDefinition
3746{
3747 public:
3748
3752 QgsProcessingParameterLayout( const QString &name, const QString &description = QString(), const QVariant &defaultValue = QVariant(),
3753 bool optional = false );
3754
3758 static QString typeName() { return QStringLiteral( "layout" ); }
3759 QgsProcessingParameterDefinition *clone() const override SIP_FACTORY;
3760 QString type() const override { return typeName(); }
3761 QString valueAsPythonString( const QVariant &value, QgsProcessingContext &context ) const override;
3762 QString asScriptCode() const override;
3763 QString asPythonString( QgsProcessing::PythonOutputType outputType = QgsProcessing::PythonQgsProcessingAlgorithmSubclass ) const override;
3764
3768 static QgsProcessingParameterLayout *fromScriptCode( const QString &name, const QString &description, bool isOptional, const QString &definition ) SIP_FACTORY;
3769
3770};
3771
3783class CORE_EXPORT QgsProcessingParameterLayoutItem : public QgsProcessingParameterDefinition
3784{
3785 public:
3786
3790 QgsProcessingParameterLayoutItem( const QString &name, const QString &description = QString(), const QVariant &defaultValue = QVariant(),
3791 const QString &parentLayoutParameterName = QString(),
3792 int itemType = -1,
3793 bool optional = false );
3794
3798 static QString typeName() { return QStringLiteral( "layoutitem" ); }
3799 QgsProcessingParameterDefinition *clone() const override SIP_FACTORY;
3800 QString type() const override { return typeName(); }
3801 QString valueAsPythonString( const QVariant &value, QgsProcessingContext &context ) const override;
3802 QString asScriptCode() const override;
3803 QString asPythonString( QgsProcessing::PythonOutputType outputType = QgsProcessing::PythonQgsProcessingAlgorithmSubclass ) const override;
3804 QVariantMap toVariantMap() const override;
3805 bool fromVariantMap( const QVariantMap &map ) override;
3806 QStringList dependsOnOtherParameters() const override;
3807
3811 static QgsProcessingParameterLayoutItem *fromScriptCode( const QString &name, const QString &description, bool isOptional, const QString &definition ) SIP_FACTORY;
3812
3817 QString parentLayoutParameterName() const;
3818
3823 void setParentLayoutParameterName( const QString &name );
3824
3832 int itemType() const;
3833
3841 void setItemType( int type );
3842
3843 private:
3844 QString mParentLayoutParameterName;
3845 int mItemType = -1;
3846};
3847
3857class CORE_EXPORT QgsProcessingParameterColor : public QgsProcessingParameterDefinition
3858{
3859 public:
3860
3866 QgsProcessingParameterColor( const QString &name, const QString &description = QString(), const QVariant &defaultValue = QVariant(),
3867 bool opacityEnabled = true,
3868 bool optional = false );
3869
3873 static QString typeName() { return QStringLiteral( "color" ); }
3874 QgsProcessingParameterDefinition *clone() const override SIP_FACTORY;
3875 QString type() const override { return typeName(); }
3876 QString valueAsPythonString( const QVariant &value, QgsProcessingContext &context ) const override;
3877 QString asScriptCode() const override;
3878 QString asPythonString( QgsProcessing::PythonOutputType outputType = QgsProcessing::PythonQgsProcessingAlgorithmSubclass ) const override;
3879 bool checkValueIsAcceptable( const QVariant &input, QgsProcessingContext *context = nullptr ) const override;
3880 QVariantMap toVariantMap() const override;
3881 bool fromVariantMap( const QVariantMap &map ) override;
3882
3889 bool opacityEnabled() const;
3890
3898 void setOpacityEnabled( bool enabled );
3899
3903 static QgsProcessingParameterColor *fromScriptCode( const QString &name, const QString &description, bool isOptional, const QString &definition ) SIP_FACTORY;
3904
3905 private:
3906
3907 bool mAllowOpacity = true;
3908
3909};
3910
3911
3921class CORE_EXPORT QgsProcessingParameterCoordinateOperation : public QgsProcessingParameterDefinition
3922{
3923 public:
3924
3928 QgsProcessingParameterCoordinateOperation( const QString &name, const QString &description = QString(), const QVariant &defaultValue = QVariant(),
3929 const QString &sourceCrsParameterName = QString(), const QString &destinationCrsParameterName = QString(),
3930 const QVariant &staticSourceCrs = QVariant(), const QVariant &staticDestinationCrs = QVariant(),
3931 bool optional = false );
3932
3936 static QString typeName() { return QStringLiteral( "coordinateoperation" ); }
3937 QgsProcessingParameterDefinition *clone() const override SIP_FACTORY;
3938 QString type() const override { return typeName(); }
3939 QString valueAsPythonString( const QVariant &value, QgsProcessingContext &context ) const override;
3940 QString asScriptCode() const override;
3941 QString asPythonString( QgsProcessing::PythonOutputType outputType = QgsProcessing::PythonQgsProcessingAlgorithmSubclass ) const override;
3942 QStringList dependsOnOtherParameters() const override;
3943
3944 QVariantMap toVariantMap() const override;
3945 bool fromVariantMap( const QVariantMap &map ) override;
3946
3950 static QgsProcessingParameterCoordinateOperation *fromScriptCode( const QString &name, const QString &description, bool isOptional, const QString &definition ) SIP_FACTORY;
3951
3957 QString sourceCrsParameterName() const { return mSourceParameterName; }
3958
3964 void setSourceCrsParameterName( const QString &name ) { mSourceParameterName = name; }
3965
3971 QString destinationCrsParameterName() const { return mDestParameterName; }
3972
3978 void setDestinationCrsParameterName( const QString &name ) { mDestParameterName = name; }
3979
3985 QVariant sourceCrs() const { return mSourceCrs; }
3986
3992 void setSourceCrs( const QVariant &crs ) { mSourceCrs = crs; }
3993
3999 QVariant destinationCrs() const { return mDestCrs; }
4000
4006 void setDestinationCrs( const QVariant &crs ) { mDestCrs = crs; }
4007
4008 private:
4009
4010 QString mSourceParameterName;
4011 QString mDestParameterName;
4012 QVariant mSourceCrs;
4013 QVariant mDestCrs;
4014
4015};
4016
4017
4027class CORE_EXPORT QgsProcessingParameterMapTheme : public QgsProcessingParameterDefinition
4028{
4029 public:
4030
4034 QgsProcessingParameterMapTheme( const QString &name, const QString &description = QString(), const QVariant &defaultValue = QVariant(),
4035 bool optional = false );
4036
4040 static QString typeName() { return QStringLiteral( "maptheme" ); }
4041 QgsProcessingParameterDefinition *clone() const override SIP_FACTORY;
4042 QString type() const override { return typeName(); }
4043 bool checkValueIsAcceptable( const QVariant &input, QgsProcessingContext *context = nullptr ) const override;
4044 QString valueAsPythonString( const QVariant &value, QgsProcessingContext &context ) const override;
4045 QString asScriptCode() const override;
4046 QString asPythonString( QgsProcessing::PythonOutputType outputType = QgsProcessing::PythonQgsProcessingAlgorithmSubclass ) const override;
4047 QVariantMap toVariantMap() const override;
4048 bool fromVariantMap( const QVariantMap &map ) override;
4049
4053 static QgsProcessingParameterMapTheme *fromScriptCode( const QString &name, const QString &description, bool isOptional, const QString &definition ) SIP_FACTORY;
4054
4055 private:
4056
4057};
4058
4059
4070class CORE_EXPORT QgsProcessingParameterDateTime : public QgsProcessingParameterDefinition
4071{
4072 public:
4073
4075 enum Type
4076 {
4077 DateTime,
4078 Date,
4079 Time,
4080 };
4081
4085 explicit QgsProcessingParameterDateTime( const QString &name, const QString &description = QString(),
4086 Type type = DateTime,
4087 const QVariant &defaultValue = QVariant(),
4088 bool optional = false,
4089 const QDateTime &minValue = QDateTime(),
4090 const QDateTime &maxValue = QDateTime()
4091 );
4092
4096 static QString typeName() { return QStringLiteral( "datetime" ); }
4097 QgsProcessingParameterDefinition *clone() const override SIP_FACTORY;
4098 QString type() const override { return typeName(); }
4099 bool checkValueIsAcceptable( const QVariant &input, QgsProcessingContext *context = nullptr ) const override;
4100 QString valueAsPythonString( const QVariant &value, QgsProcessingContext &context ) const override;
4101 QString toolTip() const override;
4102 QString asPythonString( QgsProcessing::PythonOutputType outputType = QgsProcessing::PythonQgsProcessingAlgorithmSubclass ) const override;
4103
4111 QDateTime minimum() const;
4112
4124 void setMinimum( const QDateTime &minimum );
4125
4133 QDateTime maximum() const;
4134
4146 void setMaximum( const QDateTime &maximum );
4147
4152 Type dataType() const;
4153
4158 void setDataType( Type type );
4159
4160 QVariantMap toVariantMap() const override;
4161 bool fromVariantMap( const QVariantMap &map ) override;
4162
4166 static QgsProcessingParameterDateTime *fromScriptCode( const QString &name, const QString &description, bool isOptional, const QString &definition ) SIP_FACTORY;
4167
4168 private:
4169
4170 QDateTime mMin;
4171 QDateTime mMax;
4172 Type mDataType = DateTime;
4173};
4174
4175
4186class CORE_EXPORT QgsProcessingParameterProviderConnection : public QgsProcessingParameterDefinition
4187{
4188 public:
4189
4196 QgsProcessingParameterProviderConnection( const QString &name, const QString &description, const QString &provider, const QVariant &defaultValue = QVariant(),
4197 bool optional = false );
4198
4202 static QString typeName() { return QStringLiteral( "providerconnection" ); }
4203 QgsProcessingParameterDefinition *clone() const override SIP_FACTORY;
4204 QString type() const override { return typeName(); }
4205 bool checkValueIsAcceptable( const QVariant &input, QgsProcessingContext *context = nullptr ) const override;
4206 QString valueAsPythonString( const QVariant &value, QgsProcessingContext &context ) const override;
4207 QString asScriptCode() const override;
4208 QString asPythonString( QgsProcessing::PythonOutputType outputType = QgsProcessing::PythonQgsProcessingAlgorithmSubclass ) const override;
4209 QVariantMap toVariantMap() const override;
4210 bool fromVariantMap( const QVariantMap &map ) override;
4211
4216 QString providerId() const { return mProviderId; }
4217
4222 void setProviderId( const QString &provider ) { mProviderId = provider; }
4223
4227 static QgsProcessingParameterProviderConnection *fromScriptCode( const QString &name, const QString &description, bool isOptional, const QString &definition ) SIP_FACTORY;
4228
4229 private:
4230
4231 QString mProviderId;
4232};
4233
4234
4245class CORE_EXPORT QgsProcessingParameterDatabaseSchema : public QgsProcessingParameterDefinition
4246{
4247 public:
4248
4257 QgsProcessingParameterDatabaseSchema( const QString &name, const QString &description, const QString &connectionParameterName = QString(), const QVariant &defaultValue = QVariant(),
4258 bool optional = false );
4259
4263 static QString typeName() { return QStringLiteral( "databaseschema" ); }
4264 QgsProcessingParameterDefinition *clone() const override SIP_FACTORY;
4265 QString type() const override { return typeName(); }
4266 bool checkValueIsAcceptable( const QVariant &input, QgsProcessingContext *context = nullptr ) const override;
4267 QString valueAsPythonString( const QVariant &value, QgsProcessingContext &context ) const override;
4268 QString asScriptCode() const override;
4269 QString asPythonString( QgsProcessing::PythonOutputType outputType = QgsProcessing::PythonQgsProcessingAlgorithmSubclass ) const override;
4270 QVariantMap toVariantMap() const override;
4271 bool fromVariantMap( const QVariantMap &map ) override;
4272 QStringList dependsOnOtherParameters() const override;
4273
4278 QString parentConnectionParameterName() const;
4279
4284 void setParentConnectionParameterName( const QString &name );
4285
4289 static QgsProcessingParameterDatabaseSchema *fromScriptCode( const QString &name, const QString &description, bool isOptional, const QString &definition ) SIP_FACTORY;
4290
4291 private:
4292
4293 QString mParentConnectionParameterName;
4294};
4295
4296
4307class CORE_EXPORT QgsProcessingParameterDatabaseTable : public QgsProcessingParameterDefinition
4308{
4309 public:
4310
4320 QgsProcessingParameterDatabaseTable( const QString &name, const QString &description,
4321 const QString &connectionParameterName = QString(),
4322 const QString &schemaParameterName = QString(),
4323 const QVariant &defaultValue = QVariant(),
4324 bool optional = false,
4325 bool allowNewTableNames = false );
4326
4330 static QString typeName() { return QStringLiteral( "databasetable" ); }
4331 QgsProcessingParameterDefinition *clone() const override SIP_FACTORY;
4332 QString type() const override { return typeName(); }
4333 bool checkValueIsAcceptable( const QVariant &input, QgsProcessingContext *context = nullptr ) const override;
4334 QString valueAsPythonString( const QVariant &value, QgsProcessingContext &context ) const override;
4335 QString asScriptCode() const override;
4336 QString asPythonString( QgsProcessing::PythonOutputType outputType = QgsProcessing::PythonQgsProcessingAlgorithmSubclass ) const override;
4337 QVariantMap toVariantMap() const override;
4338 bool fromVariantMap( const QVariantMap &map ) override;
4339 QStringList dependsOnOtherParameters() const override;
4340
4345 QString parentConnectionParameterName() const;
4346
4351 void setParentConnectionParameterName( const QString &name );
4352
4357 QString parentSchemaParameterName() const;
4358
4363 void setParentSchemaParameterName( const QString &name );
4364
4368 static QgsProcessingParameterDatabaseTable *fromScriptCode( const QString &name, const QString &description, bool isOptional, const QString &definition ) SIP_FACTORY;
4369
4376 bool allowNewTableNames() const;
4377
4384 void setAllowNewTableNames( bool allowed );
4385
4386 private:
4387
4388 QString mParentConnectionParameterName;
4389 QString mParentSchemaParameterName;
4390 bool mAllowNewTableNames = false;
4391};
4392
4393
4400class CORE_EXPORT QgsProcessingParameterPointCloudLayer : public QgsProcessingParameterDefinition, public QgsFileFilterGenerator
4401{
4402 public:
4403
4407 QgsProcessingParameterPointCloudLayer( const QString &name, const QString &description = QString(),
4408 const QVariant &defaultValue = QVariant(), bool optional = false );
4409
4413 static QString typeName() { return QStringLiteral( "pointcloud" ); }
4414 QgsProcessingParameterDefinition *clone() const override SIP_FACTORY;
4415 QString type() const override { return typeName(); }
4416 bool checkValueIsAcceptable( const QVariant &input, QgsProcessingContext *context = nullptr ) const override;
4417 QString valueAsPythonString( const QVariant &value, QgsProcessingContext &context ) const override;
4418 QString valueAsString( const QVariant &value, QgsProcessingContext &context, bool &ok SIP_OUT ) const override;
4419 QVariant valueAsJsonObject( const QVariant &value, QgsProcessingContext &context ) const override;
4420 QString createFileFilter() const override;
4421
4425 static QgsProcessingParameterPointCloudLayer *fromScriptCode( const QString &name, const QString &description, bool isOptional, const QString &definition ) SIP_FACTORY;
4426};
4427
4428
4435class CORE_EXPORT QgsProcessingParameterAnnotationLayer : public QgsProcessingParameterDefinition
4436{
4437 public:
4438
4442 QgsProcessingParameterAnnotationLayer( const QString &name, const QString &description = QString(),
4443 const QVariant &defaultValue = QVariant(), bool optional = false );
4444
4448 static QString typeName() { return QStringLiteral( "annotation" ); }
4449 QgsProcessingParameterDefinition *clone() const override SIP_FACTORY;
4450 QString type() const override { return typeName(); }
4451 bool checkValueIsAcceptable( const QVariant &input, QgsProcessingContext *context = nullptr ) const override;
4452 QString valueAsPythonString( const QVariant &value, QgsProcessingContext &context ) const override;
4453 QString valueAsString( const QVariant &value, QgsProcessingContext &context, bool &ok SIP_OUT ) const override;
4454 QVariant valueAsJsonObject( const QVariant &value, QgsProcessingContext &context ) const override;
4455
4459 static QgsProcessingParameterAnnotationLayer *fromScriptCode( const QString &name, const QString &description, bool isOptional, const QString &definition ) SIP_FACTORY;
4460};
4461
4469class CORE_EXPORT QgsProcessingParameterPointCloudDestination : public QgsProcessingDestinationParameter
4470{
4471 public:
4472
4479 QgsProcessingParameterPointCloudDestination( const QString &name, const QString &description = QString(),
4480 const QVariant &defaultValue = QVariant(),
4481 bool optional = false,
4482 bool createByDefault = true );
4483
4487 static QString typeName() { return QStringLiteral( "pointCloudDestination" ); }
4488 QgsProcessingParameterDefinition *clone() const override SIP_FACTORY;
4489 QString type() const override { return typeName(); }
4490 bool checkValueIsAcceptable( const QVariant &input, QgsProcessingContext *context = nullptr ) const override;
4491 QString valueAsPythonString( const QVariant &value, QgsProcessingContext &context ) const override;
4492 QgsProcessingOutputDefinition *toOutputDefinition() const override SIP_FACTORY;
4493 QString defaultFileExtension() const override;
4494 QString createFileFilter() const override;
4495
4500 virtual QStringList supportedOutputPointCloudLayerExtensions() const;
4501
4505 static QgsProcessingParameterPointCloudDestination *fromScriptCode( const QString &name, const QString &description, bool isOptional, const QString &definition ) SIP_FACTORY;
4506};
4507
4514class CORE_EXPORT QgsProcessingParameterPointCloudAttribute : public QgsProcessingParameterDefinition
4515{
4516 public:
4517
4521 QgsProcessingParameterPointCloudAttribute( const QString &name, const QString &description = QString(), const QVariant &defaultValue = QVariant(),
4522 const QString &parentLayerParameterName = QString(),
4523 bool allowMultiple = false,
4524 bool optional = false,
4525 bool defaultToAllAttributes = false );
4526
4530 static QString typeName() { return QStringLiteral( "attribute" ); }
4531 QgsProcessingParameterDefinition *clone() const override SIP_FACTORY;
4532 QString type() const override { return typeName(); }
4533 bool checkValueIsAcceptable( const QVariant &input, QgsProcessingContext *context = nullptr ) const override;
4534 QString valueAsPythonString( const QVariant &value, QgsProcessingContext &context ) const override;
4535 QString asScriptCode() const override;
4536 QString asPythonString( QgsProcessing::PythonOutputType outputType = QgsProcessing::PythonQgsProcessingAlgorithmSubclass ) const override;
4537 QStringList dependsOnOtherParameters() const override;
4538
4543 QString parentLayerParameterName() const;
4544
4549 void setParentLayerParameterName( const QString &parentLayerParameterName );
4550
4555 bool allowMultiple() const;
4556
4561 void setAllowMultiple( bool allowMultiple );
4562
4571 bool defaultToAllAttributes() const;
4572
4581 void setDefaultToAllAttributes( bool enabled );
4582
4583 QVariantMap toVariantMap() const override;
4584 bool fromVariantMap( const QVariantMap &map ) override;
4585
4589 static QgsProcessingParameterPointCloudAttribute *fromScriptCode( const QString &name, const QString &description, bool isOptional, const QString &definition ) SIP_FACTORY;
4590
4591 private:
4592
4593 QString mParentLayerParameterName;
4594 bool mAllowMultiple = false;
4595 bool mDefaultToAllAttributes = false;
4596};
4597
4605class CORE_EXPORT QgsProcessingParameterVectorTileDestination : public QgsProcessingDestinationParameter
4606{
4607 public:
4608
4615 QgsProcessingParameterVectorTileDestination( const QString &name, const QString &description = QString(),
4616 const QVariant &defaultValue = QVariant(),
4617 bool optional = false,
4618 bool createByDefault = true );
4619
4623 static QString typeName() { return QStringLiteral( "vectorTileDestination" ); }
4624 QgsProcessingParameterDefinition *clone() const override SIP_FACTORY;
4625 QString type() const override { return typeName(); }
4626 bool checkValueIsAcceptable( const QVariant &input, QgsProcessingContext *context = nullptr ) const override;
4627 QString valueAsPythonString( const QVariant &value, QgsProcessingContext &context ) const override;
4628 QgsProcessingOutputDefinition *toOutputDefinition() const override SIP_FACTORY;
4629 QString defaultFileExtension() const override;
4630 QString createFileFilter() const override;
4631
4636 virtual QStringList supportedOutputVectorTileLayerExtensions() const;
4637
4641 static QgsProcessingParameterVectorTileDestination *fromScriptCode( const QString &name, const QString &description, bool isOptional, const QString &definition ) SIP_FACTORY;
4642};
4643
4644// clazy:excludeall=qstring-allocations
4645
4646#endif // QGSPROCESSINGPARAMETERS_H
4647
4648
Qgis
The Qgis class provides global constants for use throughout the application.
Definition qgis.h:54
Qgis::ExpressionType
ExpressionType
Expression types.
Definition qgis.h:3766
Qgis::ExpressionType::Qgis
@ Qgis
Native QGIS expression.
Qgis::DistanceUnit
DistanceUnit
Units of distance.
Definition qgis.h:3443
Qgis::DistanceUnit::Unknown
@ Unknown
Unknown distance unit.
Qgis::TemporalUnit
TemporalUnit
Temporal units.
Definition qgis.h:3550
Qgis::TemporalUnit::Milliseconds
@ Milliseconds
Milliseconds.
Qgis::WkbType
WkbType
The WKB type describes the number of dimensions a geometry has.
Definition qgis.h:155
QgsAnnotationLayer
Represents a map layer containing a set of georeferenced annotations, e.g.
Definition qgsannotationlayer.h:47
QgsCoordinateReferenceSystem
This class represents a coordinate reference system (CRS).
Definition qgscoordinatereferencesystem.h:212
QgsFeatureRequest
This class wraps a request for features to a vector layer (or directly its vector data provider).
Definition qgsfeaturerequest.h:84
QgsFeatureRequest::InvalidGeometryCheck
InvalidGeometryCheck
Handling of features with invalid geometries.
Definition qgsfeaturerequest.h:110
QgsFeatureRequest::GeometryAbortOnInvalid
@ GeometryAbortOnInvalid
Close iterator on encountering any features with invalid geometry. This requires a slow geometry vali...
Definition qgsfeaturerequest.h:113
QgsFeatureSink
An interface for objects which accept features via addFeature(s) methods.
Definition qgsfeaturesink.h:34
QgsFields
Container of fields for a vector layer.
Definition qgsfields.h:45
QgsFileFilterGenerator
Abstract interface for classes which generate a file filter string.
Definition qgsfilefiltergenerator.h:34
QgsGeometry
A geometry is the spatial representation of a feature.
Definition qgsgeometry.h:164
QgsLayoutItem
Base class for graphical items within a QgsLayout.
Definition qgslayoutitem.h:112
QgsMapLayer
Base class for all map layer types.
Definition qgsmaplayer.h:74
QgsMeshLayer
Represents a mesh layer supporting display of data on structured or unstructured meshes.
Definition qgsmeshlayer.h:100
QgsPointCloudLayer
Represents a map layer supporting display of point clouds.
Definition qgspointcloudlayer.h:46
QgsPointXY
A class to represent a 2D point.
Definition qgspointxy.h:59
QgsPrintLayout
Print layout, a QgsLayout subclass for static or atlas-based layouts.
Definition qgsprintlayout.h:31
QgsProcessingAlgorithm
Abstract base class for processing algorithms.
Definition qgsprocessingalgorithm.h:53
QgsProcessingContext
Contains information about the context in which a processing algorithm is executed.
Definition qgsprocessingcontext.h:46
QgsProcessingDestinationParameter
Base class for all parameter definitions which represent file or layer destinations,...
Definition qgsprocessingparameters.h:3220
QgsProcessingDestinationParameter::defaultFileExtension
virtual QString defaultFileExtension() const =0
Returns the default file extension for destination file paths associated with this parameter.
QgsProcessingDestinationParameter::supportsNonFileBasedOutput
bool supportsNonFileBasedOutput() const
Returns true if the destination parameter supports non filed-based outputs, such as memory layers or ...
Definition qgsprocessingparameters.h:3249
QgsProcessingDestinationParameter::isDestination
bool isDestination() const override
Returns true if this parameter represents a file or layer destination, e.g.
Definition qgsprocessingparameters.h:3232
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:3311
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:3256
QgsProcessingException
Custom exception class for processing related exceptions.
Definition qgsexception.h:84
QgsProcessingFeatureSourceDefinition
Encapsulates settings relating to a feature source input to a processing algorithm.
Definition qgsprocessingparameters.h:57
QgsProcessingFeatureSourceDefinition::flags
Flags flags
Flags which dictate source behavior.
Definition qgsprocessingparameters.h:153
QgsProcessingFeatureSourceDefinition::operator!=
bool operator!=(const QgsProcessingFeatureSourceDefinition &other) const
Definition qgsprocessingparameters.h:192
QgsProcessingFeatureSourceDefinition::selectedFeaturesOnly
bool selectedFeaturesOnly
true if only selected features in the source should be used by algorithms.
Definition qgsprocessingparameters.h:131
QgsProcessingFeatureSourceDefinition::geometryCheck
QgsFeatureRequest::InvalidGeometryCheck geometryCheck
Geometry check method to apply to this source.
Definition qgsprocessingparameters.h:163
QgsProcessingFeatureSourceDefinition::operator==
bool operator==(const QgsProcessingFeatureSourceDefinition &other) const
Definition qgsprocessingparameters.h:182
QgsProcessingFeatureSourceDefinition::QgsProcessingFeatureSourceDefinition
QgsProcessingFeatureSourceDefinition(const QgsProperty &source, bool selectedFeaturesOnly=false, long long featureLimit=-1, QgsProcessingFeatureSourceDefinition::Flags flags=QgsProcessingFeatureSourceDefinition::Flags(), QgsFeatureRequest::InvalidGeometryCheck geometryCheck=QgsFeatureRequest::GeometryAbortOnInvalid, const QString &filterExpression=QString())
Constructor for QgsProcessingFeatureSourceDefinition, accepting a QgsProperty source.
Definition qgsprocessingparameters.h:113
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:139
QgsProcessingFeatureSourceDefinition::Flag
Flag
Flags which control source behavior.
Definition qgsprocessingparameters.h:65
QgsProcessingFeatureSourceDefinition::filterExpression
QString filterExpression
Optional expression filter to use for filtering features which will be read from the source.
Definition qgsprocessingparameters.h:146
QgsProcessingFeatureSource
QgsFeatureSource subclass which proxies methods to an underlying QgsFeatureSource,...
Definition qgsprocessingutils.h:676
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:41
QgsProcessingOutputLayerDefinition
Encapsulates settings relating to a feature sink or output raster layer for a processing algorithm.
Definition qgsprocessingparameters.h:218
QgsProcessingOutputLayerDefinition::QgsProcessingOutputLayerDefinition
QgsProcessingOutputLayerDefinition(const QgsProperty &sink, QgsProject *destinationProject=nullptr)
Constructor for QgsProcessingOutputLayerDefinition, accepting a QgsProperty sink/layer.
Definition qgsprocessingparameters.h:236
QgsProcessingOutputLayerDefinition::sink
QgsProperty sink
Sink/layer definition.
Definition qgsprocessingparameters.h:244
QgsProcessingOutputLayerDefinition::useRemapping
bool useRemapping() const
Returns true if the output uses a remapping definition.
Definition qgsprocessingparameters.h:272
QgsProcessingOutputLayerDefinition::QgsProcessingOutputLayerDefinition
QgsProcessingOutputLayerDefinition(const QString &sink=QString(), QgsProject *destinationProject=nullptr)
Constructor for QgsProcessingOutputLayerDefinition, accepting a static sink/layer string.
Definition qgsprocessingparameters.h:226
QgsProcessingOutputLayerDefinition::remappingDefinition
QgsRemappingSinkDefinition remappingDefinition() const
Returns the output remapping definition, if useRemapping() is true.
Definition qgsprocessingparameters.h:281
QgsProcessingOutputLayerDefinition::destinationName
QString destinationName
Name to use for sink if it's to be loaded into a destination project.
Definition qgsprocessingparameters.h:256
QgsProcessingOutputLayerDefinition::createOptions
QVariantMap createOptions
Map of optional sink/layer creation options, which are passed to the underlying provider when creatin...
Definition qgsprocessingparameters.h:264
QgsProcessingParameterAnnotationLayer
An annotation layer parameter for processing algorithms.
Definition qgsprocessingparameters.h:4436
QgsProcessingParameterAnnotationLayer::typeName
static QString typeName()
Returns the type name for the parameter class.
Definition qgsprocessingparameters.h:4448
QgsProcessingParameterAuthConfig
A string parameter for authentication configuration ID values.
Definition qgsprocessingparameters.h:2804
QgsProcessingParameterAuthConfig::typeName
static QString typeName()
Returns the type name for the parameter class.
Definition qgsprocessingparameters.h:2816
QgsProcessingParameterBand
A raster band parameter for Processing algorithms.
Definition qgsprocessingparameters.h:3671
QgsProcessingParameterBand::typeName
static QString typeName()
Returns the type name for the parameter class.
Definition qgsprocessingparameters.h:3685
QgsProcessingParameterBoolean
A boolean parameter for processing algorithms.
Definition qgsprocessingparameters.h:1798
QgsProcessingParameterBoolean::typeName
static QString typeName()
Returns the type name for the parameter class.
Definition qgsprocessingparameters.h:1810
QgsProcessingParameterColor
A color parameter for processing algorithms.
Definition qgsprocessingparameters.h:3858
QgsProcessingParameterColor::typeName
static QString typeName()
Returns the type name for the parameter class.
Definition qgsprocessingparameters.h:3873
QgsProcessingParameterCoordinateOperation
A coordinate operation parameter for processing algorithms, for selection between available coordinat...
Definition qgsprocessingparameters.h:3922
QgsProcessingParameterCoordinateOperation::typeName
static QString typeName()
Returns the type name for the parameter class.
Definition qgsprocessingparameters.h:3936
QgsProcessingParameterCoordinateOperation::sourceCrs
QVariant sourceCrs() const
Returns the static source CRS, or an invalid value if this is not set.
Definition qgsprocessingparameters.h:3985
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:3971
QgsProcessingParameterCoordinateOperation::setDestinationCrsParameterName
void setDestinationCrsParameterName(const QString &name)
Sets the name of the destination CRS parameter.
Definition qgsprocessingparameters.h:3978
QgsProcessingParameterCoordinateOperation::setSourceCrs
void setSourceCrs(const QVariant &crs)
Sets the static source crs.
Definition qgsprocessingparameters.h:3992
QgsProcessingParameterCoordinateOperation::destinationCrs
QVariant destinationCrs() const
Returns the static destination CRS, or an invalid value if this is not set.
Definition qgsprocessingparameters.h:3999
QgsProcessingParameterCoordinateOperation::setDestinationCrs
void setDestinationCrs(const QVariant &crs)
Sets the static destination crs.
Definition qgsprocessingparameters.h:4006
QgsProcessingParameterCoordinateOperation::setSourceCrsParameterName
void setSourceCrsParameterName(const QString &name)
Sets the name of the source CRS parameter.
Definition qgsprocessingparameters.h:3964
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:3957
QgsProcessingParameterCrs
A coordinate reference system parameter for processing algorithms.
Definition qgsprocessingparameters.h:1829
QgsProcessingParameterCrs::typeName
static QString typeName()
Returns the type name for the parameter class.
Definition qgsprocessingparameters.h:1841
QgsProcessingParameterDatabaseSchema
A database schema parameter for processing algorithms, allowing users to select from existing schemas...
Definition qgsprocessingparameters.h:4246
QgsProcessingParameterDatabaseSchema::typeName
static QString typeName()
Returns the type name for the parameter class.
Definition qgsprocessingparameters.h:4263
QgsProcessingParameterDatabaseTable
A database table name parameter for processing algorithms, allowing users to select from existing dat...
Definition qgsprocessingparameters.h:4308
QgsProcessingParameterDatabaseTable::typeName
static QString typeName()
Returns the type name for the parameter class.
Definition qgsprocessingparameters.h:4330
QgsProcessingParameterDateTime
A datetime (or pure date or time) parameter for processing algorithms.
Definition qgsprocessingparameters.h:4071
QgsProcessingParameterDateTime::typeName
static QString typeName()
Returns the type name for the parameter class.
Definition qgsprocessingparameters.h:4096
QgsProcessingParameterDefinition
Base class for the definition of processing parameters.
Definition qgsprocessingparameters.h:350
QgsProcessingParameterDefinition::defaultValue
QVariant defaultValue() const
Returns the default value for the parameter.
Definition qgsprocessingparameters.h:558
QgsProcessingParameterDefinition::setDefaultValue
void setDefaultValue(const QVariant &value)
Sets the default value for the parameter.
Definition qgsprocessingparameters.h:566
QgsProcessingParameterDefinition::additionalExpressionContextVariables
QStringList additionalExpressionContextVariables() const
Returns a list of additional expression context variables which are available for use when evaluating...
Definition qgsprocessingparameters.h:841
QgsProcessingParameterDefinition::mAdditionalExpressionVariables
QStringList mAdditionalExpressionVariables
Additional expression context variables exposed for use by this parameter.
Definition qgsprocessingparameters.h:941
QgsProcessingParameterDefinition::help
QString help() const
Returns the help for the parameter.
Definition qgsprocessingparameters.h:539
QgsProcessingParameterDefinition::setMetadata
void setMetadata(const QVariantMap &metadata)
Sets the parameter's freeform metadata.
Definition qgsprocessingparameters.h:740
QgsProcessingParameterDefinition::ValueAsStringFlag
ValueAsStringFlag
Flags for passing to the valueAsStringPrivate() method.
Definition qgsprocessingparameters.h:872
QgsProcessingParameterDefinition::setGuiDefaultValueOverride
void setGuiDefaultValueOverride(const QVariant &value)
Sets the default value to use for the parameter in GUI widgets.
Definition qgsprocessingparameters.h:597
QgsProcessingParameterDefinition::metadata
QVariantMap metadata() const
Returns the parameter's freeform metadata.
Definition qgsprocessingparameters.h:726
QgsProcessingParameterDefinition::description
QString description() const
Returns the description for the parameter.
Definition qgsprocessingparameters.h:521
QgsProcessingParameterDefinition::mDynamicLayerParameterName
QString mDynamicLayerParameterName
Linked vector layer parameter name for dynamic properties.
Definition qgsprocessingparameters.h:938
QgsProcessingParameterDefinition::isDestination
virtual bool isDestination() const
Returns true if this parameter represents a file or layer destination, e.g.
Definition qgsprocessingparameters.h:500
QgsProcessingParameterDefinition::setDescription
void setDescription(const QString &description)
Sets the description for the parameter.
Definition qgsprocessingparameters.h:528
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:826
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:813
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:860
QgsProcessingParameterDefinition::mMetadata
QVariantMap mMetadata
Freeform metadata for parameter. Mostly used by widget wrappers to customize their appearance and beh...
Definition qgsprocessingparameters.h:926
QgsProcessingParameterDefinition::setName
void setName(const QString &name)
Sets the name of the parameter.
Definition qgsprocessingparameters.h:514
QgsProcessingParameterDefinition::mDescription
QString mDescription
Parameter description.
Definition qgsprocessingparameters.h:911
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:800
QgsProcessingParameterDefinition::flags
Flags flags() const
Returns any flags associated with the parameter.
Definition qgsprocessingparameters.h:613
QgsProcessingParameterDefinition::setHelp
void setHelp(const QString &help)
Sets the help for the parameter.
Definition qgsprocessingparameters.h:550
QgsProcessingParameterDefinition::name
QString name() const
Returns the name of the parameter.
Definition qgsprocessingparameters.h:507
QgsProcessingParameterDefinition::mDefault
QVariant mDefault
Default value for parameter.
Definition qgsprocessingparameters.h:917
QgsProcessingParameterDefinition::dependsOnOtherParameters
virtual QStringList dependsOnOtherParameters() const
Returns a list of other parameter names on which this parameter is dependent (e.g.
Definition qgsprocessingparameters.h:746
QgsProcessingParameterDefinition::setIsDynamic
void setIsDynamic(bool dynamic)
Sets whether the parameter is dynamic, and can support data-defined values (i.e.
Definition qgsprocessingparameters.h:784
QgsProcessingParameterDefinition::mGuiDefault
QVariant mGuiDefault
Default value for parameter in GUI.
Definition qgsprocessingparameters.h:920
QgsProcessingParameterDefinition::mPropertyDefinition
QgsPropertyDefinition mPropertyDefinition
Data defined property definition.
Definition qgsprocessingparameters.h:935
QgsProcessingParameterDefinition::isDynamic
bool isDynamic() const
Returns true if the parameter supports is dynamic, and can support data-defined values (i....
Definition qgsprocessingparameters.h:775
QgsProcessingParameterDefinition::setFlags
void setFlags(Flags flags)
Sets the flags associated with the parameter.
Definition qgsprocessingparameters.h:619
QgsProcessingParameterDefinition::~QgsProcessingParameterDefinition
virtual ~QgsProcessingParameterDefinition()=default
QgsProcessingParameterDefinition::metadata
QVariantMap & metadata()
Returns the parameter's freeform metadata.
Definition qgsprocessingparameters.h:733
QgsProcessingParameterDefinition::dynamicPropertyDefinition
QgsPropertyDefinition dynamicPropertyDefinition() const
Returns the property definition for dynamic properties.
Definition qgsprocessingparameters.h:792
QgsProcessingParameterDistance
A double numeric parameter for distance values.
Definition qgsprocessingparameters.h:2377
QgsProcessingParameterDistance::typeName
static QString typeName()
Returns the type name for the parameter class.
Definition qgsprocessingparameters.h:2393
QgsProcessingParameterDistance::setDefaultUnit
void setDefaultUnit(Qgis::DistanceUnit unit)
Sets the default distance unit for the parameter.
Definition qgsprocessingparameters.h:2427
QgsProcessingParameterDuration
A double numeric parameter for duration values.
Definition qgsprocessingparameters.h:2447
QgsProcessingParameterDuration::setDefaultUnit
void setDefaultUnit(Qgis::TemporalUnit unit)
Sets the default duration unit for the parameter.
Definition qgsprocessingparameters.h:2481
QgsProcessingParameterDuration::typeName
static QString typeName()
Returns the type name for the parameter class.
Definition qgsprocessingparameters.h:2462
QgsProcessingParameterDxfLayers::typeName
static QString typeName()
Returns the type name for the parameter class.
Definition qgsprocessingparameterdxflayers.h:60
QgsProcessingParameterEnum
An enum based parameter for processing algorithms, allowing for selection from predefined values.
Definition qgsprocessingparameters.h:2637
QgsProcessingParameterEnum::typeName
static QString typeName()
Returns the type name for the parameter class.
Definition qgsprocessingparameters.h:2652
QgsProcessingParameterExpression
An expression parameter for processing algorithms.
Definition qgsprocessingparameters.h:2836
QgsProcessingParameterExpression::typeName
static QString typeName()
Returns the type name for the parameter class.
Definition qgsprocessingparameters.h:2849
QgsProcessingParameterExtent
A rectangular map extent parameter for processing algorithms.
Definition qgsprocessingparameters.h:1863
QgsProcessingParameterExtent::typeName
static QString typeName()
Returns the type name for the parameter class.
Definition qgsprocessingparameters.h:1875
QgsProcessingParameterFeatureSink
A feature sink output for processing algorithms.
Definition qgsprocessingparameters.h:3342
QgsProcessingParameterFeatureSink::typeName
static QString typeName()
Returns the type name for the parameter class.
Definition qgsprocessingparameters.h:3357
QgsProcessingParameterFeatureSource
An input feature source (such as vector layers) parameter for processing algorithms.
Definition qgsprocessingparameters.h:3178
QgsProcessingParameterFeatureSource::typeName
static QString typeName()
Returns the type name for the parameter class.
Definition qgsprocessingparameters.h:3191
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:3059
QgsProcessingParameterField::typeName
static QString typeName()
Returns the type name for the parameter class.
Definition qgsprocessingparameters.h:3086
QgsProcessingParameterFileDestination
A generic file based destination parameter, for specifying the destination path for a file (non-map l...
Definition qgsprocessingparameters.h:3574
QgsProcessingParameterFileDestination::typeName
static QString typeName()
Returns the type name for the parameter class.
Definition qgsprocessingparameters.h:3592
QgsProcessingParameterFile
An input file or folder parameter for processing algorithms.
Definition qgsprocessingparameters.h:2000
QgsProcessingParameterFile::extension
QString extension() const
Returns any specified file extension for the parameter.
Definition qgsprocessingparameters.h:2050
QgsProcessingParameterFile::typeName
static QString typeName()
Returns the type name for the parameter class.
Definition qgsprocessingparameters.h:2023
QgsProcessingParameterFile::setBehavior
void setBehavior(Behavior behavior)
Sets the parameter behavior (e.g.
Definition qgsprocessingparameters.h:2041
QgsProcessingParameterFile::behavior
Behavior behavior() const
Returns the parameter behavior (e.g.
Definition qgsprocessingparameters.h:2035
QgsProcessingParameterFolderDestination
A folder destination parameter, for specifying the destination path for a folder created by the algor...
Definition qgsprocessingparameters.h:3636
QgsProcessingParameterFolderDestination::typeName
static QString typeName()
Returns the type name for the parameter class.
Definition qgsprocessingparameters.h:3650
QgsProcessingParameterGeometry
A geometry parameter for processing algorithms.
Definition qgsprocessingparameters.h:1930
QgsProcessingParameterGeometry::setGeometryTypes
void setGeometryTypes(const QList< int > &geometryTypes)
Sets the allowed geometryTypes, as a list of Qgis::GeometryType values.
Definition qgsprocessingparameters.h:1965
QgsProcessingParameterGeometry::allowMultipart
bool allowMultipart() const
Returns the parameter allow multipart geometries.
Definition qgsprocessingparameters.h:1971
QgsProcessingParameterGeometry::geometryTypes
QList< int > geometryTypes() const
Returns the parameter allowed geometries, as a list of Qgis::GeometryType values.
Definition qgsprocessingparameters.h:1959
QgsProcessingParameterGeometry::setAllowMultipart
void setAllowMultipart(bool allowMultipart)
Sets the allow multipart geometries.
Definition qgsprocessingparameters.h:1977
QgsProcessingParameterGeometry::typeName
static QString typeName()
Returns the type name for the parameter class.
Definition qgsprocessingparameters.h:1945
QgsProcessingParameterLayoutItem
A print layout item parameter, allowing users to select a particular item from a print layout.
Definition qgsprocessingparameters.h:3784
QgsProcessingParameterLayoutItem::typeName
static QString typeName()
Returns the type name for the parameter class.
Definition qgsprocessingparameters.h:3798
QgsProcessingParameterLayout
A print layout parameter, allowing users to select a print layout.
Definition qgsprocessingparameters.h:3746
QgsProcessingParameterLayout::typeName
static QString typeName()
Returns the type name for the parameter class.
Definition qgsprocessingparameters.h:3758
QgsProcessingParameterLimitedDataTypes
Can be inherited by parameters which require limits to their acceptable data types.
Definition qgsprocessingparameters.h:2906
QgsProcessingParameterLimitedDataTypes::mDataTypes
QList< int > mDataTypes
List of acceptable data types for the parameter.
Definition qgsprocessingparameters.h:2929
QgsProcessingParameterMapLayer
A map layer parameter for processing algorithms.
Definition qgsprocessingparameters.h:3018
QgsProcessingParameterMapLayer::typeName
static QString typeName()
Returns the type name for the parameter class.
Definition qgsprocessingparameters.h:3031
QgsProcessingParameterMapTheme
A map theme parameter for processing algorithms, allowing users to select an existing map theme from ...
Definition qgsprocessingparameters.h:4028
QgsProcessingParameterMapTheme::typeName
static QString typeName()
Returns the type name for the parameter class.
Definition qgsprocessingparameters.h:4040
QgsProcessingParameterMatrix
A table (matrix) parameter for processing algorithms.
Definition qgsprocessingparameters.h:2104
QgsProcessingParameterMatrix::typeName
static QString typeName()
Returns the type name for the parameter class.
Definition qgsprocessingparameters.h:2118
QgsProcessingParameterMeshDatasetGroups::typeName
static QString typeName()
Returns the type name for the parameter class.
Definition qgsprocessingparametermeshdataset.h:62
QgsProcessingParameterMeshDatasetTime::typeName
static QString typeName()
Returns the type name for the parameter class.
Definition qgsprocessingparametermeshdataset.h:172
QgsProcessingParameterMeshLayer
A mesh layer parameter for processing algorithms.
Definition qgsprocessingparameters.h:2982
QgsProcessingParameterMeshLayer::typeName
static QString typeName()
Returns the type name for the parameter class.
Definition qgsprocessingparameters.h:2996
QgsProcessingParameterMultipleLayers
A parameter for processing algorithms which accepts multiple map layers.
Definition qgsprocessingparameters.h:2190
QgsProcessingParameterMultipleLayers::typeName
static QString typeName()
Returns the type name for the parameter class.
Definition qgsprocessingparameters.h:2203
QgsProcessingParameterNumber
A numeric parameter for processing algorithms.
Definition qgsprocessingparameters.h:2274
QgsProcessingParameterNumber::typeName
static QString typeName()
Returns the type name for the parameter class.
Definition qgsprocessingparameters.h:2298
QgsProcessingParameterPointCloudAttribute
A point cloud layer attribute parameter for Processing algorithms.
Definition qgsprocessingparameters.h:4515
QgsProcessingParameterPointCloudAttribute::typeName
static QString typeName()
Returns the type name for the parameter class.
Definition qgsprocessingparameters.h:4530
QgsProcessingParameterPointCloudDestination
A point cloud layer destination parameter, for specifying the destination path for a point cloud laye...
Definition qgsprocessingparameters.h:4470
QgsProcessingParameterPointCloudDestination::typeName
static QString typeName()
Returns the type name for the parameter class.
Definition qgsprocessingparameters.h:4487
QgsProcessingParameterPointCloudLayer
A point cloud layer parameter for processing algorithms.
Definition qgsprocessingparameters.h:4401
QgsProcessingParameterPointCloudLayer::typeName
static QString typeName()
Returns the type name for the parameter class.
Definition qgsprocessingparameters.h:4413
QgsProcessingParameterPoint
A point parameter for processing algorithms.
Definition qgsprocessingparameters.h:1898
QgsProcessingParameterPoint::typeName
static QString typeName()
Returns the type name for the parameter class.
Definition qgsprocessingparameters.h:1910
QgsProcessingParameterProviderConnection
A data provider connection parameter for processing algorithms, allowing users to select from availab...
Definition qgsprocessingparameters.h:4187
QgsProcessingParameterProviderConnection::typeName
static QString typeName()
Returns the type name for the parameter class.
Definition qgsprocessingparameters.h:4202
QgsProcessingParameterProviderConnection::setProviderId
void setProviderId(const QString &provider)
Sets the ID of the provider associated with the connections.
Definition qgsprocessingparameters.h:4222
QgsProcessingParameterProviderConnection::providerId
QString providerId() const
Returns the ID of the provider associated with the connections.
Definition qgsprocessingparameters.h:4216
QgsProcessingParameterRange
A numeric range parameter for processing algorithms.
Definition qgsprocessingparameters.h:2537
QgsProcessingParameterRange::typeName
static QString typeName()
Returns the type name for the parameter class.
Definition qgsprocessingparameters.h:2551
QgsProcessingParameterRasterDestination
A raster layer destination parameter, for specifying the destination path for a raster layer created ...
Definition qgsprocessingparameters.h:3513
QgsProcessingParameterRasterDestination::typeName
static QString typeName()
Returns the type name for the parameter class.
Definition qgsprocessingparameters.h:3530
QgsProcessingParameterRasterLayer
A raster layer parameter for processing algorithms.
Definition qgsprocessingparameters.h:2590
QgsProcessingParameterRasterLayer::typeName
static QString typeName()
Returns the type name for the parameter class.
Definition qgsprocessingparameters.h:2602
QgsProcessingParameterScale
A double numeric parameter for map scale values.
Definition qgsprocessingparameters.h:2503
QgsProcessingParameterScale::typeName
static QString typeName()
Returns the type name for the parameter class.
Definition qgsprocessingparameters.h:2516
QgsProcessingParameterString
A string parameter for processing algorithms.
Definition qgsprocessingparameters.h:2744
QgsProcessingParameterString::typeName
static QString typeName()
Returns the type name for the parameter class.
Definition qgsprocessingparameters.h:2757
QgsProcessingParameterTinInputLayers::typeName
static QString typeName()
Returns the type name for the parameter class.
Definition qgsprocessingparametertininputlayers.h:68
QgsProcessingParameterVectorDestination
A vector layer destination parameter, for specifying the destination path for a vector layer created ...
Definition qgsprocessingparameters.h:3440
QgsProcessingParameterVectorDestination::typeName
static QString typeName()
Returns the type name for the parameter class.
Definition qgsprocessingparameters.h:3455
QgsProcessingParameterVectorLayer
A vector layer (with or without geometry) parameter for processing algorithms.
Definition qgsprocessingparameters.h:2940
QgsProcessingParameterVectorLayer::typeName
static QString typeName()
Returns the type name for the parameter class.
Definition qgsprocessingparameters.h:2955
QgsProcessingParameterVectorTileDestination
A vector tile layer destination parameter, for specifying the destination path for a vector tile laye...
Definition qgsprocessingparameters.h:4606
QgsProcessingParameterVectorTileDestination::typeName
static QString typeName()
Returns the type name for the parameter class.
Definition qgsprocessingparameters.h:4623
QgsProcessingParameterVectorTileWriterLayers::typeName
static QString typeName()
Returns the type name for the parameter class.
Definition qgsprocessingparametervectortilewriterlayers.h:57
QgsProcessingParameters
A collection of utilities for working with parameters when running a processing algorithm.
Definition qgsprocessingparameters.h:976
QgsProcessingProvider
Abstract base class for processing providers.
Definition qgsprocessingprovider.h:36
QgsProcessingUtils::LayerHint
LayerHint
Layer type hints.
Definition qgsprocessingutils.h:255
QgsProcessingUtils::LayerHint::UnknownType
@ UnknownType
Unknown layer type.
QgsProcessing
Contains enumerations and other constants for use in processing algorithms and parameters.
Definition qgsprocessing.h:41
QgsProcessing::PythonOutputType
PythonOutputType
Available Python output types.
Definition qgsprocessing.h:65
QgsProcessing::PythonQgsProcessingAlgorithmSubclass
@ PythonQgsProcessingAlgorithmSubclass
Full Python QgsProcessingAlgorithm subclass.
Definition qgsprocessing.h:66
QgsProcessing::SourceType
SourceType
Data source types enum.
Definition qgsprocessing.h:47
QgsProcessing::TypeVectorAnyGeometry
@ TypeVectorAnyGeometry
Any vector layer with geometry.
Definition qgsprocessing.h:49
QgsProject
Encapsulates a QGIS project, including sets of map layers and their styles, layouts,...
Definition qgsproject.h:107
QgsPropertyDefinition
Definition for a property.
Definition qgsproperty.h:46
QgsProperty
A store for object properties.
Definition qgsproperty.h:230
QgsRasterLayer
Represents a raster layer.
Definition qgsrasterlayer.h:78
QgsRectangle
A rectangle specified with double values.
Definition qgsrectangle.h:42
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 data sets.
Definition qgsvectorlayer.h:400
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:186
SIP_DEPRECATED
#define SIP_DEPRECATED
Definition qgis_sip.h:106
SIP_SKIP
#define SIP_SKIP
Definition qgis_sip.h:126
SIP_OUT
#define SIP_OUT
Definition qgis_sip.h:58
SIP_FACTORY
#define SIP_FACTORY
Definition qgis_sip.h:76
SIP_THROW
#define SIP_THROW(name,...)
Definition qgis_sip.h:198
SIP_END
#define SIP_END
Definition qgis_sip.h:203
Q_DECLARE_METATYPE
Q_DECLARE_METATYPE(QgsDatabaseQueryLogEntry)
operator==
bool operator==(const QgsFeatureIterator &fi1, const QgsFeatureIterator &fi2)
Definition qgsfeatureiterator.h:425
operator!=
bool operator!=(const QgsFeatureIterator &fi1, const QgsFeatureIterator &fi2)
Definition qgsfeatureiterator.h:430
QgsProcessingParameterDefinitions
QList< const QgsProcessingParameterDefinition * > QgsProcessingParameterDefinitions
List of processing parameters.
Definition qgsprocessingparameters.h:955
Q_DECLARE_OPERATORS_FOR_FLAGS
Q_DECLARE_OPERATORS_FOR_FLAGS(QgsTextRendererUtils::CurvedTextFlags)
crs
const QgsCoordinateReferenceSystem & crs
Definition qgswfsgetfeature.cpp:53
typeName
const QString & typeName
Definition qgswfsgetfeature.cpp:57
Generated on Mon Oct 2 2023 05:35:38 for QGIS API Documentation by doxygen 1.9.8