18#ifndef QGSPROCESSINGPARAMETERS_H
19#define QGSPROCESSINGPARAMETERS_H
78 , selectedFeaturesOnly( selectedFeaturesOnly )
79 , featureLimit( featureLimit )
80 , filterExpression( filterExpression )
82 , geometryCheck( geometryCheck )
104 , selectedFeaturesOnly( selectedFeaturesOnly )
105 , featureLimit( featureLimit )
106 , filterExpression( filterExpression )
108 , geometryCheck( geometryCheck )
127 long long featureLimit = -1;
158 QVariant toVariant()
const;
166 bool loadVariant(
const QVariantMap &map );
171 return source == other.
source
175 && flags == other.
flags
181 return !( *
this == other );
185 operator QVariant()
const
187 return QVariant::fromValue( *
this );
213 , destinationProject( destinationProject )
223 , destinationProject( destinationProject )
286 QVariant toVariant()
const;
294 bool loadVariant(
const QVariantMap &map );
297 operator QVariant()
const
299 return QVariant::fromValue( *
this );
308 bool mUseRemapping =
false;
347 sipType = sipType_QgsProcessingParameterBoolean;
349 sipType = sipType_QgsProcessingParameterCrs;
351 sipType = sipType_QgsProcessingParameterMapLayer;
353 sipType = sipType_QgsProcessingParameterExtent;
355 sipType = sipType_QgsProcessingParameterPoint;
357 sipType = sipType_QgsProcessingParameterGeometry;
359 sipType = sipType_QgsProcessingParameterFile;
361 sipType = sipType_QgsProcessingParameterMatrix;
363 sipType = sipType_QgsProcessingParameterMultipleLayers;
365 sipType = sipType_QgsProcessingParameterNumber;
367 sipType = sipType_QgsProcessingParameterDistance;
369 sipType = sipType_QgsProcessingParameterDuration;
371 sipType = sipType_QgsProcessingParameterScale;
373 sipType = sipType_QgsProcessingParameterRange;
375 sipType = sipType_QgsProcessingParameterRasterLayer;
377 sipType = sipType_QgsProcessingParameterMeshLayer;
379 sipType = sipType_QgsProcessingParameterEnum;
381 sipType = sipType_QgsProcessingParameterString;
383 sipType = sipType_QgsProcessingParameterExpression;
385 sipType = sipType_QgsProcessingParameterAuthConfig;
387 sipType = sipType_QgsProcessingParameterVectorLayer;
389 sipType = sipType_QgsProcessingParameterField;
391 sipType = sipType_QgsProcessingParameterFeatureSource;
393 sipType = sipType_QgsProcessingParameterFeatureSink;
395 sipType = sipType_QgsProcessingParameterVectorDestination;
397 sipType = sipType_QgsProcessingParameterRasterDestination;
399 sipType = sipType_QgsProcessingParameterPointCloudDestination;
401 sipType = sipType_QgsProcessingParameterFileDestination;
403 sipType = sipType_QgsProcessingParameterFolderDestination;
405 sipType = sipType_QgsProcessingParameterBand;
407 sipType = sipType_QgsProcessingParameterLayout;
409 sipType = sipType_QgsProcessingParameterLayoutItem;
411 sipType = sipType_QgsProcessingParameterColor;
413 sipType = sipType_QgsProcessingParameterCoordinateOperation;
415 sipType = sipType_QgsProcessingParameterMapTheme;
417 sipType = sipType_QgsProcessingParameterDateTime;
419 sipType = sipType_QgsProcessingParameterProviderConnection;
421 sipType = sipType_QgsProcessingParameterDatabaseSchema;
423 sipType = sipType_QgsProcessingParameterDatabaseTable;
425 sipType = sipType_QgsProcessingParameterFieldMapping;
427 sipType = sipType_QgsProcessingParameterTinInputLayers;
429 sipType = sipType_QgsProcessingParameterVectorTileWriterLayers;
431 sipType = sipType_QgsProcessingParameterDxfLayers;
433 sipType = sipType_QgsProcessingParameterMeshDatasetGroups;
435 sipType = sipType_QgsProcessingParameterMeshDatasetTime;
437 sipType = sipType_QgsProcessingParameterPointCloudLayer;
439 sipType = sipType_QgsProcessingParameterAnnotationLayer;
441 sipType = sipType_QgsProcessingParameterPointCloudAttribute;
443 sipType = sipType_QgsProcessingParameterVectorTileDestination;
455 bool optional =
false,
const QString &help = QString() );
467 virtual QString
type()
const = 0;
481 QString
name()
const {
return mName; }
488 void setName(
const QString &name ) { mName = name; }
502 void setDescription(
const QString &description ) { mDescription = description; }
513 QString
help()
const {
return mHelp; }
524 void setHelp(
const QString &help ) { mHelp = help; }
554 QVariant guiDefaultValueOverride()
const;
581 QVariant defaultValueForGui()
const;
602 virtual bool checkValueIsAcceptable(
const QVariant &input,
QgsProcessingContext *context =
nullptr )
const;
611 virtual QString valueAsPythonString(
const QVariant &value,
QgsProcessingContext &context )
const;
624 virtual QVariant valueAsJsonObject(
const QVariant &value,
QgsProcessingContext &context )
const;
661 virtual QString valueAsPythonComment(
const QVariant &value,
QgsProcessingContext &context )
const;
667 virtual QString asScriptCode()
const;
685 virtual QVariantMap toVariantMap()
const;
692 virtual bool fromVariantMap(
const QVariantMap &map );
714 void setMetadata(
const QVariantMap &metadata ) { mMetadata = metadata; }
740 virtual QString toolTip()
const;
847 AllowMapLayerValues = 1 << 0,
879 QVariant defaultGuiValueFromSetting()
const;
906 bool mIsDynamic =
false;
955 static bool isDynamic(
const QVariantMap ¶meters,
const QString &name );
1746 static QString descriptionFromName(
const QString &name );
1757 static bool parseScriptCodeParameterOptions(
const QString &code,
bool &isOptional, QString &name, QString &type, QString &definition );
1775 bool optional =
false );
1780 static QString
typeName() {
return QStringLiteral(
"boolean" ); }
1783 QString valueAsPythonString(
const QVariant &value,
QgsProcessingContext &context )
const override;
1784 QString asScriptCode()
const override;
1804 QgsProcessingParameterCrs(
const QString &name,
const QString &description = QString(),
const QVariant &defaultValue = QVariant(),
1805 bool optional =
false );
1810 static QString
typeName() {
return QStringLiteral(
"crs" ); }
1813 bool checkValueIsAcceptable(
const QVariant &input,
QgsProcessingContext *context =
nullptr )
const override;
1814 QString valueAsPythonString(
const QVariant &value,
QgsProcessingContext &context )
const override;
1816 QVariant valueAsJsonObject(
const QVariant &value,
QgsProcessingContext &context )
const override;
1838 bool optional =
false );
1843 static QString
typeName() {
return QStringLiteral(
"extent" ); }
1846 bool checkValueIsAcceptable(
const QVariant &input,
QgsProcessingContext *context =
nullptr )
const override;
1847 QString valueAsPythonString(
const QVariant &value,
QgsProcessingContext &context )
const override;
1849 QVariant valueAsJsonObject(
const QVariant &value,
QgsProcessingContext &context )
const override;
1871 QgsProcessingParameterPoint(
const QString &name,
const QString &description = QString(),
const QVariant &defaultValue = QVariant(),
1872 bool optional =
false );
1877 static QString
typeName() {
return QStringLiteral(
"point" ); }
1880 bool checkValueIsAcceptable(
const QVariant &input,
QgsProcessingContext *context =
nullptr )
const override;
1881 QString valueAsPythonString(
const QVariant &value,
QgsProcessingContext &context )
const override;
1907 QgsProcessingParameterGeometry(
const QString &name,
const QString &description = QString(),
const QVariant &defaultValue = QVariant(),
bool optional =
false,
const QList< int > &geometryTypes = QList< int >(),
bool allowMultipart =
true );
1912 static QString
typeName() {
return QStringLiteral(
"geometry" ); }
1915 bool checkValueIsAcceptable(
const QVariant &input,
QgsProcessingContext *context =
nullptr )
const override;
1916 QString valueAsPythonString(
const QVariant &value,
QgsProcessingContext &context )
const override;
1917 QString asScriptCode()
const override;
1919 QVariantMap toVariantMap()
const override;
1920 bool fromVariantMap(
const QVariantMap &map )
override;
1955 QList<int> mGeomTypes;
1956 bool mAllowMultipart;
1977 bool optional =
false,
const QString &fileFilter = QString() );
1982 static QString
typeName() {
return QStringLiteral(
"file" ); }
1985 bool checkValueIsAcceptable(
const QVariant &input,
QgsProcessingContext *context =
nullptr )
const override;
1986 QString asScriptCode()
const override;
1988 QString createFileFilter()
const override;
2020 void setExtension(
const QString &extension );
2028 QString fileFilter()
const;
2039 void setFileFilter(
const QString &filter );
2041 QVariantMap toVariantMap()
const override;
2042 bool fromVariantMap(
const QVariantMap &map )
override;
2053 QString mFileFilter;
2069 bool hasFixedNumberRows =
false,
const QStringList &headers = QStringList(),
2070 const QVariant &defaultValue = QVariant(),
2071 bool optional =
false );
2076 static QString
typeName() {
return QStringLiteral(
"matrix" ); }
2079 bool checkValueIsAcceptable(
const QVariant &input,
QgsProcessingContext *context =
nullptr )
const override;
2080 QString valueAsPythonString(
const QVariant &value,
QgsProcessingContext &context )
const override;
2087 QStringList headers()
const;
2093 void setHeaders(
const QStringList &headers );
2101 int numberRows()
const;
2109 void setNumberRows(
int rows );
2116 bool hasFixedNumberRows()
const;
2123 void setHasFixedNumberRows(
bool hasFixedNumberRows );
2125 QVariantMap toVariantMap()
const override;
2126 bool fromVariantMap(
const QVariantMap &map )
override;
2135 QStringList mHeaders;
2136 int mNumberRows = 3;
2137 bool mFixedNumberRows =
false;
2154 const QVariant &defaultValue = QVariant(),
2155 bool optional =
false );
2160 static QString
typeName() {
return QStringLiteral(
"multilayer" ); }
2163 bool checkValueIsAcceptable(
const QVariant &input,
QgsProcessingContext *context =
nullptr )
const override;
2164 QString valueAsPythonString(
const QVariant &value,
QgsProcessingContext &context )
const override;
2166 QVariant valueAsJsonObject(
const QVariant &value,
QgsProcessingContext &context )
const override;
2167 QString asScriptCode()
const override;
2169 QString createFileFilter()
const override;
2188 int minimumNumberInputs()
const;
2195 void setMinimumNumberInputs(
int minimum );
2197 QVariantMap toVariantMap()
const override;
2198 bool fromVariantMap(
const QVariantMap &map )
override;
2208 int mMinimumNumberInputs = 0;
2238 const QVariant &defaultValue = QVariant(),
2239 bool optional =
false,
2240 double minValue = std::numeric_limits<double>::lowest() + 1,
2241 double maxValue = std::numeric_limits<double>::max()
2247 static QString
typeName() {
return QStringLiteral(
"number" ); }
2250 bool checkValueIsAcceptable(
const QVariant &input,
QgsProcessingContext *context =
nullptr )
const override;
2251 QString valueAsPythonString(
const QVariant &value,
QgsProcessingContext &context )
const override;
2252 QString toolTip()
const override;
2259 double minimum()
const;
2265 void setMinimum(
double minimum );
2271 double maximum()
const;
2277 void setMaximum(
double maximum );
2291 QVariantMap toVariantMap()
const override;
2292 bool fromVariantMap(
const QVariantMap &map )
override;
2301 double mMin = std::numeric_limits<double>::lowest() + 1;
2302 double mMax = std::numeric_limits<double>::max();
2333 const QVariant &defaultValue = QVariant(),
2334 const QString &parentParameterName = QString(),
2335 bool optional =
false,
2336 double minValue = std::numeric_limits<double>::lowest() + 1,
2337 double maxValue = std::numeric_limits<double>::max() );
2342 static QString
typeName() {
return QStringLiteral(
"distance" ); }
2346 QString type() const override;
2347 QStringList dependsOnOtherParameters() const override;
2348 QString asPythonString(
QgsProcessing::PythonOutputType outputType =
QgsProcessing::PythonOutputType::PythonQgsProcessingAlgorithmSubclass ) const override;
2354 QString parentParameterName() const;
2360 void setParentParameterName( const QString &parentParameterName );
2368 Qgis::DistanceUnit defaultUnit()
const {
return mDefaultUnit; }
2378 QVariantMap toVariantMap()
const override;
2379 bool fromVariantMap(
const QVariantMap &map )
override;
2383 QString mParentParameterName;
2403 const QVariant &defaultValue = QVariant(),
2404 bool optional =
false,
2405 double minValue = std::numeric_limits<double>::lowest() + 1,
2406 double maxValue = std::numeric_limits<double>::max() );
2411 static QString
typeName() {
return QStringLiteral(
"duration" ); }
2415 QString type() const override;
2416 QString asPythonString(
QgsProcessing::PythonOutputType outputType =
QgsProcessing::PythonOutputType::PythonQgsProcessingAlgorithmSubclass ) const override;
2423 Qgis::TemporalUnit defaultUnit()
const {
return mDefaultUnit; }
2432 QVariantMap toVariantMap()
const override;
2433 bool fromVariantMap(
const QVariantMap &map )
override;
2459 const QVariant &defaultValue = QVariant(),
2460 bool optional =
false );
2465 static QString
typeName() {
return QStringLiteral(
"scale" ); }
2469 QString type() const override;
2470 QString asPythonString(
QgsProcessing::PythonOutputType outputType =
QgsProcessing::PythonOutputType::PythonQgsProcessingAlgorithmSubclass ) const override;
2493 const QVariant &defaultValue = QVariant(),
2494 bool optional =
false );
2499 static QString
typeName() {
return QStringLiteral(
"range" ); }
2502 bool checkValueIsAcceptable(
const QVariant &input,
QgsProcessingContext *context =
nullptr )
const override;
2503 QString valueAsPythonString(
const QVariant &value,
QgsProcessingContext &context )
const override;
2518 QVariantMap toVariantMap()
const override;
2519 bool fromVariantMap(
const QVariantMap &map )
override;
2544 bool optional =
false );
2549 static QString
typeName() {
return QStringLiteral(
"raster" ); }
2552 bool checkValueIsAcceptable(
const QVariant &input,
QgsProcessingContext *context =
nullptr )
const override;
2553 QString valueAsPythonString(
const QVariant &value,
QgsProcessingContext &context )
const override;
2555 QVariant valueAsJsonObject(
const QVariant &value,
QgsProcessingContext &context )
const override;
2556 QString createFileFilter()
const override;
2589 QgsProcessingParameterEnum(
const QString &name,
const QString &description = QString(),
const QStringList &options = QStringList(),
2590 bool allowMultiple =
false,
2591 const QVariant &defaultValue = QVariant(),
2592 bool optional =
false,
2593 bool usesStaticStrings =
false );
2598 static QString
typeName() {
return QStringLiteral(
"enum" ); }
2601 bool checkValueIsAcceptable(
const QVariant &input,
QgsProcessingContext *context =
nullptr )
const override;
2602 QString valueAsPythonString(
const QVariant &value,
QgsProcessingContext &context )
const override;
2603 QString valueAsPythonComment(
const QVariant &value,
QgsProcessingContext &context )
const override;
2604 QString asScriptCode()
const override;
2611 QStringList options()
const;
2617 void setOptions(
const QStringList &options );
2623 bool allowMultiple()
const;
2629 void setAllowMultiple(
bool allowMultiple );
2637 bool usesStaticStrings()
const;
2645 void setUsesStaticStrings(
bool usesStaticStrings );
2647 QVariantMap toVariantMap()
const override;
2648 bool fromVariantMap(
const QVariantMap &map )
override;
2657 QStringList mOptions;
2658 bool mAllowMultiple =
false;
2659 bool mUsesStaticStrings =
false;
2696 bool multiLine =
false,
2697 bool optional =
false );
2702 static QString
typeName() {
return QStringLiteral(
"string" ); }
2705 QString valueAsPythonString(
const QVariant &value,
QgsProcessingContext &context )
const override;
2706 QString asScriptCode()
const override;
2713 bool multiLine()
const;
2719 void setMultiLine(
bool multiLine );
2721 QVariantMap toVariantMap()
const override;
2722 bool fromVariantMap(
const QVariantMap &map )
override;
2731 bool mMultiLine =
false;
2756 bool optional =
false );
2761 static QString
typeName() {
return QStringLiteral(
"authcfg" ); }
2764 QString valueAsPythonString(
const QVariant &value,
QgsProcessingContext &context )
const override;
2765 QString asScriptCode()
const override;
2787 const QString &parentLayerParameterName = QString(),
2793 static QString
typeName() {
return QStringLiteral(
"expression" ); }
2796 QString valueAsPythonString(
const QVariant &value,
QgsProcessingContext &context )
const override;
2797 QStringList dependsOnOtherParameters()
const override;
2804 QString parentLayerParameterName()
const;
2810 void setParentLayerParameterName(
const QString &parentLayerParameterName );
2828 QVariantMap toVariantMap()
const override;
2829 bool fromVariantMap(
const QVariantMap &map )
override;
2838 QString mParentLayerParameterName;
2861 QList< int > dataTypes()
const;
2867 void setDataTypes(
const QList< int > &types );
2889 const QString &description = QString(),
2890 const QList< int > &types = QList< int >(),
2891 const QVariant &defaultValue = QVariant(),
2892 bool optional =
false );
2897 static QString
typeName() {
return QStringLiteral(
"vector" ); }
2900 bool checkValueIsAcceptable(
const QVariant &input,
QgsProcessingContext *context =
nullptr )
const override;
2901 QString valueAsPythonString(
const QVariant &value,
QgsProcessingContext &context )
const override;
2903 QVariant valueAsJsonObject(
const QVariant &value,
QgsProcessingContext &context )
const override;
2905 QString createFileFilter()
const override;
2907 QVariantMap toVariantMap()
const override;
2908 bool fromVariantMap(
const QVariantMap &map )
override;
2931 const QString &description = QString(),
2932 const QVariant &defaultValue = QVariant(),
2933 bool optional =
false );
2938 static QString
typeName() {
return QStringLiteral(
"mesh" ); }
2941 bool checkValueIsAcceptable(
const QVariant &input,
QgsProcessingContext *context =
nullptr )
const override;
2942 QString valueAsPythonString(
const QVariant &value,
QgsProcessingContext &context )
const override;
2944 QVariant valueAsJsonObject(
const QVariant &value,
QgsProcessingContext &context )
const override;
2945 QString createFileFilter()
const override;
2966 bool optional =
false,
2967 const QList< int > &types = QList< int >() );
2972 static QString
typeName() {
return QStringLiteral(
"layer" ); }
2975 bool checkValueIsAcceptable(
const QVariant &input,
QgsProcessingContext *context =
nullptr )
const override;
2976 QString valueAsPythonString(
const QVariant &value,
QgsProcessingContext &context )
const override;
2978 QVariant valueAsJsonObject(
const QVariant &value,
QgsProcessingContext &context )
const override;
2979 QString asScriptCode()
const override;
2981 QString createFileFilter()
const override;
2983 QVariantMap toVariantMap()
const override;
2984 bool fromVariantMap(
const QVariantMap &map )
override;
3005 QgsProcessingParameterField(
const QString &name,
const QString &description = QString(),
const QVariant &defaultValue = QVariant(),
3006 const QString &parentLayerParameterName = QString(),
3008 bool allowMultiple =
false,
3009 bool optional =
false,
3010 bool defaultToAllFields =
false );
3015 static QString
typeName() {
return QStringLiteral(
"field" ); }
3018 bool checkValueIsAcceptable(
const QVariant &input,
QgsProcessingContext *context =
nullptr )
const override;
3019 QString valueAsPythonString(
const QVariant &value,
QgsProcessingContext &context )
const override;
3020 QString asScriptCode()
const override;
3022 QStringList dependsOnOtherParameters()
const override;
3028 QString parentLayerParameterName()
const;
3034 void setParentLayerParameterName(
const QString &parentLayerParameterName );
3052 bool allowMultiple()
const;
3058 void setAllowMultiple(
bool allowMultiple );
3069 bool defaultToAllFields()
const;
3080 void setDefaultToAllFields(
bool enabled );
3082 QVariantMap toVariantMap()
const override;
3083 bool fromVariantMap(
const QVariantMap &map )
override;
3092 QString mParentLayerParameterName;
3094 bool mAllowMultiple =
false;
3095 bool mDefaultToAllFields =
false;
3113 const QList< int > &types = QList< int >(),
3114 const QVariant &defaultValue = QVariant(),
bool optional =
false );
3119 static QString
typeName() {
return QStringLiteral(
"source" ); }
3122 bool checkValueIsAcceptable(
const QVariant &input,
QgsProcessingContext *context =
nullptr )
const override;
3123 QString valueAsPythonString(
const QVariant &value,
QgsProcessingContext &context )
const override;
3125 QVariant valueAsJsonObject(
const QVariant &value,
QgsProcessingContext &context )
const override;
3126 QString asScriptCode()
const override;
3128 QString createFileFilter()
const override;
3130 QVariantMap toVariantMap()
const override;
3131 bool fromVariantMap(
const QVariantMap &map )
override;
3157 bool optional =
false,
bool createByDefault =
true );
3160 QVariantMap toVariantMap()
const override;
3161 bool fromVariantMap(
const QVariantMap &map )
override;
3163 QString createFileFilter()
const override;
3196 virtual QString generateTemporaryDestination(
const QgsProcessingContext *context =
nullptr )
const;
3219 bool createByDefault()
const;
3226 void setCreateByDefault(
bool createByDefault );
3251 bool mSupportsNonFileBasedOutputs =
true;
3252 bool mCreateByDefault =
true;
3254 friend class QgsProcessingModelAlgorithm;
3255 friend class TestQgsProcessing;
3256 friend class TestQgsProcessingModelAlgorithm;
3278 bool optional =
false,
bool createByDefault =
true,
bool supportsAppend =
false );
3283 static QString
typeName() {
return QStringLiteral(
"sink" ); }
3286 bool checkValueIsAcceptable(
const QVariant &input,
QgsProcessingContext *context =
nullptr )
const override;
3287 QString valueAsPythonString(
const QVariant &value,
QgsProcessingContext &context )
const override;
3288 QString asScriptCode()
const override;
3290 QString defaultFileExtension() const override;
3291 QString asPythonString(
QgsProcessing::PythonOutputType outputType =
QgsProcessing::PythonOutputType::PythonQgsProcessingAlgorithmSubclass ) const override;
3292 QString createFileFilter() const override;
3299 virtual QStringList supportedOutputVectorLayerExtensions() const;
3305 Qgis::ProcessingSourceType dataType() const;
3311 bool hasGeometry() const;
3317 void setDataType(
Qgis::ProcessingSourceType type );
3327 bool supportsAppend() const;
3337 void setSupportsAppend(
bool supportsAppend );
3339 QVariantMap toVariantMap() const override;
3340 bool fromVariantMap( const QVariantMap &map ) override;
3341 QString generateTemporaryDestination( const
QgsProcessingContext *context =
nullptr ) const override;
3350 Qgis::ProcessingSourceType mDataType =
Qgis::ProcessingSourceType::VectorAnyGeometry;
3351 bool mSupportsAppend = false;
3375 bool optional =
false,
bool createByDefault =
true );
3380 static QString
typeName() {
return QStringLiteral(
"vectorDestination" ); }
3383 bool checkValueIsAcceptable(
const QVariant &input,
QgsProcessingContext *context =
nullptr )
const override;
3384 QString valueAsPythonString(
const QVariant &value,
QgsProcessingContext &context )
const override;
3385 QString asScriptCode()
const override;
3387 QString defaultFileExtension() const override;
3388 QString asPythonString(
QgsProcessing::PythonOutputType outputType =
QgsProcessing::PythonOutputType::PythonQgsProcessingAlgorithmSubclass ) const override;
3389 QString createFileFilter() const override;
3396 virtual QStringList supportedOutputVectorLayerExtensions() const;
3402 Qgis::ProcessingSourceType dataType() const;
3408 bool hasGeometry() const;
3414 void setDataType(
Qgis::ProcessingSourceType type );
3416 QVariantMap toVariantMap() const override;
3417 bool fromVariantMap( const QVariantMap &map ) override;
3427 Qgis::ProcessingSourceType mDataType =
Qgis::ProcessingSourceType::VectorAnyGeometry;
3447 const QVariant &defaultValue = QVariant(),
3448 bool optional =
false,
3449 bool createByDefault =
true );
3454 static QString
typeName() {
return QStringLiteral(
"rasterDestination" ); }
3457 bool checkValueIsAcceptable(
const QVariant &input,
QgsProcessingContext *context =
nullptr )
const override;
3458 QString valueAsPythonString(
const QVariant &value,
QgsProcessingContext &context )
const override;
3460 QString defaultFileExtension() const override;
3461 QString createFileFilter() const override;
3468 virtual QStringList supportedOutputRasterLayerExtensions() const;
3507 const QString &fileFilter = QString(),
3508 const QVariant &defaultValue = QVariant(),
3509 bool optional =
false,
3510 bool createByDefault =
true );
3515 static QString
typeName() {
return QStringLiteral(
"fileDestination" ); }
3518 bool checkValueIsAcceptable(
const QVariant &input,
QgsProcessingContext *context =
nullptr )
const override;
3519 QString valueAsPythonString(
const QVariant &value,
QgsProcessingContext &context )
const override;
3521 QString defaultFileExtension() const override;
3522 QString asPythonString(
QgsProcessing::PythonOutputType outputType =
QgsProcessing::PythonOutputType::PythonQgsProcessingAlgorithmSubclass ) const override;
3523 QString createFileFilter() const override;
3529 QString fileFilter() const;
3535 void setFileFilter( const QString &filter );
3537 QVariantMap toVariantMap() const override;
3538 bool fromVariantMap( const QVariantMap &map ) override;
3548 QString mFileFilter;
3565 const QVariant &defaultValue = QVariant(),
3566 bool optional =
false,
3567 bool createByDefault =
true );
3572 static QString
typeName() {
return QStringLiteral(
"folderDestination" ); }
3575 bool checkValueIsAcceptable(
const QVariant &input,
QgsProcessingContext *context =
nullptr )
const override;
3577 QString defaultFileExtension() const override;
3598 QgsProcessingParameterBand(
const QString &name,
const QString &description = QString(),
const QVariant &defaultValue = QVariant(),
3599 const QString &parentLayerParameterName = QString(),
3600 bool optional =
false,
3601 bool allowMultiple =
false );
3606 static QString
typeName() {
return QStringLiteral(
"band" ); }
3609 bool checkValueIsAcceptable(
const QVariant &input,
QgsProcessingContext *context =
nullptr )
const override;
3610 QString valueAsPythonString(
const QVariant &value,
QgsProcessingContext &context )
const override;
3611 QString asScriptCode()
const override;
3612 QStringList dependsOnOtherParameters()
const override;
3619 QString parentLayerParameterName()
const;
3625 void setParentLayerParameterName(
const QString &parentLayerParameterName );
3627 QVariantMap toVariantMap()
const override;
3628 bool fromVariantMap(
const QVariantMap &map )
override;
3640 bool allowMultiple()
const;
3647 void setAllowMultiple(
bool allowMultiple );
3651 QString mParentLayerParameterName;
3652 bool mAllowMultiple =
false;
3674 bool optional =
false );
3679 static QString
typeName() {
return QStringLiteral(
"layout" ); }
3682 QString valueAsPythonString(
const QVariant &value,
QgsProcessingContext &context )
const override;
3683 QString asScriptCode()
const override;
3712 const QString &parentLayoutParameterName = QString(),
3714 bool optional =
false );
3719 static QString
typeName() {
return QStringLiteral(
"layoutitem" ); }
3722 QString valueAsPythonString(
const QVariant &value,
QgsProcessingContext &context )
const override;
3723 QString asScriptCode()
const override;
3725 QVariantMap toVariantMap()
const override;
3726 bool fromVariantMap(
const QVariantMap &map )
override;
3727 QStringList dependsOnOtherParameters()
const override;
3738 QString parentLayoutParameterName()
const;
3744 void setParentLayoutParameterName(
const QString &name );
3753 int itemType()
const;
3762 void setItemType(
int type );
3765 QString mParentLayoutParameterName;
3787 QgsProcessingParameterColor(
const QString &name,
const QString &description = QString(),
const QVariant &defaultValue = QVariant(),
3788 bool opacityEnabled =
true,
3789 bool optional =
false );
3794 static QString
typeName() {
return QStringLiteral(
"color" ); }
3797 QString valueAsPythonString(
const QVariant &value,
QgsProcessingContext &context )
const override;
3798 QString asScriptCode()
const override;
3800 bool checkValueIsAcceptable(
const QVariant &input,
QgsProcessingContext *context =
nullptr )
const override;
3801 QVariantMap toVariantMap()
const override;
3802 bool fromVariantMap(
const QVariantMap &map )
override;
3810 bool opacityEnabled()
const;
3819 void setOpacityEnabled(
bool enabled );
3828 bool mAllowOpacity =
true;
3850 const QString &sourceCrsParameterName = QString(),
const QString &destinationCrsParameterName = QString(),
3851 const QVariant &staticSourceCrs = QVariant(),
const QVariant &staticDestinationCrs = QVariant(),
3852 bool optional =
false );
3857 static QString
typeName() {
return QStringLiteral(
"coordinateoperation" ); }
3860 QString valueAsPythonString(
const QVariant &value,
QgsProcessingContext &context )
const override;
3861 QString asScriptCode()
const override;
3863 QStringList dependsOnOtherParameters()
const override;
3865 QVariantMap toVariantMap()
const override;
3866 bool fromVariantMap(
const QVariantMap &map )
override;
3931 QString mSourceParameterName;
3932 QString mDestParameterName;
3933 QVariant mSourceCrs;
3956 bool optional =
false );
3961 static QString
typeName() {
return QStringLiteral(
"maptheme" ); }
3964 bool checkValueIsAcceptable(
const QVariant &input,
QgsProcessingContext *context =
nullptr )
const override;
3965 QString valueAsPythonString(
const QVariant &value,
QgsProcessingContext &context )
const override;
3966 QString asScriptCode()
const override;
3968 QVariantMap toVariantMap()
const override;
3969 bool fromVariantMap(
const QVariantMap &map )
override;
4000 const QVariant &defaultValue = QVariant(),
4001 bool optional =
false,
4002 const QDateTime &minValue = QDateTime(),
4003 const QDateTime &maxValue = QDateTime()
4009 static QString
typeName() {
return QStringLiteral(
"datetime" ); }
4012 bool checkValueIsAcceptable(
const QVariant &input,
QgsProcessingContext *context =
nullptr )
const override;
4013 QString valueAsPythonString(
const QVariant &value,
QgsProcessingContext &context )
const override;
4014 QString toolTip()
const override;
4024 QDateTime minimum()
const;
4037 void setMinimum(
const QDateTime &minimum );
4046 QDateTime maximum()
const;
4059 void setMaximum(
const QDateTime &maximum );
4073 QVariantMap toVariantMap()
const override;
4074 bool fromVariantMap(
const QVariantMap &map )
override;
4110 bool optional =
false );
4115 static QString
typeName() {
return QStringLiteral(
"providerconnection" ); }
4118 bool checkValueIsAcceptable(
const QVariant &input,
QgsProcessingContext *context =
nullptr )
const override;
4119 QString valueAsPythonString(
const QVariant &value,
QgsProcessingContext &context )
const override;
4120 QString asScriptCode()
const override;
4122 QVariantMap toVariantMap()
const override;
4123 bool fromVariantMap(
const QVariantMap &map )
override;
4144 QString mProviderId;
4170 QgsProcessingParameterDatabaseSchema(
const QString &name,
const QString &description,
const QString &connectionParameterName = QString(),
const QVariant &defaultValue = QVariant(),
4171 bool optional =
false );
4176 static QString
typeName() {
return QStringLiteral(
"databaseschema" ); }
4179 bool checkValueIsAcceptable(
const QVariant &input,
QgsProcessingContext *context =
nullptr )
const override;
4180 QString valueAsPythonString(
const QVariant &value,
QgsProcessingContext &context )
const override;
4181 QString asScriptCode()
const override;
4183 QVariantMap toVariantMap()
const override;
4184 bool fromVariantMap(
const QVariantMap &map )
override;
4185 QStringList dependsOnOtherParameters()
const override;
4191 QString parentConnectionParameterName()
const;
4197 void setParentConnectionParameterName(
const QString &name );
4206 QString mParentConnectionParameterName;
4234 const QString &connectionParameterName = QString(),
4235 const QString &schemaParameterName = QString(),
4236 const QVariant &defaultValue = QVariant(),
4237 bool optional =
false,
4238 bool allowNewTableNames =
false );
4243 static QString
typeName() {
return QStringLiteral(
"databasetable" ); }
4246 bool checkValueIsAcceptable(
const QVariant &input,
QgsProcessingContext *context =
nullptr )
const override;
4247 QString valueAsPythonString(
const QVariant &value,
QgsProcessingContext &context )
const override;
4248 QString asScriptCode()
const override;
4250 QVariantMap toVariantMap()
const override;
4251 bool fromVariantMap(
const QVariantMap &map )
override;
4252 QStringList dependsOnOtherParameters()
const override;
4258 QString parentConnectionParameterName()
const;
4264 void setParentConnectionParameterName(
const QString &name );
4270 QString parentSchemaParameterName()
const;
4276 void setParentSchemaParameterName(
const QString &name );
4289 bool allowNewTableNames()
const;
4297 void setAllowNewTableNames(
bool allowed );
4301 QString mParentConnectionParameterName;
4302 QString mParentSchemaParameterName;
4303 bool mAllowNewTableNames =
false;
4321 const QVariant &defaultValue = QVariant(),
bool optional =
false );
4326 static QString
typeName() {
return QStringLiteral(
"pointcloud" ); }
4329 bool checkValueIsAcceptable(
const QVariant &input,
QgsProcessingContext *context =
nullptr )
const override;
4330 QString valueAsPythonString(
const QVariant &value,
QgsProcessingContext &context )
const override;
4332 QVariant valueAsJsonObject(
const QVariant &value,
QgsProcessingContext &context )
const override;
4333 QString createFileFilter()
const override;
4356 const QVariant &defaultValue = QVariant(),
bool optional =
false );
4361 static QString
typeName() {
return QStringLiteral(
"annotation" ); }
4364 bool checkValueIsAcceptable(
const QVariant &input,
QgsProcessingContext *context =
nullptr )
const override;
4365 QString valueAsPythonString(
const QVariant &value,
QgsProcessingContext &context )
const override;
4367 QVariant valueAsJsonObject(
const QVariant &value,
QgsProcessingContext &context )
const override;
4393 const QVariant &defaultValue = QVariant(),
4394 bool optional =
false,
4395 bool createByDefault =
true );
4400 static QString
typeName() {
return QStringLiteral(
"pointCloudDestination" ); }
4403 bool checkValueIsAcceptable(
const QVariant &input,
QgsProcessingContext *context =
nullptr )
const override;
4404 QString valueAsPythonString(
const QVariant &value,
QgsProcessingContext &context )
const override;
4406 QString defaultFileExtension() const override;
4407 QString createFileFilter() const override;
4413 virtual QStringList supportedOutputPointCloudLayerExtensions() const;
4435 const QString &parentLayerParameterName = QString(),
4436 bool allowMultiple =
false,
4437 bool optional =
false,
4438 bool defaultToAllAttributes =
false );
4443 static QString
typeName() {
return QStringLiteral(
"attribute" ); }
4446 bool checkValueIsAcceptable(
const QVariant &input,
QgsProcessingContext *context =
nullptr )
const override;
4447 QString valueAsPythonString(
const QVariant &value,
QgsProcessingContext &context )
const override;
4448 QString asScriptCode()
const override;
4450 QStringList dependsOnOtherParameters()
const override;
4456 QString parentLayerParameterName()
const;
4462 void setParentLayerParameterName(
const QString &parentLayerParameterName );
4468 bool allowMultiple()
const;
4474 void setAllowMultiple(
bool allowMultiple );
4484 bool defaultToAllAttributes()
const;
4494 void setDefaultToAllAttributes(
bool enabled );
4496 QVariantMap toVariantMap()
const override;
4497 bool fromVariantMap(
const QVariantMap &map )
override;
4506 QString mParentLayerParameterName;
4507 bool mAllowMultiple =
false;
4508 bool mDefaultToAllAttributes =
false;
4529 const QVariant &defaultValue = QVariant(),
4530 bool optional =
false,
4531 bool createByDefault =
true );
4536 static QString
typeName() {
return QStringLiteral(
"vectorTileDestination" ); }
4539 bool checkValueIsAcceptable(
const QVariant &input,
QgsProcessingContext *context =
nullptr )
const override;
4540 QString valueAsPythonString(
const QVariant &value,
QgsProcessingContext &context )
const override;
4542 QString defaultFileExtension() const override;
4543 QString createFileFilter() const override;
4549 virtual QStringList supportedOutputVectorTileLayerExtensions() const;
The Qgis class provides global constants for use throughout the application.
ProcessingSourceType
Processing data source types.
@ VectorAnyGeometry
Any vector layer with geometry.
ProcessingFileParameterBehavior
Flags which dictate the behavior of QgsProcessingParameterFile.
@ File
Parameter is a single file.
ExpressionType
Expression types.
@ Qgis
Native QGIS expression.
DistanceUnit
Units of distance.
@ Unknown
Unknown distance unit.
ProcessingFieldParameterDataType
Processing field parameter data types.
TemporalUnit
Temporal units.
@ Milliseconds
Milliseconds.
QFlags< ProcessingParameterFlag > ProcessingParameterFlags
Flags which dictate the behavior of Processing parameters.
InvalidGeometryCheck
Methods for handling of features with invalid geometries.
@ AbortOnInvalid
Close iterator on encountering any features with invalid geometry. This requires a slow geometry vali...
QFlags< ProcessingFeatureSourceDefinitionFlag > ProcessingFeatureSourceDefinitionFlags
Flags which control behavior for a Processing feature source.
WkbType
The WKB type describes the number of dimensions a geometry has.
ProcessingDateTimeParameterDataType
Processing date time parameter data types.
@ DateTime
Datetime values.
ProcessingNumberParameterType
Processing numeric parameter data types.
Represents a map layer containing a set of georeferenced annotations, e.g.
This class represents a coordinate reference system (CRS).
An interface for objects which accept features via addFeature(s) methods.
QFlags< SinkFlag > SinkFlags
Container of fields for a vector layer.
Abstract interface for classes which generate a file filter string.
A geometry is the spatial representation of a feature.
Base class for graphical items within a QgsLayout.
Base class for all map layer types.
Represents a mesh layer supporting display of data on structured or unstructured meshes.
Represents a map layer supporting display of point clouds.
A class to represent a 2D point.
Print layout, a QgsLayout subclass for static or atlas-based layouts.
Abstract base class for processing algorithms.
Contains information about the context in which a processing algorithm is executed.
Base class for all parameter definitions which represent file or layer destinations,...
virtual QString defaultFileExtension() const =0
Returns the default file extension for destination file paths associated with this parameter.
bool supportsNonFileBasedOutput() const
Returns true if the destination parameter supports non filed-based outputs, such as memory layers or ...
bool isDestination() const override
Returns true if this parameter represents a file or layer destination, e.g.
virtual QgsProcessingOutputDefinition * toOutputDefinition() const =0
Returns a new QgsProcessingOutputDefinition corresponding to the definition of the destination parame...
QgsProcessingProvider * originalProvider() const
Original (source) provider which this parameter has been derived from.
void setSupportsNonFileBasedOutput(bool supportsNonFileBasedOutput)
Sets whether the destination parameter supports non filed-based outputs, such as memory layers or dir...
Custom exception class for processing related exceptions.
Encapsulates settings relating to a feature source input to a processing algorithm.
bool operator!=(const QgsProcessingFeatureSourceDefinition &other) const
bool selectedFeaturesOnly
true if only selected features in the source should be used by algorithms.
bool operator==(const QgsProcessingFeatureSourceDefinition &other) const
QgsProperty source
Source definition.
Qgis::InvalidGeometryCheck geometryCheck
Geometry check method to apply to this source.
QgsProcessingFeatureSourceDefinition(const QgsProperty &source, bool selectedFeaturesOnly=false, long long featureLimit=-1, Qgis::ProcessingFeatureSourceDefinitionFlags flags=Qgis::ProcessingFeatureSourceDefinitionFlags(), Qgis::InvalidGeometryCheck geometryCheck=Qgis::InvalidGeometryCheck::AbortOnInvalid, const QString &filterExpression=QString())
Constructor for QgsProcessingFeatureSourceDefinition, accepting a QgsProperty source.
QgsProcessingFeatureSourceDefinition(const QString &source=QString(), bool selectedFeaturesOnly=false, long long featureLimit=-1, Qgis::ProcessingFeatureSourceDefinitionFlags flags=Qgis::ProcessingFeatureSourceDefinitionFlags(), Qgis::InvalidGeometryCheck geometryCheck=Qgis::InvalidGeometryCheck::AbortOnInvalid, const QString &filterExpression=QString())
Constructor for QgsProcessingFeatureSourceDefinition, accepting a static string source.
Qgis::ProcessingFeatureSourceDefinitionFlags flags
Flags which dictate source behavior.
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...
QString filterExpression
Optional expression filter to use for filtering features which will be read from the source.
QgsFeatureSource subclass which proxies methods to an underlying QgsFeatureSource,...
Base class for providing feedback from a processing algorithm.
Base class for the definition of processing outputs.
Encapsulates settings relating to a feature sink or output raster layer for a processing algorithm.
QgsProcessingOutputLayerDefinition(const QgsProperty &sink, QgsProject *destinationProject=nullptr)
Constructor for QgsProcessingOutputLayerDefinition, accepting a QgsProperty sink/layer.
QgsProperty sink
Sink/layer definition.
bool useRemapping() const
Returns true if the output uses a remapping definition.
QgsProcessingOutputLayerDefinition(const QString &sink=QString(), QgsProject *destinationProject=nullptr)
Constructor for QgsProcessingOutputLayerDefinition, accepting a static sink/layer string.
QgsRemappingSinkDefinition remappingDefinition() const
Returns the output remapping definition, if useRemapping() is true.
QString destinationName
Name to use for sink if it's to be loaded into a destination project.
QVariantMap createOptions
Map of optional sink/layer creation options, which are passed to the underlying provider when creatin...
An annotation layer parameter for processing algorithms.
static QString typeName()
Returns the type name for the parameter class.
A string parameter for authentication configuration ID values.
static QString typeName()
Returns the type name for the parameter class.
A raster band parameter for Processing algorithms.
static QString typeName()
Returns the type name for the parameter class.
A boolean parameter for processing algorithms.
static QString typeName()
Returns the type name for the parameter class.
A color parameter for processing algorithms.
static QString typeName()
Returns the type name for the parameter class.
A coordinate operation parameter for processing algorithms, for selection between available coordinat...
static QString typeName()
Returns the type name for the parameter class.
QVariant sourceCrs() const
Returns the static source CRS, or an invalid value if this is not set.
QString destinationCrsParameterName() const
Returns the name of the destination CRS parameter, or an empty string if this is not set.
void setDestinationCrsParameterName(const QString &name)
Sets the name of the destination CRS parameter.
void setSourceCrs(const QVariant &crs)
Sets the static source crs.
QVariant destinationCrs() const
Returns the static destination CRS, or an invalid value if this is not set.
void setDestinationCrs(const QVariant &crs)
Sets the static destination crs.
void setSourceCrsParameterName(const QString &name)
Sets the name of the source CRS parameter.
QString sourceCrsParameterName() const
Returns the name of the source CRS parameter, or an empty string if this is not set.
A coordinate reference system parameter for processing algorithms.
static QString typeName()
Returns the type name for the parameter class.
A database schema parameter for processing algorithms, allowing users to select from existing schemas...
static QString typeName()
Returns the type name for the parameter class.
A database table name parameter for processing algorithms, allowing users to select from existing dat...
static QString typeName()
Returns the type name for the parameter class.
A datetime (or pure date or time) parameter for processing algorithms.
static QString typeName()
Returns the type name for the parameter class.
Base class for the definition of processing parameters.
QString mHelp
Parameter help.
QVariant defaultValue() const
Returns the default value for the parameter.
void setDefaultValue(const QVariant &value)
Sets the default value for the parameter.
QStringList additionalExpressionContextVariables() const
Returns a list of additional expression context variables which are available for use when evaluating...
QStringList mAdditionalExpressionVariables
Additional expression context variables exposed for use by this parameter.
QString help() const
Returns the help for the parameter.
Qgis::ProcessingParameterFlags mFlags
Parameter flags.
QFlags< ValueAsStringFlag > ValueAsStringFlags
void setMetadata(const QVariantMap &metadata)
Sets the parameter's freeform metadata.
void setFlags(Qgis::ProcessingParameterFlags flags)
Sets the flags associated with the parameter.
ValueAsStringFlag
Flags for passing to the valueAsStringPrivate() method.
QString mName
Parameter name.
void setGuiDefaultValueOverride(const QVariant &value)
Sets the default value to use for the parameter in GUI widgets.
QVariantMap metadata() const
Returns the parameter's freeform metadata.
QString description() const
Returns the description for the parameter.
QString mDynamicLayerParameterName
Linked vector layer parameter name for dynamic properties.
virtual bool isDestination() const
Returns true if this parameter represents a file or layer destination, e.g.
void setDescription(const QString &description)
Sets the description for the parameter.
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...
QString dynamicLayerParameterName() const
Returns the name of the parameter for a layer linked to a dynamic parameter, or an empty string if th...
void setAdditionalExpressionContextVariables(const QStringList &variables)
Sets a list of additional expression context variables which are available for use when evaluating th...
QVariantMap mMetadata
Freeform metadata for parameter. Mostly used by widget wrappers to customize their appearance and beh...
void setName(const QString &name)
Sets the name of the parameter.
QString mDescription
Parameter description.
virtual QgsProcessingParameterDefinition * clone() const =0
Creates a clone of the parameter definition.
virtual QString type() const =0
Unique parameter type name.
void setDynamicPropertyDefinition(const QgsPropertyDefinition &definition)
Sets the property definition for dynamic properties.
void setHelp(const QString &help)
Sets the help for the parameter.
QString name() const
Returns the name of the parameter.
QVariant mDefault
Default value for parameter.
virtual QStringList dependsOnOtherParameters() const
Returns a list of other parameter names on which this parameter is dependent (e.g.
void setIsDynamic(bool dynamic)
Sets whether the parameter is dynamic, and can support data-defined values (i.e.
Qgis::ProcessingParameterFlags flags() const
Returns any flags associated with the parameter.
QVariant mGuiDefault
Default value for parameter in GUI.
QgsPropertyDefinition mPropertyDefinition
Data defined property definition.
bool isDynamic() const
Returns true if the parameter supports is dynamic, and can support data-defined values (i....
virtual ~QgsProcessingParameterDefinition()=default
QVariantMap & metadata()
Returns the parameter's freeform metadata.
QgsPropertyDefinition dynamicPropertyDefinition() const
Returns the property definition for dynamic properties.
A double numeric parameter for distance values.
static QString typeName()
Returns the type name for the parameter class.
void setDefaultUnit(Qgis::DistanceUnit unit)
Sets the default distance unit for the parameter.
A double numeric parameter for duration values.
void setDefaultUnit(Qgis::TemporalUnit unit)
Sets the default duration unit for the parameter.
static QString typeName()
Returns the type name for the parameter class.
static QString typeName()
Returns the type name for the parameter class.
An enum based parameter for processing algorithms, allowing for selection from predefined values.
static QString typeName()
Returns the type name for the parameter class.
An expression parameter for processing algorithms.
static QString typeName()
Returns the type name for the parameter class.
A rectangular map extent parameter for processing algorithms.
static QString typeName()
Returns the type name for the parameter class.
A feature sink output for processing algorithms.
static QString typeName()
Returns the type name for the parameter class.
An input feature source (such as vector layers) parameter for processing algorithms.
static QString typeName()
Returns the type name for the parameter class.
static QString typeName()
Returns the type name for the parameter class.
A vector layer or feature source field parameter for processing algorithms.
static QString typeName()
Returns the type name for the parameter class.
A generic file based destination parameter, for specifying the destination path for a file (non-map l...
static QString typeName()
Returns the type name for the parameter class.
An input file or folder parameter for processing algorithms.
QString extension() const
Returns any specified file extension for the parameter.
static QString typeName()
Returns the type name for the parameter class.
void setBehavior(Qgis::ProcessingFileParameterBehavior behavior)
Sets the parameter behavior (e.g.
Qgis::ProcessingFileParameterBehavior behavior() const
Returns the parameter behavior (e.g.
A folder destination parameter, for specifying the destination path for a folder created by the algor...
static QString typeName()
Returns the type name for the parameter class.
A geometry parameter for processing algorithms.
void setGeometryTypes(const QList< int > &geometryTypes)
Sets the allowed geometryTypes, as a list of Qgis::GeometryType values.
bool allowMultipart() const
Returns the parameter allow multipart geometries.
QList< int > geometryTypes() const
Returns the parameter allowed geometries, as a list of Qgis::GeometryType values.
void setAllowMultipart(bool allowMultipart)
Sets the allow multipart geometries.
static QString typeName()
Returns the type name for the parameter class.
A print layout item parameter, allowing users to select a particular item from a print layout.
static QString typeName()
Returns the type name for the parameter class.
A print layout parameter, allowing users to select a print layout.
static QString typeName()
Returns the type name for the parameter class.
Can be inherited by parameters which require limits to their acceptable data types.
QList< int > mDataTypes
List of acceptable data types for the parameter.
A map layer parameter for processing algorithms.
static QString typeName()
Returns the type name for the parameter class.
A map theme parameter for processing algorithms, allowing users to select an existing map theme from ...
static QString typeName()
Returns the type name for the parameter class.
A table (matrix) parameter for processing algorithms.
static QString typeName()
Returns the type name for the parameter class.
static QString typeName()
Returns the type name for the parameter class.
static QString typeName()
Returns the type name for the parameter class.
A mesh layer parameter for processing algorithms.
static QString typeName()
Returns the type name for the parameter class.
A parameter for processing algorithms which accepts multiple map layers.
static QString typeName()
Returns the type name for the parameter class.
A numeric parameter for processing algorithms.
static QString typeName()
Returns the type name for the parameter class.
A point cloud layer attribute parameter for Processing algorithms.
static QString typeName()
Returns the type name for the parameter class.
A point cloud layer destination parameter, for specifying the destination path for a point cloud laye...
static QString typeName()
Returns the type name for the parameter class.
A point cloud layer parameter for processing algorithms.
static QString typeName()
Returns the type name for the parameter class.
A point parameter for processing algorithms.
static QString typeName()
Returns the type name for the parameter class.
A data provider connection parameter for processing algorithms, allowing users to select from availab...
static QString typeName()
Returns the type name for the parameter class.
void setProviderId(const QString &provider)
Sets the ID of the provider associated with the connections.
QString providerId() const
Returns the ID of the provider associated with the connections.
A numeric range parameter for processing algorithms.
static QString typeName()
Returns the type name for the parameter class.
A raster layer destination parameter, for specifying the destination path for a raster layer created ...
static QString typeName()
Returns the type name for the parameter class.
A raster layer parameter for processing algorithms.
static QString typeName()
Returns the type name for the parameter class.
A double numeric parameter for map scale values.
static QString typeName()
Returns the type name for the parameter class.
A string parameter for processing algorithms.
static QString typeName()
Returns the type name for the parameter class.
A vector layer destination parameter, for specifying the destination path for a vector layer created ...
static QString typeName()
Returns the type name for the parameter class.
A vector layer (with or without geometry) parameter for processing algorithms.
static QString typeName()
Returns the type name for the parameter class.
A vector tile layer destination parameter, for specifying the destination path for a vector tile laye...
static QString typeName()
Returns the type name for the parameter class.
static QString typeName()
Returns the type name for the parameter class.
A collection of utilities for working with parameters when running a processing algorithm.
Abstract base class for processing providers.
LayerHint
Layer type hints.
@ UnknownType
Unknown layer type.
Contains enumerations and other constants for use in processing algorithms and parameters.
QFlags< LayerOptionsFlag > LayerOptionsFlags
PythonOutputType
Available Python output types.
@ PythonQgsProcessingAlgorithmSubclass
Full Python QgsProcessingAlgorithm subclass.
Encapsulates a QGIS project, including sets of map layers and their styles, layouts,...
Definition for a property.
A store for object properties.
Represents a raster layer.
A rectangle specified with double values.
Defines the parameters used to remap features when creating a QgsRemappingProxyFeatureSink.
Represents a vector layer which manages a vector based data sets.
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
#define SIP_CONVERT_TO_SUBCLASS_CODE(code)
#define SIP_THROW(name,...)
Q_DECLARE_METATYPE(QgsDatabaseQueryLogEntry)
bool operator==(const QgsFeatureIterator &fi1, const QgsFeatureIterator &fi2)
bool operator!=(const QgsFeatureIterator &fi1, const QgsFeatureIterator &fi2)
QList< const QgsProcessingParameterDefinition * > QgsProcessingParameterDefinitions
List of processing parameters.
Q_DECLARE_OPERATORS_FOR_FLAGS(QgsTextRendererUtils::CurvedTextFlags)
const QgsCoordinateReferenceSystem & crs