18#ifndef QGSPROCESSINGPARAMETERS_H
19#define QGSPROCESSINGPARAMETERS_H
184 return !( *
this == other );
188 operator QVariant()
const
190 return QVariant::fromValue( *
this );
278 return !( *
this == other );
282 operator QVariant()
const
284 return QVariant::fromValue( *
this );
383 QString
format()
const {
return mFormat; }
400 QVariant toVariant()
const;
408 bool loadVariant(
const QVariantMap &map );
411 operator QVariant()
const
413 return QVariant::fromValue( *
this );
422 bool mUseRemapping =
false;
462 sipType = sipType_QgsProcessingParameterBoolean;
464 sipType = sipType_QgsProcessingParameterCrs;
466 sipType = sipType_QgsProcessingParameterMapLayer;
468 sipType = sipType_QgsProcessingParameterExtent;
470 sipType = sipType_QgsProcessingParameterPoint;
472 sipType = sipType_QgsProcessingParameterGeometry;
474 sipType = sipType_QgsProcessingParameterFile;
476 sipType = sipType_QgsProcessingParameterMatrix;
478 sipType = sipType_QgsProcessingParameterMultipleLayers;
480 sipType = sipType_QgsProcessingParameterNumber;
482 sipType = sipType_QgsProcessingParameterDistance;
484 sipType = sipType_QgsProcessingParameterArea;
486 sipType = sipType_QgsProcessingParameterVolume;
488 sipType = sipType_QgsProcessingParameterDuration;
490 sipType = sipType_QgsProcessingParameterScale;
492 sipType = sipType_QgsProcessingParameterRange;
494 sipType = sipType_QgsProcessingParameterRasterLayer;
496 sipType = sipType_QgsProcessingParameterMeshLayer;
498 sipType = sipType_QgsProcessingParameterEnum;
500 sipType = sipType_QgsProcessingParameterString;
502 sipType = sipType_QgsProcessingParameterExpression;
504 sipType = sipType_QgsProcessingParameterAuthConfig;
506 sipType = sipType_QgsProcessingParameterVectorLayer;
508 sipType = sipType_QgsProcessingParameterField;
510 sipType = sipType_QgsProcessingParameterFeatureSource;
512 sipType = sipType_QgsProcessingParameterFeatureSink;
514 sipType = sipType_QgsProcessingParameterVectorDestination;
516 sipType = sipType_QgsProcessingParameterRasterDestination;
518 sipType = sipType_QgsProcessingParameterPointCloudDestination;
520 sipType = sipType_QgsProcessingParameterFileDestination;
522 sipType = sipType_QgsProcessingParameterFolderDestination;
524 sipType = sipType_QgsProcessingParameterBand;
526 sipType = sipType_QgsProcessingParameterLayout;
528 sipType = sipType_QgsProcessingParameterLayoutItem;
530 sipType = sipType_QgsProcessingParameterColor;
532 sipType = sipType_QgsProcessingParameterCoordinateOperation;
534 sipType = sipType_QgsProcessingParameterMapTheme;
536 sipType = sipType_QgsProcessingParameterDateTime;
538 sipType = sipType_QgsProcessingParameterProviderConnection;
540 sipType = sipType_QgsProcessingParameterDatabaseSchema;
542 sipType = sipType_QgsProcessingParameterDatabaseTable;
544 sipType = sipType_QgsProcessingParameterFieldMapping;
546 sipType = sipType_QgsProcessingParameterTinInputLayers;
548 sipType = sipType_QgsProcessingParameterVectorTileWriterLayers;
550 sipType = sipType_QgsProcessingParameterDxfLayers;
552 sipType = sipType_QgsProcessingParameterMeshDatasetGroups;
554 sipType = sipType_QgsProcessingParameterMeshDatasetTime;
556 sipType = sipType_QgsProcessingParameterPointCloudLayer;
558 sipType = sipType_QgsProcessingParameterAnnotationLayer;
560 sipType = sipType_QgsProcessingParameterPointCloudAttribute;
562 sipType = sipType_QgsProcessingParameterVectorTileDestination;
574 bool optional =
false,
const QString &
help = QString() );
603 virtual QString
type()
const = 0;
690 QVariant guiDefaultValueOverride()
const;
717 QVariant defaultValueForGui()
const;
738 virtual bool checkValueIsAcceptable(
const QVariant &input,
QgsProcessingContext *context =
nullptr )
const;
747 virtual QString valueAsPythonString(
const QVariant &value,
QgsProcessingContext &context )
const;
760 virtual QVariant valueAsJsonObject(
const QVariant &value,
QgsProcessingContext &context )
const;
797 virtual QString valueAsPythonComment(
const QVariant &value,
QgsProcessingContext &context )
const;
803 virtual QString asScriptCode()
const;
821 virtual QVariantMap toVariantMap()
const;
828 virtual bool fromVariantMap(
const QVariantMap &map );
876 virtual QString toolTip()
const;
983 AllowMapLayerValues = 1 << 0,
1091 static bool isDynamic(
const QVariantMap ¶meters,
const QString &name );
1906 static bool parseScriptCodeParameterOptions(
const QString &code,
bool &isOptional, QString &name, QString &type, QString &definition );
1924 bool optional =
false );
1929 static QString
typeName() {
return QStringLiteral(
"boolean" ); }
1932 QString valueAsPythonString(
const QVariant &value,
QgsProcessingContext &context )
const override;
1933 QString asScriptCode()
const override;
1954 bool optional =
false );
1961 static QString
typeName() {
return QStringLiteral(
"crs" ); }
1964 bool checkValueIsAcceptable(
const QVariant &input,
QgsProcessingContext *context =
nullptr )
const override;
1965 QString valueAsPythonString(
const QVariant &value,
QgsProcessingContext &context )
const override;
1967 QVariant valueAsJsonObject(
const QVariant &value,
QgsProcessingContext &context )
const override;
1989 bool optional =
false );
1994 static QString
typeName() {
return QStringLiteral(
"extent" ); }
1997 bool checkValueIsAcceptable(
const QVariant &input,
QgsProcessingContext *context =
nullptr )
const override;
1998 QString valueAsPythonString(
const QVariant &value,
QgsProcessingContext &context )
const override;
2000 QVariant valueAsJsonObject(
const QVariant &value,
QgsProcessingContext &context )
const override;
2014 static bool variantIsValidStringForExtent(
const QVariant &value );
2032 bool optional =
false );
2037 static QString
typeName() {
return QStringLiteral(
"point" ); }
2040 bool checkValueIsAcceptable(
const QVariant &input,
QgsProcessingContext *context =
nullptr )
const override;
2041 QString valueAsPythonString(
const QVariant &value,
QgsProcessingContext &context )
const override;
2072 static QString
typeName() {
return QStringLiteral(
"geometry" ); }
2075 bool checkValueIsAcceptable(
const QVariant &input,
QgsProcessingContext *context =
nullptr )
const override;
2076 QString valueAsPythonString(
const QVariant &value,
QgsProcessingContext &context )
const override;
2077 QString asScriptCode()
const override;
2079 QVariantMap toVariantMap()
const override;
2080 bool fromVariantMap(
const QVariantMap &map )
override;
2106 QString userFriendlyString(
const QVariant &value )
const override;
2115 QList<int> mGeomTypes;
2116 bool mAllowMultipart;
2137 bool optional =
false,
const QString &
fileFilter = QString() );
2142 static QString
typeName() {
return QStringLiteral(
"file" ); }
2145 bool checkValueIsAcceptable(
const QVariant &input,
QgsProcessingContext *context =
nullptr )
const override;
2146 QString asScriptCode()
const override;
2148 QString createFileFilter()
const override;
2180 void setExtension(
const QString &extension );
2188 QString fileFilter()
const;
2199 void setFileFilter(
const QString &filter );
2201 QVariantMap toVariantMap()
const override;
2202 bool fromVariantMap(
const QVariantMap &map )
override;
2213 QString mFileFilter;
2231 bool optional =
false );
2236 static QString
typeName() {
return QStringLiteral(
"matrix" ); }
2240 bool checkValueIsAcceptable(
const QVariant &input,
QgsProcessingContext *context =
nullptr )
const override;
2241 QString valueAsPythonString(
const QVariant &value,
QgsProcessingContext &context )
const override;
2248 QStringList headers()
const;
2254 void setHeaders(
const QStringList &headers );
2262 int numberRows()
const;
2270 void setNumberRows(
int rows );
2277 bool hasFixedNumberRows()
const;
2284 void setHasFixedNumberRows(
bool hasFixedNumberRows );
2286 QVariantMap toVariantMap()
const override;
2287 bool fromVariantMap(
const QVariantMap &map )
override;
2296 QStringList mHeaders;
2297 int mNumberRows = 3;
2298 bool mFixedNumberRows =
false;
2316 bool optional =
false );
2321 static QString
typeName() {
return QStringLiteral(
"multilayer" ); }
2324 bool checkValueIsAcceptable(
const QVariant &input,
QgsProcessingContext *context =
nullptr )
const override;
2325 QString valueAsPythonString(
const QVariant &value,
QgsProcessingContext &context )
const override;
2327 QVariant valueAsJsonObject(
const QVariant &value,
QgsProcessingContext &context )
const override;
2328 QString asScriptCode()
const override;
2330 QString createFileFilter()
const override;
2349 int minimumNumberInputs()
const;
2356 void setMinimumNumberInputs(
int minimum );
2358 QVariantMap toVariantMap()
const override;
2359 bool fromVariantMap(
const QVariantMap &map )
override;
2369 int mMinimumNumberInputs = 0;
2400 bool optional =
false,
2401 double minValue = std::numeric_limits<double>::lowest() + 1,
2402 double maxValue = std::numeric_limits<double>::max()
2408 static QString
typeName() {
return QStringLiteral(
"number" ); }
2412 bool checkValueIsAcceptable(
const QVariant &input,
QgsProcessingContext *context =
nullptr )
const override;
2413 QString valueAsPythonString(
const QVariant &value,
QgsProcessingContext &context )
const override;
2414 QString toolTip()
const override;
2421 double minimum()
const;
2427 void setMinimum(
double minimum );
2433 double maximum()
const;
2439 void setMaximum(
double maximum );
2453 QVariantMap toVariantMap()
const override;
2454 bool fromVariantMap(
const QVariantMap &map )
override;
2463 double mMin = std::numeric_limits<double>::lowest() + 1;
2464 double mMax = std::numeric_limits<double>::max();
2499 bool optional =
false,
2500 double minValue = std::numeric_limits<double>::lowest() + 1,
2501 double maxValue = std::numeric_limits<double>::max() );
2506 static QString
typeName() {
return QStringLiteral(
"distance" ); }
2508 QString userFriendlyString(
const QVariant &value )
const override;
2512 QString type() const override;
2513 QStringList dependsOnOtherParameters() const override;
2514 QString asPythonString(
QgsProcessing::PythonOutputType outputType =
QgsProcessing::PythonOutputType::PythonQgsProcessingAlgorithmSubclass ) const override;
2520 QString parentParameterName() const;
2526 void setParentParameterName( const QString &parentParameterName );
2544 QVariantMap toVariantMap()
const override;
2545 bool fromVariantMap(
const QVariantMap &map )
override;
2549 QString mParentParameterName;
2586 bool optional =
false,
2587 double minValue = 0,
2588 double maxValue = std::numeric_limits<double>::max() );
2593 static QString
typeName() {
return QStringLiteral(
"area" ); }
2597 QString type() const override;
2598 QStringList dependsOnOtherParameters() const override;
2599 QString asPythonString(
QgsProcessing::PythonOutputType outputType =
QgsProcessing::PythonOutputType::PythonQgsProcessingAlgorithmSubclass ) const override;
2605 QString parentParameterName() const;
2611 void setParentParameterName( const QString &parentParameterName );
2627 QVariantMap toVariantMap()
const override;
2628 bool fromVariantMap(
const QVariantMap &map )
override;
2629 QString userFriendlyString(
const QVariant &value )
const override;
2633 QString mParentParameterName;
2670 bool optional =
false,
2671 double minValue = 0,
2672 double maxValue = std::numeric_limits<double>::max() );
2677 static QString
typeName() {
return QStringLiteral(
"volume" ); }
2681 QString type() const override;
2682 QStringList dependsOnOtherParameters() const override;
2683 QString asPythonString(
QgsProcessing::PythonOutputType outputType =
QgsProcessing::PythonOutputType::PythonQgsProcessingAlgorithmSubclass ) const override;
2689 QString parentParameterName() const;
2695 void setParentParameterName( const QString &parentParameterName );
2711 QVariantMap toVariantMap()
const override;
2712 bool fromVariantMap(
const QVariantMap &map )
override;
2713 QString userFriendlyString(
const QVariant &value )
const override;
2717 QString mParentParameterName;
2740 bool optional =
false,
2741 double minValue = std::numeric_limits<double>::lowest() + 1,
2742 double maxValue = std::numeric_limits<double>::max() );
2747 static QString
typeName() {
return QStringLiteral(
"duration" ); }
2751 QString type() const override;
2752 QString asPythonString(
QgsProcessing::PythonOutputType outputType =
QgsProcessing::PythonOutputType::PythonQgsProcessingAlgorithmSubclass ) const override;
2768 QVariantMap toVariantMap()
const override;
2769 bool fromVariantMap(
const QVariantMap &map )
override;
2770 QString userFriendlyString(
const QVariant &value )
const override;
2797 bool optional =
false );
2802 static QString
typeName() {
return QStringLiteral(
"scale" ); }
2806 QString type() const override;
2807 QString asPythonString(
QgsProcessing::PythonOutputType outputType =
QgsProcessing::PythonOutputType::PythonQgsProcessingAlgorithmSubclass ) const override;
2831 bool optional =
false );
2836 static QString
typeName() {
return QStringLiteral(
"range" ); }
2840 bool checkValueIsAcceptable(
const QVariant &input,
QgsProcessingContext *context =
nullptr )
const override;
2841 QString valueAsPythonString(
const QVariant &value,
QgsProcessingContext &context )
const override;
2856 QVariantMap toVariantMap()
const override;
2857 bool fromVariantMap(
const QVariantMap &map )
override;
2882 bool optional =
false );
2887 static QString
typeName() {
return QStringLiteral(
"raster" ); }
2890 bool checkValueIsAcceptable(
const QVariant &input,
QgsProcessingContext *context =
nullptr )
const override;
2891 QString valueAsPythonString(
const QVariant &value,
QgsProcessingContext &context )
const override;
2893 QVariant valueAsJsonObject(
const QVariant &value,
QgsProcessingContext &context )
const override;
2894 QString createFileFilter()
const override;
2946 bool optional =
false,
2954 static QString
typeName() {
return QStringLiteral(
"enum" ); }
2957 bool checkValueIsAcceptable(
const QVariant &input,
QgsProcessingContext *context =
nullptr )
const override;
2958 QString valueAsPythonString(
const QVariant &value,
QgsProcessingContext &context )
const override;
2959 QString valueAsPythonComment(
const QVariant &value,
QgsProcessingContext &context )
const override;
2960 QString asScriptCode()
const override;
2967 QStringList options()
const;
2973 void setOptions(
const QStringList &options );
2979 bool allowMultiple()
const;
2985 void setAllowMultiple(
bool allowMultiple );
2993 bool usesStaticStrings()
const;
3001 void setUsesStaticStrings(
bool usesStaticStrings );
3003 QVariantMap toVariantMap()
const override;
3004 bool fromVariantMap(
const QVariantMap &map )
override;
3013 QStringList mOptions;
3014 bool mAllowMultiple =
false;
3015 bool mUsesStaticStrings =
false;
3053 bool optional =
false );
3058 static QString
typeName() {
return QStringLiteral(
"string" ); }
3061 QString valueAsPythonString(
const QVariant &value,
QgsProcessingContext &context )
const override;
3062 QString asScriptCode()
const override;
3069 bool multiLine()
const;
3075 void setMultiLine(
bool multiLine );
3077 QVariantMap toVariantMap()
const override;
3078 bool fromVariantMap(
const QVariantMap &map )
override;
3087 bool mMultiLine =
false;
3112 bool optional =
false );
3117 static QString
typeName() {
return QStringLiteral(
"authcfg" ); }
3120 QString valueAsPythonString(
const QVariant &value,
QgsProcessingContext &context )
const override;
3121 QString asScriptCode()
const override;
3149 static QString
typeName() {
return QStringLiteral(
"expression" ); }
3152 QString valueAsPythonString(
const QVariant &value,
QgsProcessingContext &context )
const override;
3153 QStringList dependsOnOtherParameters()
const override;
3160 QString parentLayerParameterName()
const;
3166 void setParentLayerParameterName(
const QString &parentLayerParameterName );
3184 QVariantMap toVariantMap()
const override;
3185 bool fromVariantMap(
const QVariantMap &map )
override;
3194 QString mParentLayerParameterName;
3247 const QList< int > &types = QList< int >(),
3249 bool optional =
false );
3254 static QString
typeName() {
return QStringLiteral(
"vector" ); }
3257 bool checkValueIsAcceptable(
const QVariant &input,
QgsProcessingContext *context =
nullptr )
const override;
3258 QString valueAsPythonString(
const QVariant &value,
QgsProcessingContext &context )
const override;
3260 QVariant valueAsJsonObject(
const QVariant &value,
QgsProcessingContext &context )
const override;
3262 QString createFileFilter()
const override;
3264 QVariantMap toVariantMap()
const override;
3265 bool fromVariantMap(
const QVariantMap &map )
override;
3290 bool optional =
false );
3295 static QString
typeName() {
return QStringLiteral(
"mesh" ); }
3298 bool checkValueIsAcceptable(
const QVariant &input,
QgsProcessingContext *context =
nullptr )
const override;
3299 QString valueAsPythonString(
const QVariant &value,
QgsProcessingContext &context )
const override;
3301 QVariant valueAsJsonObject(
const QVariant &value,
QgsProcessingContext &context )
const override;
3302 QString createFileFilter()
const override;
3323 bool optional =
false,
3324 const QList< int > &types = QList< int >() );
3329 static QString
typeName() {
return QStringLiteral(
"layer" ); }
3332 bool checkValueIsAcceptable(
const QVariant &input,
QgsProcessingContext *context =
nullptr )
const override;
3333 QString valueAsPythonString(
const QVariant &value,
QgsProcessingContext &context )
const override;
3335 QVariant valueAsJsonObject(
const QVariant &value,
QgsProcessingContext &context )
const override;
3336 QString asScriptCode()
const override;
3338 QString createFileFilter()
const override;
3340 QVariantMap toVariantMap()
const override;
3341 bool fromVariantMap(
const QVariantMap &map )
override;
3366 bool optional =
false,
3372 static QString
typeName() {
return QStringLiteral(
"field" ); }
3375 bool checkValueIsAcceptable(
const QVariant &input,
QgsProcessingContext *context =
nullptr )
const override;
3376 QString valueAsPythonString(
const QVariant &value,
QgsProcessingContext &context )
const override;
3377 QString asScriptCode()
const override;
3379 QStringList dependsOnOtherParameters()
const override;
3385 QString parentLayerParameterName()
const;
3391 void setParentLayerParameterName(
const QString &parentLayerParameterName );
3409 bool allowMultiple()
const;
3415 void setAllowMultiple(
bool allowMultiple );
3426 bool defaultToAllFields()
const;
3437 void setDefaultToAllFields(
bool enabled );
3439 QVariantMap toVariantMap()
const override;
3440 bool fromVariantMap(
const QVariantMap &map )
override;
3449 QString mParentLayerParameterName;
3451 bool mAllowMultiple =
false;
3452 bool mDefaultToAllFields =
false;
3470 const QList< int > &types = QList< int >(),
3471 const QVariant &
defaultValue = QVariant(),
bool optional =
false );
3476 static QString
typeName() {
return QStringLiteral(
"source" ); }
3479 bool checkValueIsAcceptable(
const QVariant &input,
QgsProcessingContext *context =
nullptr )
const override;
3480 QString valueAsPythonString(
const QVariant &value,
QgsProcessingContext &context )
const override;
3482 QVariant valueAsJsonObject(
const QVariant &value,
QgsProcessingContext &context )
const override;
3483 QString asScriptCode()
const override;
3485 QString createFileFilter()
const override;
3487 QVariantMap toVariantMap()
const override;
3488 bool fromVariantMap(
const QVariantMap &map )
override;
3517 QVariantMap toVariantMap()
const override;
3518 bool fromVariantMap(
const QVariantMap &map )
override;
3520 QString createFileFilter()
const override;
3608 bool mSupportsNonFileBasedOutputs =
true;
3609 bool mCreateByDefault =
true;
3640 static QString
typeName() {
return QStringLiteral(
"sink" ); }
3643 bool checkValueIsAcceptable(
const QVariant &input,
QgsProcessingContext *context =
nullptr )
const override;
3644 QString valueAsPythonString(
const QVariant &value,
QgsProcessingContext &context )
const override;
3645 QString asScriptCode()
const override;
3647 QString defaultFileExtension() const override;
3648 QString asPythonString(
QgsProcessing::PythonOutputType outputType =
QgsProcessing::PythonOutputType::PythonQgsProcessingAlgorithmSubclass ) const override;
3649 QString createFileFilter() const override;
3656 virtual QStringList supportedOutputVectorLayerExtensions() const;
3662 Qgis::ProcessingSourceType dataType() const;
3668 bool hasGeometry() const;
3674 void setDataType(
Qgis::ProcessingSourceType type );
3684 bool supportsAppend() const;
3694 void setSupportsAppend(
bool supportsAppend );
3696 QVariantMap toVariantMap() const override;
3697 bool fromVariantMap( const QVariantMap &map ) override;
3698 QString generateTemporaryDestination( const
QgsProcessingContext *context =
nullptr ) const override;
3707 Qgis::ProcessingSourceType mDataType =
Qgis::ProcessingSourceType::VectorAnyGeometry;
3708 bool mSupportsAppend = false;
3737 static QString
typeName() {
return QStringLiteral(
"vectorDestination" ); }
3740 bool checkValueIsAcceptable(
const QVariant &input,
QgsProcessingContext *context =
nullptr )
const override;
3741 QString valueAsPythonString(
const QVariant &value,
QgsProcessingContext &context )
const override;
3742 QString asScriptCode()
const override;
3744 QString defaultFileExtension() const override;
3745 QString asPythonString(
QgsProcessing::PythonOutputType outputType =
QgsProcessing::PythonOutputType::PythonQgsProcessingAlgorithmSubclass ) const override;
3746 QString createFileFilter() const override;
3753 virtual QStringList supportedOutputVectorLayerExtensions() const;
3759 Qgis::ProcessingSourceType dataType() const;
3765 bool hasGeometry() const;
3771 void setDataType(
Qgis::ProcessingSourceType type );
3773 QVariantMap toVariantMap() const override;
3774 bool fromVariantMap( const QVariantMap &map ) override;
3784 Qgis::ProcessingSourceType mDataType =
Qgis::ProcessingSourceType::VectorAnyGeometry;
3805 bool optional =
false,
3811 static QString
typeName() {
return QStringLiteral(
"rasterDestination" ); }
3814 bool checkValueIsAcceptable(
const QVariant &input,
QgsProcessingContext *context =
nullptr )
const override;
3815 QString valueAsPythonString(
const QVariant &value,
QgsProcessingContext &context )
const override;
3817 QString defaultFileExtension() const override;
3825 QString defaultFileFormat() const;
3827 QString createFileFilter() const override;
3835 Q_DECL_DEPRECATED virtual QStringList supportedOutputRasterLayerExtensions() const
SIP_DEPRECATED;
3842 virtual QList<QPair<QString, QString>> supportedOutputRasterLayerFormatAndExtensions() const;
3883 bool optional =
false,
3889 static QString
typeName() {
return QStringLiteral(
"fileDestination" ); }
3892 bool checkValueIsAcceptable(
const QVariant &input,
QgsProcessingContext *context =
nullptr )
const override;
3893 QString valueAsPythonString(
const QVariant &value,
QgsProcessingContext &context )
const override;
3895 QString defaultFileExtension() const override;
3896 QString asPythonString(
QgsProcessing::PythonOutputType outputType =
QgsProcessing::PythonOutputType::PythonQgsProcessingAlgorithmSubclass ) const override;
3897 QString createFileFilter() const override;
3903 QString fileFilter() const;
3909 void setFileFilter( const QString &filter );
3911 QVariantMap toVariantMap() const override;
3912 bool fromVariantMap( const QVariantMap &map ) override;
3922 QString mFileFilter;
3940 bool optional =
false,
3946 static QString
typeName() {
return QStringLiteral(
"folderDestination" ); }
3949 bool checkValueIsAcceptable(
const QVariant &input,
QgsProcessingContext *context =
nullptr )
const override;
3951 QString defaultFileExtension() const override;
3974 bool optional =
false,
3980 static QString
typeName() {
return QStringLiteral(
"band" ); }
3983 bool checkValueIsAcceptable(
const QVariant &input,
QgsProcessingContext *context =
nullptr )
const override;
3984 QString valueAsPythonString(
const QVariant &value,
QgsProcessingContext &context )
const override;
3985 QString asScriptCode()
const override;
3986 QStringList dependsOnOtherParameters()
const override;
3993 QString parentLayerParameterName()
const;
3999 void setParentLayerParameterName(
const QString &parentLayerParameterName );
4001 QVariantMap toVariantMap()
const override;
4002 bool fromVariantMap(
const QVariantMap &map )
override;
4014 bool allowMultiple()
const;
4021 void setAllowMultiple(
bool allowMultiple );
4025 QString mParentLayerParameterName;
4026 bool mAllowMultiple =
false;
4048 bool optional =
false );
4053 static QString
typeName() {
return QStringLiteral(
"layout" ); }
4056 QString valueAsPythonString(
const QVariant &value,
QgsProcessingContext &context )
const override;
4057 QString asScriptCode()
const override;
4088 bool optional =
false );
4093 static QString
typeName() {
return QStringLiteral(
"layoutitem" ); }
4096 QString valueAsPythonString(
const QVariant &value,
QgsProcessingContext &context )
const override;
4097 QString asScriptCode()
const override;
4099 QVariantMap toVariantMap()
const override;
4100 bool fromVariantMap(
const QVariantMap &map )
override;
4101 QStringList dependsOnOtherParameters()
const override;
4112 QString parentLayoutParameterName()
const;
4118 void setParentLayoutParameterName(
const QString &name );
4127 int itemType()
const;
4136 void setItemType(
int type );
4139 QString mParentLayoutParameterName;
4163 bool optional =
false );
4168 static QString
typeName() {
return QStringLiteral(
"color" ); }
4172 QString valueAsPythonString(
const QVariant &value,
QgsProcessingContext &context )
const override;
4173 QString asScriptCode()
const override;
4175 bool checkValueIsAcceptable(
const QVariant &input,
QgsProcessingContext *context =
nullptr )
const override;
4176 QVariantMap toVariantMap()
const override;
4177 bool fromVariantMap(
const QVariantMap &map )
override;
4185 bool opacityEnabled()
const;
4194 void setOpacityEnabled(
bool enabled );
4203 bool mAllowOpacity =
true;
4228 const QVariant &staticSourceCrs = QVariant(),
const QVariant &staticDestinationCrs = QVariant(),
4229 bool optional =
false );
4234 static QString
typeName() {
return QStringLiteral(
"coordinateoperation" ); }
4237 QString valueAsPythonString(
const QVariant &value,
QgsProcessingContext &context )
const override;
4238 QString asScriptCode()
const override;
4240 QStringList dependsOnOtherParameters()
const override;
4242 QVariantMap toVariantMap()
const override;
4243 bool fromVariantMap(
const QVariantMap &map )
override;
4307 QString valueAsPythonStringPrivate(
const QVariant &value,
QgsProcessingContext &context,
bool allowNonStringValues )
const ;
4309 QString mSourceParameterName;
4310 QString mDestParameterName;
4311 QVariant mSourceCrs;
4334 bool optional =
false );
4339 static QString
typeName() {
return QStringLiteral(
"maptheme" ); }
4342 bool checkValueIsAcceptable(
const QVariant &input,
QgsProcessingContext *context =
nullptr )
const override;
4343 QString valueAsPythonString(
const QVariant &value,
QgsProcessingContext &context )
const override;
4344 QString asScriptCode()
const override;
4346 QVariantMap toVariantMap()
const override;
4347 bool fromVariantMap(
const QVariantMap &map )
override;
4379 bool optional =
false,
4380 const QDateTime &minValue = QDateTime(),
4381 const QDateTime &maxValue = QDateTime()
4387 static QString
typeName() {
return QStringLiteral(
"datetime" ); }
4390 bool checkValueIsAcceptable(
const QVariant &input,
QgsProcessingContext *context =
nullptr )
const override;
4391 QString valueAsPythonString(
const QVariant &value,
QgsProcessingContext &context )
const override;
4392 QString toolTip()
const override;
4402 QDateTime minimum()
const;
4415 void setMinimum(
const QDateTime &minimum );
4424 QDateTime maximum()
const;
4437 void setMaximum(
const QDateTime &maximum );
4451 QVariantMap toVariantMap()
const override;
4452 bool fromVariantMap(
const QVariantMap &map )
override;
4453 QString userFriendlyString(
const QVariant &value )
const override;
4489 bool optional =
false );
4494 static QString
typeName() {
return QStringLiteral(
"providerconnection" ); }
4497 bool checkValueIsAcceptable(
const QVariant &input,
QgsProcessingContext *context =
nullptr )
const override;
4498 QString valueAsPythonString(
const QVariant &value,
QgsProcessingContext &context )
const override;
4499 QString asScriptCode()
const override;
4501 QVariantMap toVariantMap()
const override;
4502 bool fromVariantMap(
const QVariantMap &map )
override;
4523 QString mProviderId;
4550 bool optional =
false );
4555 static QString
typeName() {
return QStringLiteral(
"databaseschema" ); }
4558 bool checkValueIsAcceptable(
const QVariant &input,
QgsProcessingContext *context =
nullptr )
const override;
4559 QString valueAsPythonString(
const QVariant &value,
QgsProcessingContext &context )
const override;
4560 QString asScriptCode()
const override;
4562 QVariantMap toVariantMap()
const override;
4563 bool fromVariantMap(
const QVariantMap &map )
override;
4564 QStringList dependsOnOtherParameters()
const override;
4570 QString parentConnectionParameterName()
const;
4576 void setParentConnectionParameterName(
const QString &name );
4585 QString mParentConnectionParameterName;
4615 const QString &connectionParameterName = QString(),
4616 const QString &schemaParameterName = QString(),
4618 bool optional =
false,
4624 static QString
typeName() {
return QStringLiteral(
"databasetable" ); }
4627 bool checkValueIsAcceptable(
const QVariant &input,
QgsProcessingContext *context =
nullptr )
const override;
4628 QString valueAsPythonString(
const QVariant &value,
QgsProcessingContext &context )
const override;
4629 QString asScriptCode()
const override;
4631 QVariantMap toVariantMap()
const override;
4632 bool fromVariantMap(
const QVariantMap &map )
override;
4633 QStringList dependsOnOtherParameters()
const override;
4639 QString parentConnectionParameterName()
const;
4645 void setParentConnectionParameterName(
const QString &name );
4651 QString parentSchemaParameterName()
const;
4657 void setParentSchemaParameterName(
const QString &name );
4670 bool allowNewTableNames()
const;
4678 void setAllowNewTableNames(
bool allowed );
4682 QString mParentConnectionParameterName;
4683 QString mParentSchemaParameterName;
4684 bool mAllowNewTableNames =
false;
4702 const QVariant &
defaultValue = QVariant(),
bool optional =
false );
4707 static QString
typeName() {
return QStringLiteral(
"pointcloud" ); }
4710 bool checkValueIsAcceptable(
const QVariant &input,
QgsProcessingContext *context =
nullptr )
const override;
4711 QString valueAsPythonString(
const QVariant &value,
QgsProcessingContext &context )
const override;
4713 QVariant valueAsJsonObject(
const QVariant &value,
QgsProcessingContext &context )
const override;
4714 QString createFileFilter()
const override;
4737 const QVariant &
defaultValue = QVariant(),
bool optional =
false );
4742 static QString
typeName() {
return QStringLiteral(
"annotation" ); }
4745 bool checkValueIsAcceptable(
const QVariant &input,
QgsProcessingContext *context =
nullptr )
const override;
4746 QString valueAsPythonString(
const QVariant &value,
QgsProcessingContext &context )
const override;
4748 QVariant valueAsJsonObject(
const QVariant &value,
QgsProcessingContext &context )
const override;
4775 bool optional =
false,
4781 static QString
typeName() {
return QStringLiteral(
"pointCloudDestination" ); }
4784 bool checkValueIsAcceptable(
const QVariant &input,
QgsProcessingContext *context =
nullptr )
const override;
4785 QString valueAsPythonString(
const QVariant &value,
QgsProcessingContext &context )
const override;
4787 QString defaultFileExtension() const override;
4788 QString createFileFilter() const override;
4794 virtual QStringList supportedOutputPointCloudLayerExtensions() const;
4818 bool optional =
false,
4824 static QString
typeName() {
return QStringLiteral(
"attribute" ); }
4827 bool checkValueIsAcceptable(
const QVariant &input,
QgsProcessingContext *context =
nullptr )
const override;
4828 QString valueAsPythonString(
const QVariant &value,
QgsProcessingContext &context )
const override;
4829 QString asScriptCode()
const override;
4831 QStringList dependsOnOtherParameters()
const override;
4837 QString parentLayerParameterName()
const;
4843 void setParentLayerParameterName(
const QString &parentLayerParameterName );
4849 bool allowMultiple()
const;
4855 void setAllowMultiple(
bool allowMultiple );
4865 bool defaultToAllAttributes()
const;
4875 void setDefaultToAllAttributes(
bool enabled );
4877 QVariantMap toVariantMap()
const override;
4878 bool fromVariantMap(
const QVariantMap &map )
override;
4887 QString mParentLayerParameterName;
4888 bool mAllowMultiple =
false;
4889 bool mDefaultToAllAttributes =
false;
4911 bool optional =
false,
4917 static QString
typeName() {
return QStringLiteral(
"vectorTileDestination" ); }
4920 bool checkValueIsAcceptable(
const QVariant &input,
QgsProcessingContext *context =
nullptr )
const override;
4921 QString valueAsPythonString(
const QVariant &value,
QgsProcessingContext &context )
const override;
4923 QString defaultFileExtension() const override;
4924 QString createFileFilter() const override;
4930 virtual QStringList supportedOutputVectorTileLayerExtensions() const;
Provides global constants and enumerations 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.
QFlags< RasterProcessingParameterCapability > RasterProcessingParameterCapabilities
Raster layer processing parameter capabilities.
ProcessingFieldParameterDataType
Processing field parameter data types.
@ Unknown
Unknown areal unit.
TemporalUnit
Temporal units.
@ Milliseconds
Milliseconds.
QFlags< ProcessingParameterFlag > ProcessingParameterFlags
Flags which dictate the behavior of Processing parameters.
VolumeUnit
Units of volume.
@ Unknown
Unknown volume unit.
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.
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.
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.
friend class TestQgsProcessing
virtual QString defaultFileExtension() const =0
Returns the default file extension for destination file paths associated with this parameter.
void setCreateByDefault(bool createByDefault)
Sets whether the destination should be created by default.
friend class TestQgsProcessingModelAlgorithm
bool supportsNonFileBasedOutput() const
Returns true if the destination parameter supports non filed-based outputs, such as memory layers or ...
friend class QgsProcessingModelAlgorithm
bool isDestination() const override
Returns true if this parameter represents a file or layer destination, e.g.
bool createByDefault() const
Returns true if the destination should be created by default.
virtual bool isSupportedOutputValue(const QVariant &value, QgsProcessingContext &context, QString &error) const
Tests whether a value is a supported value for this parameter.
virtual QString generateTemporaryDestination(const QgsProcessingContext *context=nullptr) const
Generates a temporary destination value for this parameter.
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...
QgsProcessingDestinationParameter(const QString &name, const QString &description=QString(), const QVariant &defaultValue=QVariant(), bool optional=false, bool createByDefault=true)
Constructor for QgsProcessingDestinationParameter.
Custom exception class for processing related exceptions.
Encapsulates settings relating to a feature source input to a processing algorithm.
bool loadVariant(const QVariantMap &map)
Loads this source definition from a QVariantMap, wrapped in a QVariant.
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...
QVariant toVariant() const
Saves this source definition to a QVariantMap, wrapped in a QVariant.
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.
QString format() const
Returns the format (if set).
QgsProject * destinationProject
Destination project.
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.
void setFormat(const QString &format)
Sets the format of the output dataset.
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.
QgsProcessingParameterAnnotationLayer(const QString &name, const QString &description=QString(), const QVariant &defaultValue=QVariant(), bool optional=false)
Constructor for QgsProcessingParameterAnnotationLayer.
QString type() const override
Unique parameter type name.
static QString typeName()
Returns the type name for the parameter class.
A double numeric parameter for area values.
void setDefaultUnit(Qgis::AreaUnit unit)
Sets the default area unit for the parameter.
QString parentParameterName() const
Returns the name of the parent parameter, or an empty string if this is not set.
Qgis::AreaUnit defaultUnit() const
Returns the default area unit for the parameter.
QgsProcessingParameterArea(const QString &name, const QString &description=QString(), const QVariant &defaultValue=QVariant(), const QString &parentParameterName=QString(), bool optional=false, double minValue=0, double maxValue=std::numeric_limits< double >::max())
Constructor for QgsProcessingParameterArea.
static QString typeName()
Returns the type name for the parameter class.
A string parameter for authentication configuration ID values.
QString type() const override
Unique parameter type name.
QgsProcessingParameterAuthConfig(const QString &name, const QString &description=QString(), const QVariant &defaultValue=QVariant(), bool optional=false)
Constructor for QgsProcessingParameterAuthConfig.
static QString typeName()
Returns the type name for the parameter class.
A raster band parameter for Processing algorithms.
QString type() const override
Unique parameter type name.
QString parentLayerParameterName() const
Returns the name of the parent layer parameter, or an empty string if this is not set.
QgsProcessingParameterBand(const QString &name, const QString &description=QString(), const QVariant &defaultValue=QVariant(), const QString &parentLayerParameterName=QString(), bool optional=false, bool allowMultiple=false)
Constructor for QgsProcessingParameterBand.
static QString typeName()
Returns the type name for the parameter class.
bool allowMultiple() const
Returns whether multiple band selections are permitted.
A boolean parameter for processing algorithms.
QString type() const override
Unique parameter type name.
static QString typeName()
Returns the type name for the parameter class.
QgsProcessingParameterBoolean(const QString &name, const QString &description=QString(), const QVariant &defaultValue=QVariant(), bool optional=false)
Constructor for QgsProcessingParameterBoolean.
A color parameter for processing algorithms.
bool opacityEnabled() const
Returns true if the parameter allows opacity control.
QgsProcessingParameterColor(const QString &name, const QString &description=QString(), const QVariant &defaultValue=QVariant(), bool opacityEnabled=true, bool optional=false)
Constructor for QgsProcessingParameterColor.
static QString typeName()
Returns the type name for the parameter class.
QString type() const override
Unique parameter type name.
A coordinate operation parameter for processing algorithms.
static QString typeName()
Returns the type name for the parameter class.
QString type() const override
Unique parameter type name.
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.
QgsProcessingParameterCoordinateOperation(const QString &name, const QString &description=QString(), const QVariant &defaultValue=QVariant(), const QString &sourceCrsParameterName=QString(), const QString &destinationCrsParameterName=QString(), const QVariant &staticSourceCrs=QVariant(), const QVariant &staticDestinationCrs=QVariant(), bool optional=false)
Constructor for QgsProcessingParameterCoordinateOperation.
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.
QgsProcessingParameterCrs(const QString &name, const QString &description=QString(), const QVariant &defaultValue=QVariant(), bool optional=false)
Constructor for QgsProcessingParameterCrs.
QString userFriendlyString(const QVariant &value) const override
Returns a user-friendly string representation of the provided parameter value.
QString type() const override
Unique parameter type name.
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...
QString type() const override
Unique parameter type name.
static QString typeName()
Returns the type name for the parameter class.
QgsProcessingParameterDatabaseSchema(const QString &name, const QString &description, const QString &connectionParameterName=QString(), const QVariant &defaultValue=QVariant(), bool optional=false)
Constructor for QgsProcessingParameterDatabaseSchema.
A database table name parameter for processing algorithms.
QgsProcessingParameterDatabaseTable(const QString &name, const QString &description, const QString &connectionParameterName=QString(), const QString &schemaParameterName=QString(), const QVariant &defaultValue=QVariant(), bool optional=false, bool allowNewTableNames=false)
Constructor for QgsProcessingParameterDatabaseTable.
static QString typeName()
Returns the type name for the parameter class.
QString type() const override
Unique parameter type name.
bool allowNewTableNames() const
Returns true if the parameter allows users to enter names for a new (non-existing) tables.
A datetime (or pure date or time) parameter for processing algorithms.
QString type() const override
Unique parameter type name.
static QString typeName()
Returns the type name for the parameter class.
QgsProcessingParameterDateTime(const QString &name, const QString &description=QString(), Qgis::ProcessingDateTimeParameterDataType type=Qgis::ProcessingDateTimeParameterDataType::DateTime, const QVariant &defaultValue=QVariant(), bool optional=false, const QDateTime &minValue=QDateTime(), const QDateTime &maxValue=QDateTime())
Constructor for QgsProcessingParameterDateTime.
Base class for the definition of processing parameters.
QgsProcessingAlgorithm * mAlgorithm
Pointer to algorithm which owns this parameter.
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.
QString valueAsStringPrivate(const QVariant &value, QgsProcessingContext &context, bool &ok, ValueAsStringFlags flags) const
Internal method for evaluating values as string.
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.
virtual QString userFriendlyString(const QVariant &value) const
Returns a user-friendly string representation of the provided parameter value.
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.
QgsProcessingProvider * provider() const
Returns a pointer to the provider for the algorithm which owns this 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.
bool mIsDynamic
True for dynamic parameters, which can have data-defined (QgsProperty) based values.
QVariantMap metadata() const
Returns the parameter's freeform metadata.
QString description() const
Returns the description for the parameter.
QgsProcessingParameterDefinition(const QString &name, const QString &description=QString(), const QVariant &defaultValue=QVariant(), bool optional=false, const QString &help=QString())
Constructor for QgsProcessingParameterDefinition.
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...
friend class QgsProcessingAlgorithm
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.
QVariant defaultGuiValueFromSetting() const
Default gui value for an algorithm parameter from settings.
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.
QVariant valueAsJsonObjectPrivate(const QVariant &value, QgsProcessingContext &context, ValueAsStringFlags flags) const
Internal method for evaluating values as JSON objects.
virtual QColor modelColor() const
Returns the color to use for the parameter in model designer windows.
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.
QString parentParameterName() const
Returns the name of the parent parameter, or an empty string if this is not set.
Qgis::DistanceUnit defaultUnit() const
Returns the default distance unit for the parameter.
QgsProcessingParameterDistance(const QString &name, const QString &description=QString(), const QVariant &defaultValue=QVariant(), const QString &parentParameterName=QString(), bool optional=false, double minValue=std::numeric_limits< double >::lowest()+1, double maxValue=std::numeric_limits< double >::max())
Constructor for QgsProcessingParameterDistance.
A double numeric parameter for duration values.
void setDefaultUnit(Qgis::TemporalUnit unit)
Sets the default duration unit for the parameter.
Qgis::TemporalUnit defaultUnit() const
Returns the default duration unit for the parameter.
static QString typeName()
Returns the type name for the parameter class.
QgsProcessingParameterDuration(const QString &name, const QString &description=QString(), const QVariant &defaultValue=QVariant(), bool optional=false, double minValue=std::numeric_limits< double >::lowest()+1, double maxValue=std::numeric_limits< double >::max())
Constructor for QgsProcessingParameterDuration.
static QString typeName()
Returns the type name for the parameter class.
An enum based parameter for processing algorithms, allowing for selection from predefined values.
QString userFriendlyString(const QVariant &value) const override
Returns a user-friendly string representation of the provided parameter value.
bool allowMultiple() const
Returns true if the parameter allows multiple selected values.
QStringList options() const
Returns the list of acceptable options for the parameter.
QgsProcessingParameterEnum(const QString &name, const QString &description=QString(), const QStringList &options=QStringList(), bool allowMultiple=false, const QVariant &defaultValue=QVariant(), bool optional=false, bool usesStaticStrings=false)
Constructor for QgsProcessingParameterEnum.
QString type() const override
Unique parameter type name.
bool usesStaticStrings() const
Returns true if the parameter uses static (non-translated) string values for its enumeration choice l...
static QString typeName()
Returns the type name for the parameter class.
An expression parameter for processing algorithms.
QgsProcessingParameterExpression(const QString &name, const QString &description=QString(), const QVariant &defaultValue=QVariant(), const QString &parentLayerParameterName=QString(), bool optional=false, Qgis::ExpressionType type=Qgis::ExpressionType::Qgis)
Constructor for QgsProcessingParameterExpression.
QString parentLayerParameterName() const
Returns the name of the parent layer parameter, or an empty string if this is not set.
QString type() const override
Unique parameter type name.
static QString typeName()
Returns the type name for the parameter class.
A rectangular map extent parameter for processing algorithms.
QgsProcessingParameterExtent(const QString &name, const QString &description=QString(), const QVariant &defaultValue=QVariant(), bool optional=false)
Constructor for QgsProcessingParameterExtent.
static QString typeName()
Returns the type name for the parameter class.
QString type() const override
Unique parameter type name.
A feature sink output for processing algorithms.
QgsProcessingParameterFeatureSink(const QString &name, const QString &description=QString(), Qgis::ProcessingSourceType type=Qgis::ProcessingSourceType::VectorAnyGeometry, const QVariant &defaultValue=QVariant(), bool optional=false, bool createByDefault=true, bool supportsAppend=false)
Constructor for QgsProcessingParameterFeatureSink.
QString type() const override
Unique parameter type name.
bool supportsAppend() const
Returns true if the sink supports appending features to an existing table.
static QString typeName()
Returns the type name for the parameter class.
An input feature source (such as vector layers) parameter for processing algorithms.
QgsProcessingParameterFeatureSource(const QString &name, const QString &description=QString(), const QList< int > &types=QList< int >(), const QVariant &defaultValue=QVariant(), bool optional=false)
Constructor for QgsProcessingParameterFeatureSource.
static QString typeName()
Returns the type name for the parameter class.
QString type() const override
Unique parameter type name.
static QString typeName()
Returns the type name for the parameter class.
A vector layer or feature source field parameter for processing algorithms.
QString parentLayerParameterName() const
Returns the name of the parent layer parameter, or an empty string if this is not set.
bool allowMultiple() const
Returns whether multiple field selections are permitted.
QString type() const override
Unique parameter type name.
bool defaultToAllFields() const
Returns whether a parameter which allows multiple selections (see allowMultiple()) should automatical...
static QString typeName()
Returns the type name for the parameter class.
QgsProcessingParameterField(const QString &name, const QString &description=QString(), const QVariant &defaultValue=QVariant(), const QString &parentLayerParameterName=QString(), Qgis::ProcessingFieldParameterDataType type=Qgis::ProcessingFieldParameterDataType::Any, bool allowMultiple=false, bool optional=false, bool defaultToAllFields=false)
Constructor for QgsProcessingParameterField.
A generic file based destination parameter, for specifying the destination path for a file (non-map l...
QgsProcessingParameterFileDestination(const QString &name, const QString &description=QString(), const QString &fileFilter=QString(), const QVariant &defaultValue=QVariant(), bool optional=false, bool createByDefault=true)
Constructor for QgsProcessingParameterFileDestination.
QString type() const override
Unique parameter type name.
static QString typeName()
Returns the type name for the parameter class.
QString fileFilter() const
Returns the file filter string for file destinations compatible with this parameter.
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.
QgsProcessingParameterFile(const QString &name, const QString &description=QString(), Qgis::ProcessingFileParameterBehavior behavior=Qgis::ProcessingFileParameterBehavior::File, const QString &extension=QString(), const QVariant &defaultValue=QVariant(), bool optional=false, const QString &fileFilter=QString())
Constructor for QgsProcessingParameterFile.
void setBehavior(Qgis::ProcessingFileParameterBehavior behavior)
Sets the parameter behavior (e.g.
QString type() const override
Unique parameter type name.
QString fileFilter() const
Returns the file filter string for file destinations compatible with this parameter.
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...
QString type() const override
Unique parameter type name.
static QString typeName()
Returns the type name for the parameter class.
QgsProcessingParameterFolderDestination(const QString &name, const QString &description=QString(), const QVariant &defaultValue=QVariant(), bool optional=false, bool createByDefault=true)
Constructor for QgsProcessingParameterFolderDestination.
A geometry parameter for processing algorithms.
void setGeometryTypes(const QList< int > &geometryTypes)
Sets the allowed geometryTypes, as a list of Qgis::GeometryType values.
QString type() const override
Unique parameter type name.
bool allowMultipart() const
Returns the parameter allow multipart geometries.
QgsProcessingParameterGeometry(const QString &name, const QString &description=QString(), const QVariant &defaultValue=QVariant(), bool optional=false, const QList< int > &geometryTypes=QList< int >(), bool allowMultipart=true)
Constructor for QgsProcessingParameterGeometry.
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.
QString type() const override
Unique parameter type name.
QgsProcessingParameterLayoutItem(const QString &name, const QString &description=QString(), const QVariant &defaultValue=QVariant(), const QString &parentLayoutParameterName=QString(), int itemType=-1, bool optional=false)
Constructor for QgsProcessingParameterLayoutItem.
QString parentLayoutParameterName() const
Returns the name of the parent layout parameter, or an empty string if this is not set.
static QString typeName()
Returns the type name for the parameter class.
int itemType() const
Returns the acceptable item type, or -1 if any item type is allowed.
A print layout parameter, allowing users to select a print layout.
QgsProcessingParameterLayout(const QString &name, const QString &description=QString(), const QVariant &defaultValue=QVariant(), bool optional=false)
Constructor for QgsProcessingParameterLayout.
static QString typeName()
Returns the type name for the parameter class.
QString type() const override
Unique parameter type name.
void setDataTypes(const QList< int > &types)
Sets the geometry types for sources acceptable by the parameter.
QgsProcessingParameterLimitedDataTypes(const QList< int > &types=QList< int >())
Constructor for QgsProcessingParameterLimitedDataTypes, with a list of acceptable data types.
QList< int > mDataTypes
List of acceptable data types for the parameter.
QList< int > dataTypes() const
Returns the geometry types for sources acceptable by the parameter.
A map layer parameter for processing algorithms.
QString type() const override
Unique parameter type name.
QgsProcessingParameterMapLayer(const QString &name, const QString &description=QString(), const QVariant &defaultValue=QVariant(), bool optional=false, const QList< int > &types=QList< int >())
Constructor for QgsProcessingParameterMapLayer.
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 ...
QString type() const override
Unique parameter type name.
static QString typeName()
Returns the type name for the parameter class.
QgsProcessingParameterMapTheme(const QString &name, const QString &description=QString(), const QVariant &defaultValue=QVariant(), bool optional=false)
Constructor for QgsProcessingParameterMapTheme.
A table (matrix) parameter for processing algorithms.
QStringList headers() const
Returns a list of column headers (if set).
int numberRows() const
Returns the fixed number of rows in the table.
static QString typeName()
Returns the type name for the parameter class.
QgsProcessingParameterMatrix(const QString &name, const QString &description=QString(), int numberRows=3, bool hasFixedNumberRows=false, const QStringList &headers=QStringList(), const QVariant &defaultValue=QVariant(), bool optional=false)
Constructor for QgsProcessingParameterMatrix.
QString type() const override
Unique parameter type name.
bool hasFixedNumberRows() const
Returns whether the table has a fixed number of rows.
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.
QgsProcessingParameterMeshLayer(const QString &name, const QString &description=QString(), const QVariant &defaultValue=QVariant(), bool optional=false)
Constructor for QgsProcessingParameterMeshLayer.
QString type() const override
Unique parameter type name.
static QString typeName()
Returns the type name for the parameter class.
A parameter for processing algorithms which accepts multiple map layers.
Qgis::ProcessingSourceType layerType() const
Returns the layer type for layers acceptable by the parameter.
static QString typeName()
Returns the type name for the parameter class.
QgsProcessingParameterMultipleLayers(const QString &name, const QString &description=QString(), Qgis::ProcessingSourceType layerType=Qgis::ProcessingSourceType::VectorAnyGeometry, const QVariant &defaultValue=QVariant(), bool optional=false)
Constructor for QgsProcessingParameterMultipleLayers.
QString type() const override
Unique parameter type name.
A numeric parameter for processing algorithms.
QString type() const override
Unique parameter type name.
static QString typeName()
Returns the type name for the parameter class.
QgsProcessingParameterNumber(const QString &name, const QString &description=QString(), Qgis::ProcessingNumberParameterType type=Qgis::ProcessingNumberParameterType::Integer, const QVariant &defaultValue=QVariant(), bool optional=false, double minValue=std::numeric_limits< double >::lowest()+1, double maxValue=std::numeric_limits< double >::max())
Constructor for QgsProcessingParameterNumber.
A point cloud layer attribute parameter for Processing algorithms.
QgsProcessingParameterPointCloudAttribute(const QString &name, const QString &description=QString(), const QVariant &defaultValue=QVariant(), const QString &parentLayerParameterName=QString(), bool allowMultiple=false, bool optional=false, bool defaultToAllAttributes=false)
Constructor for QgsProcessingParameterField.
QString type() const override
Unique parameter type name.
QString parentLayerParameterName() const
Returns the name of the parent layer parameter, or an empty string if this is not set.
static QString typeName()
Returns the type name for the parameter class.
bool allowMultiple() const
Returns whether multiple field selections are permitted.
bool defaultToAllAttributes() const
Returns whether a parameter which allows multiple selections (see allowMultiple()) should automatical...
A point cloud layer destination parameter, for specifying the destination path for a point cloud laye...
QString type() const override
Unique parameter type name.
static QString typeName()
Returns the type name for the parameter class.
QgsProcessingParameterPointCloudDestination(const QString &name, const QString &description=QString(), const QVariant &defaultValue=QVariant(), bool optional=false, bool createByDefault=true)
Constructor for QgsProcessingParameterPointCloudDestination.
A point cloud layer parameter for processing algorithms.
QString type() const override
Unique parameter type name.
static QString typeName()
Returns the type name for the parameter class.
QgsProcessingParameterPointCloudLayer(const QString &name, const QString &description=QString(), const QVariant &defaultValue=QVariant(), bool optional=false)
Constructor for QgsProcessingParameterPointCloudLayer.
A point parameter for processing algorithms.
QString type() const override
Unique parameter type name.
QgsProcessingParameterPoint(const QString &name, const QString &description=QString(), const QVariant &defaultValue=QVariant(), bool optional=false)
Constructor for QgsProcessingParameterPoint.
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...
QString type() const override
Unique parameter type name.
QgsProcessingParameterProviderConnection(const QString &name, const QString &description, const QString &provider, const QVariant &defaultValue=QVariant(), bool optional=false)
Constructor for QgsProcessingParameterProviderConnection, for the specified provider type.
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.
QgsProcessingParameterRange(const QString &name, const QString &description=QString(), Qgis::ProcessingNumberParameterType type=Qgis::ProcessingNumberParameterType::Integer, const QVariant &defaultValue=QVariant(), bool optional=false)
Constructor for QgsProcessingParameterRange.
QString type() const override
Unique parameter type name.
A raster layer destination parameter, for specifying the destination path for a raster layer created ...
QString type() const override
Unique parameter type name.
QgsProcessingParameterRasterDestination(const QString &name, const QString &description=QString(), const QVariant &defaultValue=QVariant(), bool optional=false, bool createByDefault=true)
Constructor for QgsProcessingParameterRasterDestination.
static QString typeName()
Returns the type name for the parameter class.
A raster layer parameter for processing algorithms.
QString type() const override
Unique parameter type name.
static QString typeName()
Returns the type name for the parameter class.
QgsProcessingParameterRasterLayer(const QString &name, const QString &description=QString(), const QVariant &defaultValue=QVariant(), bool optional=false)
Constructor for QgsProcessingParameterRasterLayer.
A double numeric parameter for map scale values.
static QString typeName()
Returns the type name for the parameter class.
QgsProcessingParameterScale(const QString &name, const QString &description=QString(), const QVariant &defaultValue=QVariant(), bool optional=false)
Constructor for QgsProcessingParameterScale.
A string parameter for processing algorithms.
static QString typeName()
Returns the type name for the parameter class.
QString type() const override
Unique parameter type name.
bool multiLine() const
Returns true if the parameter allows multiline strings.
QgsProcessingParameterString(const QString &name, const QString &description=QString(), const QVariant &defaultValue=QVariant(), bool multiLine=false, bool optional=false)
Constructor for QgsProcessingParameterString.
A vector layer destination parameter, for specifying the destination path for a vector layer created ...
QgsProcessingParameterVectorDestination(const QString &name, const QString &description=QString(), Qgis::ProcessingSourceType type=Qgis::ProcessingSourceType::VectorAnyGeometry, const QVariant &defaultValue=QVariant(), bool optional=false, bool createByDefault=true)
Constructor for QgsProcessingParameterVectorDestination.
QString type() const override
Unique parameter type name.
static QString typeName()
Returns the type name for the parameter class.
A vector layer (with or without geometry) parameter for processing algorithms.
QString type() const override
Unique parameter type name.
QgsProcessingParameterVectorLayer(const QString &name, const QString &description=QString(), const QList< int > &types=QList< int >(), const QVariant &defaultValue=QVariant(), bool optional=false)
Constructor for QgsProcessingParameterVectorLayer.
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...
QgsProcessingParameterVectorTileDestination(const QString &name, const QString &description=QString(), const QVariant &defaultValue=QVariant(), bool optional=false, bool createByDefault=true)
Constructor for QgsProcessingParameterVectorTileDestination.
static QString typeName()
Returns the type name for the parameter class.
QString type() const override
Unique parameter type name.
static QString typeName()
Returns the type name for the parameter class.
A double numeric parameter for volume values.
static QString typeName()
Returns the type name for the parameter class.
QgsProcessingParameterVolume(const QString &name, const QString &description=QString(), const QVariant &defaultValue=QVariant(), const QString &parentParameterName=QString(), bool optional=false, double minValue=0, double maxValue=std::numeric_limits< double >::max())
Constructor for QgsProcessingParameterVolume.
Qgis::VolumeUnit defaultUnit() const
Returns the default volume unit for the parameter.
void setDefaultUnit(Qgis::VolumeUnit unit)
Sets the default volume unit for the parameter.
QString parentParameterName() const
Returns the name of the parent parameter, or an empty string if this is not set.
A collection of utilities for working with parameters when running a processing algorithm.
static QString descriptionFromName(const QString &name)
Creates an autogenerated parameter description from a parameter name.
static int parameterAsEnum(const QgsProcessingParameterDefinition *definition, const QVariantMap ¶meters, const QgsProcessingContext &context)
Evaluates the parameter with matching definition to a enum value.
static double parameterAsDouble(const QgsProcessingParameterDefinition *definition, const QVariantMap ¶meters, const QgsProcessingContext &context)
Evaluates the parameter with matching definition to a static double value.
static QgsPointXY parameterAsPoint(const QgsProcessingParameterDefinition *definition, const QVariantMap ¶meters, QgsProcessingContext &context, const QgsCoordinateReferenceSystem &crs=QgsCoordinateReferenceSystem())
Evaluates the parameter with matching definition to a point.
static QString parameterAsOutputLayer(const QgsProcessingParameterDefinition *definition, const QVariantMap ¶meters, QgsProcessingContext &context)
Evaluates the parameter with matching definition to a output layer destination.
static QgsFeatureSink * parameterAsSink(const QgsProcessingParameterDefinition *definition, const QVariantMap ¶meters, const QgsFields &fields, Qgis::WkbType geometryType, const QgsCoordinateReferenceSystem &crs, QgsProcessingContext &context, QString &destinationIdentifier, QgsFeatureSink::SinkFlags sinkFlags=QgsFeatureSink::SinkFlags(), const QVariantMap &createOptions=QVariantMap(), const QStringList &datasourceOptions=QStringList(), const QStringList &layerOptions=QStringList())
Evaluates the parameter with matching definition to a feature sink.
static QgsPrintLayout * parameterAsLayout(const QgsProcessingParameterDefinition *definition, const QVariantMap ¶meters, QgsProcessingContext &context)
Evaluates the parameter with matching definition to a print layout.
static QList< QgsMapLayer * > parameterAsLayerList(const QgsProcessingParameterDefinition *definition, const QVariantMap ¶meters, QgsProcessingContext &context, QgsProcessing::LayerOptionsFlags flags=QgsProcessing::LayerOptionsFlags())
Evaluates the parameter with matching definition to a list of map layers.
static QTime parameterAsTime(const QgsProcessingParameterDefinition *definition, const QVariantMap ¶meters, const QgsProcessingContext &context)
Evaluates the parameter with matching definition to a static time value.
static QgsProcessingParameterDefinition * parameterFromVariantMap(const QVariantMap &map)
Creates a new QgsProcessingParameterDefinition using the configuration from a supplied variant map.
static QgsRectangle parameterAsExtent(const QgsProcessingParameterDefinition *definition, const QVariantMap ¶meters, QgsProcessingContext &context, const QgsCoordinateReferenceSystem &crs=QgsCoordinateReferenceSystem())
Evaluates the parameter with matching definition to a rectangular extent.
static QgsCoordinateReferenceSystem parameterAsGeometryCrs(const QgsProcessingParameterDefinition *definition, const QVariantMap ¶meters, QgsProcessingContext &context)
Returns the coordinate reference system associated with a geometry parameter value.
static QgsAnnotationLayer * parameterAsAnnotationLayer(const QgsProcessingParameterDefinition *definition, const QVariantMap ¶meters, QgsProcessingContext &context)
Evaluates the parameter with matching definition to an annotation layer.
static QString parameterAsEnumString(const QgsProcessingParameterDefinition *definition, const QVariantMap ¶meters, const QgsProcessingContext &context)
Evaluates the parameter with matching definition to a static enum string.
static QList< double > parameterAsRange(const QgsProcessingParameterDefinition *definition, const QVariantMap ¶meters, QgsProcessingContext &context)
Evaluates the parameter with matching definition to a range of values.
static QStringList parameterAsStrings(const QgsProcessingParameterDefinition *definition, const QVariantMap ¶meters, QgsProcessingContext &context)
Evaluates the parameter with matching definition to a list of strings (e.g.
static QList< int > parameterAsInts(const QgsProcessingParameterDefinition *definition, const QVariantMap ¶meters, const QgsProcessingContext &context)
Evaluates the parameter with matching definition to a list of integer values.
static QString parameterAsConnectionName(const QgsProcessingParameterDefinition *definition, const QVariantMap ¶meters, const QgsProcessingContext &context)
Evaluates the parameter with matching definition to a connection name string.
static QgsProcessingFeatureSource * parameterAsSource(const QgsProcessingParameterDefinition *definition, const QVariantMap ¶meters, QgsProcessingContext &context)
Evaluates the parameter with matching definition to a feature source.
static QString parameterAsFileOutput(const QgsProcessingParameterDefinition *definition, const QVariantMap ¶meters, QgsProcessingContext &context)
Evaluates the parameter with matching definition to a file based output destination.
static bool parameterAsBoolean(const QgsProcessingParameterDefinition *definition, const QVariantMap ¶meters, const QgsProcessingContext &context)
Evaluates the parameter with matching definition to a static boolean value.
static QgsPointCloudLayer * parameterAsPointCloudLayer(const QgsProcessingParameterDefinition *definition, const QVariantMap ¶meters, QgsProcessingContext &context, QgsProcessing::LayerOptionsFlags flags=QgsProcessing::LayerOptionsFlags())
Evaluates the parameter with matching definition to a point cloud layer.
static QgsCoordinateReferenceSystem parameterAsPointCrs(const QgsProcessingParameterDefinition *definition, const QVariantMap ¶meters, QgsProcessingContext &context)
Returns the coordinate reference system associated with an point parameter value.
static QgsLayoutItem * parameterAsLayoutItem(const QgsProcessingParameterDefinition *definition, const QVariantMap ¶meters, QgsProcessingContext &context, QgsPrintLayout *layout)
Evaluates the parameter with matching definition to a print layout item, taken from the specified lay...
static bool parameterAsBool(const QgsProcessingParameterDefinition *definition, const QVariantMap ¶meters, const QgsProcessingContext &context)
Evaluates the parameter with matching definition to a static boolean value.
static QString parameterAsCompatibleSourceLayerPathAndLayerName(const QgsProcessingParameterDefinition *definition, const QVariantMap ¶meters, QgsProcessingContext &context, const QStringList &compatibleFormats, const QString &preferredFormat=QString("shp"), QgsProcessingFeedback *feedback=nullptr, QString *layerName=nullptr)
Evaluates the parameter with matching definition to a source vector layer file path and layer name of...
static QgsMeshLayer * parameterAsMeshLayer(const QgsProcessingParameterDefinition *definition, const QVariantMap ¶meters, QgsProcessingContext &context)
Evaluates the parameter with matching definition and value to a mesh layer.
static QString parameterAsCompatibleSourceLayerPath(const QgsProcessingParameterDefinition *definition, const QVariantMap ¶meters, QgsProcessingContext &context, const QStringList &compatibleFormats, const QString &preferredFormat=QString("shp"), QgsProcessingFeedback *feedback=nullptr)
Evaluates the parameter with matching definition to a source vector layer file path of compatible for...
static QgsProcessingParameterDefinition * parameterFromScriptCode(const QString &code)
Creates a new QgsProcessingParameterDefinition using the configuration from a supplied script code st...
static QColor parameterAsColor(const QgsProcessingParameterDefinition *definition, const QVariantMap ¶meters, QgsProcessingContext &context)
Returns the color associated with an point parameter value, or an invalid color if the parameter was ...
static QgsVectorLayer * parameterAsVectorLayer(const QgsProcessingParameterDefinition *definition, const QVariantMap ¶meters, QgsProcessingContext &context)
Evaluates the parameter with matching definition to a vector layer.
static QString parameterAsOutputFormat(const QgsProcessingParameterDefinition *definition, const QVariantMap ¶meters, QgsProcessingContext &context)
Evaluates the parameter with matching definition to a output format.
static int parameterAsInt(const QgsProcessingParameterDefinition *definition, const QVariantMap ¶meters, const QgsProcessingContext &context)
Evaluates the parameter with matching definition to a static integer value.
static QString parameterAsDatabaseTableName(const QgsProcessingParameterDefinition *definition, const QVariantMap ¶meters, const QgsProcessingContext &context)
Evaluates the parameter with matching definition to a database table name.
static QString parameterAsSchema(const QgsProcessingParameterDefinition *definition, const QVariantMap ¶meters, const QgsProcessingContext &context)
Evaluates the parameter with matching definition to a database schema name.
static QgsGeometry parameterAsGeometry(const QgsProcessingParameterDefinition *definition, const QVariantMap ¶meters, QgsProcessingContext &context, const QgsCoordinateReferenceSystem &crs=QgsCoordinateReferenceSystem())
Evaluates the parameter with matching definition to a geometry.
static QgsMapLayer * parameterAsLayer(const QgsProcessingParameterDefinition *definition, const QVariantMap ¶meters, QgsProcessingContext &context, QgsProcessingUtils::LayerHint layerHint=QgsProcessingUtils::LayerHint::UnknownType, QgsProcessing::LayerOptionsFlags flags=QgsProcessing::LayerOptionsFlags())
Evaluates the parameter with matching definition to a map layer.
static QString parameterAsExpression(const QgsProcessingParameterDefinition *definition, const QVariantMap ¶meters, const QgsProcessingContext &context)
Evaluates the parameter with matching definition to an expression.
static QString parameterAsString(const QgsProcessingParameterDefinition *definition, const QVariantMap ¶meters, const QgsProcessingContext &context)
Evaluates the parameter with matching definition to a static string value.
static QgsRasterLayer * parameterAsRasterLayer(const QgsProcessingParameterDefinition *definition, const QVariantMap ¶meters, QgsProcessingContext &context)
Evaluates the parameter with matching definition to a raster layer.
static QList< int > parameterAsEnums(const QgsProcessingParameterDefinition *definition, const QVariantMap ¶meters, const QgsProcessingContext &context)
Evaluates the parameter with matching definition to list of enum values.
static QStringList parameterAsEnumStrings(const QgsProcessingParameterDefinition *definition, const QVariantMap ¶meters, const QgsProcessingContext &context)
Evaluates the parameter with matching definition to list of static enum strings.
static QgsGeometry parameterAsExtentGeometry(const QgsProcessingParameterDefinition *definition, const QVariantMap ¶meters, QgsProcessingContext &context, const QgsCoordinateReferenceSystem &crs=QgsCoordinateReferenceSystem())
Evaluates the parameter with matching definition to a rectangular extent, and returns a geometry cove...
static QStringList parameterAsFileList(const QgsProcessingParameterDefinition *definition, const QVariant &value, QgsProcessingContext &context)
Evaluates the parameter with matching definition to a list of files (for QgsProcessingParameterMultip...
static bool isDynamic(const QVariantMap ¶meters, const QString &name)
Returns true if the parameter with matching name is a dynamic parameter, and must be evaluated once f...
static Q_DECL_DEPRECATED QStringList parameterAsFields(const QgsProcessingParameterDefinition *definition, const QVariantMap ¶meters, QgsProcessingContext &context)
Evaluates the parameter with matching definition to a list of fields.
static QgsCoordinateReferenceSystem parameterAsExtentCrs(const QgsProcessingParameterDefinition *definition, const QVariantMap ¶meters, QgsProcessingContext &context)
Returns the coordinate reference system associated with an extent parameter value.
static QDateTime parameterAsDateTime(const QgsProcessingParameterDefinition *definition, const QVariantMap ¶meters, const QgsProcessingContext &context)
Evaluates the parameter with matching definition to a static datetime value.
static QString parameterAsFile(const QgsProcessingParameterDefinition *definition, const QVariantMap ¶meters, QgsProcessingContext &context)
Evaluates the parameter with matching definition to a file/folder name.
static QDate parameterAsDate(const QgsProcessingParameterDefinition *definition, const QVariantMap ¶meters, const QgsProcessingContext &context)
Evaluates the parameter with matching definition to a static date value.
static QVariantList parameterAsMatrix(const QgsProcessingParameterDefinition *definition, const QVariantMap ¶meters, QgsProcessingContext &context)
Evaluates the parameter with matching definition to a matrix/table of values.
static QgsCoordinateReferenceSystem parameterAsCrs(const QgsProcessingParameterDefinition *definition, const QVariantMap ¶meters, QgsProcessingContext &context)
Evaluates the parameter with matching definition to a coordinate reference system.
Abstract base class for processing providers.
Encapsulates settings relating to a raster layer input to a processing algorithm.
double referenceScale
If set to a value > 0, sets a scale at which a raster (e.g., a WMS) should be requested or rendered.
int dpi
Indicates the resolution of the raster source (e.g., a WMS server).
bool operator==(const QgsProcessingRasterLayerDefinition &other) const
QgsProperty source
Source definition.
bool loadVariant(const QVariantMap &map)
Loads this raster layer definition from a QVariantMap, wrapped in a QVariant.
QgsProcessingRasterLayerDefinition(const QString &source=QString(), const double referenceScale=0, const int dpi=96)
Constructor for QgsProcessingRasterLayerDefinition, accepting a static string source.
QVariant toVariant() const
Saves this raster layer definition to a QVariantMap, wrapped in a QVariant.
QgsProcessingRasterLayerDefinition(const QgsProperty &source, const double referenceScale=0, const int dpi=96)
Constructor for QgsProcessingRasterLayerDefinition, accepting a QgsProperty source.
bool operator!=(const QgsProcessingRasterLayerDefinition &other) const
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 dataset.
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.