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 );
1750 static QString descriptionFromName(
const QString &name );
1761 static bool parseScriptCodeParameterOptions(
const QString &code,
bool &isOptional, QString &name, QString &type, QString &definition );
1779 bool optional =
false );
1784 static QString
typeName() {
return QStringLiteral(
"boolean" ); }
1787 QString valueAsPythonString(
const QVariant &value,
QgsProcessingContext &context )
const override;
1788 QString asScriptCode()
const override;
1808 QgsProcessingParameterCrs(
const QString &name,
const QString &description = QString(),
const QVariant &defaultValue = QVariant(),
1809 bool optional =
false );
1814 static QString
typeName() {
return QStringLiteral(
"crs" ); }
1817 bool checkValueIsAcceptable(
const QVariant &input,
QgsProcessingContext *context =
nullptr )
const override;
1818 QString valueAsPythonString(
const QVariant &value,
QgsProcessingContext &context )
const override;
1820 QVariant valueAsJsonObject(
const QVariant &value,
QgsProcessingContext &context )
const override;
1842 bool optional =
false );
1847 static QString
typeName() {
return QStringLiteral(
"extent" ); }
1850 bool checkValueIsAcceptable(
const QVariant &input,
QgsProcessingContext *context =
nullptr )
const override;
1851 QString valueAsPythonString(
const QVariant &value,
QgsProcessingContext &context )
const override;
1853 QVariant valueAsJsonObject(
const QVariant &value,
QgsProcessingContext &context )
const override;
1867 static bool variantIsValidStringForExtent(
const QVariant &value );
1884 QgsProcessingParameterPoint(
const QString &name,
const QString &description = QString(),
const QVariant &defaultValue = QVariant(),
1885 bool optional =
false );
1890 static QString
typeName() {
return QStringLiteral(
"point" ); }
1893 bool checkValueIsAcceptable(
const QVariant &input,
QgsProcessingContext *context =
nullptr )
const override;
1894 QString valueAsPythonString(
const QVariant &value,
QgsProcessingContext &context )
const override;
1920 QgsProcessingParameterGeometry(
const QString &name,
const QString &description = QString(),
const QVariant &defaultValue = QVariant(),
bool optional =
false,
const QList< int > &geometryTypes = QList< int >(),
bool allowMultipart =
true );
1925 static QString
typeName() {
return QStringLiteral(
"geometry" ); }
1928 bool checkValueIsAcceptable(
const QVariant &input,
QgsProcessingContext *context =
nullptr )
const override;
1929 QString valueAsPythonString(
const QVariant &value,
QgsProcessingContext &context )
const override;
1930 QString asScriptCode()
const override;
1932 QVariantMap toVariantMap()
const override;
1933 bool fromVariantMap(
const QVariantMap &map )
override;
1968 QList<int> mGeomTypes;
1969 bool mAllowMultipart;
1990 bool optional =
false,
const QString &fileFilter = QString() );
1995 static QString
typeName() {
return QStringLiteral(
"file" ); }
1998 bool checkValueIsAcceptable(
const QVariant &input,
QgsProcessingContext *context =
nullptr )
const override;
1999 QString asScriptCode()
const override;
2001 QString createFileFilter()
const override;
2033 void setExtension(
const QString &extension );
2041 QString fileFilter()
const;
2052 void setFileFilter(
const QString &filter );
2054 QVariantMap toVariantMap()
const override;
2055 bool fromVariantMap(
const QVariantMap &map )
override;
2066 QString mFileFilter;
2082 bool hasFixedNumberRows =
false,
const QStringList &headers = QStringList(),
2083 const QVariant &defaultValue = QVariant(),
2084 bool optional =
false );
2089 static QString
typeName() {
return QStringLiteral(
"matrix" ); }
2092 bool checkValueIsAcceptable(
const QVariant &input,
QgsProcessingContext *context =
nullptr )
const override;
2093 QString valueAsPythonString(
const QVariant &value,
QgsProcessingContext &context )
const override;
2100 QStringList headers()
const;
2106 void setHeaders(
const QStringList &headers );
2114 int numberRows()
const;
2122 void setNumberRows(
int rows );
2129 bool hasFixedNumberRows()
const;
2136 void setHasFixedNumberRows(
bool hasFixedNumberRows );
2138 QVariantMap toVariantMap()
const override;
2139 bool fromVariantMap(
const QVariantMap &map )
override;
2148 QStringList mHeaders;
2149 int mNumberRows = 3;
2150 bool mFixedNumberRows =
false;
2167 const QVariant &defaultValue = QVariant(),
2168 bool optional =
false );
2173 static QString
typeName() {
return QStringLiteral(
"multilayer" ); }
2176 bool checkValueIsAcceptable(
const QVariant &input,
QgsProcessingContext *context =
nullptr )
const override;
2177 QString valueAsPythonString(
const QVariant &value,
QgsProcessingContext &context )
const override;
2179 QVariant valueAsJsonObject(
const QVariant &value,
QgsProcessingContext &context )
const override;
2180 QString asScriptCode()
const override;
2182 QString createFileFilter()
const override;
2201 int minimumNumberInputs()
const;
2208 void setMinimumNumberInputs(
int minimum );
2210 QVariantMap toVariantMap()
const override;
2211 bool fromVariantMap(
const QVariantMap &map )
override;
2221 int mMinimumNumberInputs = 0;
2251 const QVariant &defaultValue = QVariant(),
2252 bool optional =
false,
2253 double minValue = std::numeric_limits<double>::lowest() + 1,
2254 double maxValue = std::numeric_limits<double>::max()
2260 static QString
typeName() {
return QStringLiteral(
"number" ); }
2263 bool checkValueIsAcceptable(
const QVariant &input,
QgsProcessingContext *context =
nullptr )
const override;
2264 QString valueAsPythonString(
const QVariant &value,
QgsProcessingContext &context )
const override;
2265 QString toolTip()
const override;
2272 double minimum()
const;
2278 void setMinimum(
double minimum );
2284 double maximum()
const;
2290 void setMaximum(
double maximum );
2304 QVariantMap toVariantMap()
const override;
2305 bool fromVariantMap(
const QVariantMap &map )
override;
2314 double mMin = std::numeric_limits<double>::lowest() + 1;
2315 double mMax = std::numeric_limits<double>::max();
2346 const QVariant &defaultValue = QVariant(),
2347 const QString &parentParameterName = QString(),
2348 bool optional =
false,
2349 double minValue = std::numeric_limits<double>::lowest() + 1,
2350 double maxValue = std::numeric_limits<double>::max() );
2355 static QString
typeName() {
return QStringLiteral(
"distance" ); }
2359 QString type() const override;
2360 QStringList dependsOnOtherParameters() const override;
2361 QString asPythonString(
QgsProcessing::PythonOutputType outputType =
QgsProcessing::PythonOutputType::PythonQgsProcessingAlgorithmSubclass ) const override;
2367 QString parentParameterName() const;
2373 void setParentParameterName( const QString &parentParameterName );
2381 Qgis::DistanceUnit defaultUnit()
const {
return mDefaultUnit; }
2391 QVariantMap toVariantMap()
const override;
2392 bool fromVariantMap(
const QVariantMap &map )
override;
2396 QString mParentParameterName;
2416 const QVariant &defaultValue = QVariant(),
2417 bool optional =
false,
2418 double minValue = std::numeric_limits<double>::lowest() + 1,
2419 double maxValue = std::numeric_limits<double>::max() );
2424 static QString
typeName() {
return QStringLiteral(
"duration" ); }
2428 QString type() const override;
2429 QString asPythonString(
QgsProcessing::PythonOutputType outputType =
QgsProcessing::PythonOutputType::PythonQgsProcessingAlgorithmSubclass ) const override;
2436 Qgis::TemporalUnit defaultUnit()
const {
return mDefaultUnit; }
2445 QVariantMap toVariantMap()
const override;
2446 bool fromVariantMap(
const QVariantMap &map )
override;
2472 const QVariant &defaultValue = QVariant(),
2473 bool optional =
false );
2478 static QString
typeName() {
return QStringLiteral(
"scale" ); }
2482 QString type() const override;
2483 QString asPythonString(
QgsProcessing::PythonOutputType outputType =
QgsProcessing::PythonOutputType::PythonQgsProcessingAlgorithmSubclass ) const override;
2506 const QVariant &defaultValue = QVariant(),
2507 bool optional =
false );
2512 static QString
typeName() {
return QStringLiteral(
"range" ); }
2515 bool checkValueIsAcceptable(
const QVariant &input,
QgsProcessingContext *context =
nullptr )
const override;
2516 QString valueAsPythonString(
const QVariant &value,
QgsProcessingContext &context )
const override;
2531 QVariantMap toVariantMap()
const override;
2532 bool fromVariantMap(
const QVariantMap &map )
override;
2557 bool optional =
false );
2562 static QString
typeName() {
return QStringLiteral(
"raster" ); }
2565 bool checkValueIsAcceptable(
const QVariant &input,
QgsProcessingContext *context =
nullptr )
const override;
2566 QString valueAsPythonString(
const QVariant &value,
QgsProcessingContext &context )
const override;
2568 QVariant valueAsJsonObject(
const QVariant &value,
QgsProcessingContext &context )
const override;
2569 QString createFileFilter()
const override;
2602 QgsProcessingParameterEnum(
const QString &name,
const QString &description = QString(),
const QStringList &options = QStringList(),
2603 bool allowMultiple =
false,
2604 const QVariant &defaultValue = QVariant(),
2605 bool optional =
false,
2606 bool usesStaticStrings =
false );
2611 static QString
typeName() {
return QStringLiteral(
"enum" ); }
2614 bool checkValueIsAcceptable(
const QVariant &input,
QgsProcessingContext *context =
nullptr )
const override;
2615 QString valueAsPythonString(
const QVariant &value,
QgsProcessingContext &context )
const override;
2616 QString valueAsPythonComment(
const QVariant &value,
QgsProcessingContext &context )
const override;
2617 QString asScriptCode()
const override;
2624 QStringList options()
const;
2630 void setOptions(
const QStringList &options );
2636 bool allowMultiple()
const;
2642 void setAllowMultiple(
bool allowMultiple );
2650 bool usesStaticStrings()
const;
2658 void setUsesStaticStrings(
bool usesStaticStrings );
2660 QVariantMap toVariantMap()
const override;
2661 bool fromVariantMap(
const QVariantMap &map )
override;
2670 QStringList mOptions;
2671 bool mAllowMultiple =
false;
2672 bool mUsesStaticStrings =
false;
2709 bool multiLine =
false,
2710 bool optional =
false );
2715 static QString
typeName() {
return QStringLiteral(
"string" ); }
2718 QString valueAsPythonString(
const QVariant &value,
QgsProcessingContext &context )
const override;
2719 QString asScriptCode()
const override;
2726 bool multiLine()
const;
2732 void setMultiLine(
bool multiLine );
2734 QVariantMap toVariantMap()
const override;
2735 bool fromVariantMap(
const QVariantMap &map )
override;
2744 bool mMultiLine =
false;
2769 bool optional =
false );
2774 static QString
typeName() {
return QStringLiteral(
"authcfg" ); }
2777 QString valueAsPythonString(
const QVariant &value,
QgsProcessingContext &context )
const override;
2778 QString asScriptCode()
const override;
2800 const QString &parentLayerParameterName = QString(),
2806 static QString
typeName() {
return QStringLiteral(
"expression" ); }
2809 QString valueAsPythonString(
const QVariant &value,
QgsProcessingContext &context )
const override;
2810 QStringList dependsOnOtherParameters()
const override;
2817 QString parentLayerParameterName()
const;
2823 void setParentLayerParameterName(
const QString &parentLayerParameterName );
2841 QVariantMap toVariantMap()
const override;
2842 bool fromVariantMap(
const QVariantMap &map )
override;
2851 QString mParentLayerParameterName;
2874 QList< int > dataTypes()
const;
2880 void setDataTypes(
const QList< int > &types );
2902 const QString &description = QString(),
2903 const QList< int > &types = QList< int >(),
2904 const QVariant &defaultValue = QVariant(),
2905 bool optional =
false );
2910 static QString
typeName() {
return QStringLiteral(
"vector" ); }
2913 bool checkValueIsAcceptable(
const QVariant &input,
QgsProcessingContext *context =
nullptr )
const override;
2914 QString valueAsPythonString(
const QVariant &value,
QgsProcessingContext &context )
const override;
2916 QVariant valueAsJsonObject(
const QVariant &value,
QgsProcessingContext &context )
const override;
2918 QString createFileFilter()
const override;
2920 QVariantMap toVariantMap()
const override;
2921 bool fromVariantMap(
const QVariantMap &map )
override;
2944 const QString &description = QString(),
2945 const QVariant &defaultValue = QVariant(),
2946 bool optional =
false );
2951 static QString
typeName() {
return QStringLiteral(
"mesh" ); }
2954 bool checkValueIsAcceptable(
const QVariant &input,
QgsProcessingContext *context =
nullptr )
const override;
2955 QString valueAsPythonString(
const QVariant &value,
QgsProcessingContext &context )
const override;
2957 QVariant valueAsJsonObject(
const QVariant &value,
QgsProcessingContext &context )
const override;
2958 QString createFileFilter()
const override;
2979 bool optional =
false,
2980 const QList< int > &types = QList< int >() );
2985 static QString
typeName() {
return QStringLiteral(
"layer" ); }
2988 bool checkValueIsAcceptable(
const QVariant &input,
QgsProcessingContext *context =
nullptr )
const override;
2989 QString valueAsPythonString(
const QVariant &value,
QgsProcessingContext &context )
const override;
2991 QVariant valueAsJsonObject(
const QVariant &value,
QgsProcessingContext &context )
const override;
2992 QString asScriptCode()
const override;
2994 QString createFileFilter()
const override;
2996 QVariantMap toVariantMap()
const override;
2997 bool fromVariantMap(
const QVariantMap &map )
override;
3018 QgsProcessingParameterField(
const QString &name,
const QString &description = QString(),
const QVariant &defaultValue = QVariant(),
3019 const QString &parentLayerParameterName = QString(),
3021 bool allowMultiple =
false,
3022 bool optional =
false,
3023 bool defaultToAllFields =
false );
3028 static QString
typeName() {
return QStringLiteral(
"field" ); }
3031 bool checkValueIsAcceptable(
const QVariant &input,
QgsProcessingContext *context =
nullptr )
const override;
3032 QString valueAsPythonString(
const QVariant &value,
QgsProcessingContext &context )
const override;
3033 QString asScriptCode()
const override;
3035 QStringList dependsOnOtherParameters()
const override;
3041 QString parentLayerParameterName()
const;
3047 void setParentLayerParameterName(
const QString &parentLayerParameterName );
3065 bool allowMultiple()
const;
3071 void setAllowMultiple(
bool allowMultiple );
3082 bool defaultToAllFields()
const;
3093 void setDefaultToAllFields(
bool enabled );
3095 QVariantMap toVariantMap()
const override;
3096 bool fromVariantMap(
const QVariantMap &map )
override;
3105 QString mParentLayerParameterName;
3107 bool mAllowMultiple =
false;
3108 bool mDefaultToAllFields =
false;
3126 const QList< int > &types = QList< int >(),
3127 const QVariant &defaultValue = QVariant(),
bool optional =
false );
3132 static QString
typeName() {
return QStringLiteral(
"source" ); }
3135 bool checkValueIsAcceptable(
const QVariant &input,
QgsProcessingContext *context =
nullptr )
const override;
3136 QString valueAsPythonString(
const QVariant &value,
QgsProcessingContext &context )
const override;
3138 QVariant valueAsJsonObject(
const QVariant &value,
QgsProcessingContext &context )
const override;
3139 QString asScriptCode()
const override;
3141 QString createFileFilter()
const override;
3143 QVariantMap toVariantMap()
const override;
3144 bool fromVariantMap(
const QVariantMap &map )
override;
3170 bool optional =
false,
bool createByDefault =
true );
3173 QVariantMap toVariantMap()
const override;
3174 bool fromVariantMap(
const QVariantMap &map )
override;
3176 QString createFileFilter()
const override;
3209 virtual QString generateTemporaryDestination(
const QgsProcessingContext *context =
nullptr )
const;
3232 bool createByDefault()
const;
3239 void setCreateByDefault(
bool createByDefault );
3264 bool mSupportsNonFileBasedOutputs =
true;
3265 bool mCreateByDefault =
true;
3267 friend class QgsProcessingModelAlgorithm;
3268 friend class TestQgsProcessing;
3269 friend class TestQgsProcessingModelAlgorithm;
3291 bool optional =
false,
bool createByDefault =
true,
bool supportsAppend =
false );
3296 static QString
typeName() {
return QStringLiteral(
"sink" ); }
3299 bool checkValueIsAcceptable(
const QVariant &input,
QgsProcessingContext *context =
nullptr )
const override;
3300 QString valueAsPythonString(
const QVariant &value,
QgsProcessingContext &context )
const override;
3301 QString asScriptCode()
const override;
3303 QString defaultFileExtension() const override;
3304 QString asPythonString(
QgsProcessing::PythonOutputType outputType =
QgsProcessing::PythonOutputType::PythonQgsProcessingAlgorithmSubclass ) const override;
3305 QString createFileFilter() const override;
3312 virtual QStringList supportedOutputVectorLayerExtensions() const;
3318 Qgis::ProcessingSourceType dataType() const;
3324 bool hasGeometry() const;
3330 void setDataType(
Qgis::ProcessingSourceType type );
3340 bool supportsAppend() const;
3350 void setSupportsAppend(
bool supportsAppend );
3352 QVariantMap toVariantMap() const override;
3353 bool fromVariantMap( const QVariantMap &map ) override;
3354 QString generateTemporaryDestination( const
QgsProcessingContext *context =
nullptr ) const override;
3363 Qgis::ProcessingSourceType mDataType =
Qgis::ProcessingSourceType::VectorAnyGeometry;
3364 bool mSupportsAppend = false;
3388 bool optional =
false,
bool createByDefault =
true );
3393 static QString
typeName() {
return QStringLiteral(
"vectorDestination" ); }
3396 bool checkValueIsAcceptable(
const QVariant &input,
QgsProcessingContext *context =
nullptr )
const override;
3397 QString valueAsPythonString(
const QVariant &value,
QgsProcessingContext &context )
const override;
3398 QString asScriptCode()
const override;
3400 QString defaultFileExtension() const override;
3401 QString asPythonString(
QgsProcessing::PythonOutputType outputType =
QgsProcessing::PythonOutputType::PythonQgsProcessingAlgorithmSubclass ) const override;
3402 QString createFileFilter() const override;
3409 virtual QStringList supportedOutputVectorLayerExtensions() const;
3415 Qgis::ProcessingSourceType dataType() const;
3421 bool hasGeometry() const;
3427 void setDataType(
Qgis::ProcessingSourceType type );
3429 QVariantMap toVariantMap() const override;
3430 bool fromVariantMap( const QVariantMap &map ) override;
3440 Qgis::ProcessingSourceType mDataType =
Qgis::ProcessingSourceType::VectorAnyGeometry;
3460 const QVariant &defaultValue = QVariant(),
3461 bool optional =
false,
3462 bool createByDefault =
true );
3467 static QString
typeName() {
return QStringLiteral(
"rasterDestination" ); }
3470 bool checkValueIsAcceptable(
const QVariant &input,
QgsProcessingContext *context =
nullptr )
const override;
3471 QString valueAsPythonString(
const QVariant &value,
QgsProcessingContext &context )
const override;
3473 QString defaultFileExtension() const override;
3474 QString createFileFilter() const override;
3481 virtual QStringList supportedOutputRasterLayerExtensions() const;
3520 const QString &fileFilter = QString(),
3521 const QVariant &defaultValue = QVariant(),
3522 bool optional =
false,
3523 bool createByDefault =
true );
3528 static QString
typeName() {
return QStringLiteral(
"fileDestination" ); }
3531 bool checkValueIsAcceptable(
const QVariant &input,
QgsProcessingContext *context =
nullptr )
const override;
3532 QString valueAsPythonString(
const QVariant &value,
QgsProcessingContext &context )
const override;
3534 QString defaultFileExtension() const override;
3535 QString asPythonString(
QgsProcessing::PythonOutputType outputType =
QgsProcessing::PythonOutputType::PythonQgsProcessingAlgorithmSubclass ) const override;
3536 QString createFileFilter() const override;
3542 QString fileFilter() const;
3548 void setFileFilter( const QString &filter );
3550 QVariantMap toVariantMap() const override;
3551 bool fromVariantMap( const QVariantMap &map ) override;
3561 QString mFileFilter;
3578 const QVariant &defaultValue = QVariant(),
3579 bool optional =
false,
3580 bool createByDefault =
true );
3585 static QString
typeName() {
return QStringLiteral(
"folderDestination" ); }
3588 bool checkValueIsAcceptable(
const QVariant &input,
QgsProcessingContext *context =
nullptr )
const override;
3590 QString defaultFileExtension() const override;
3611 QgsProcessingParameterBand(
const QString &name,
const QString &description = QString(),
const QVariant &defaultValue = QVariant(),
3612 const QString &parentLayerParameterName = QString(),
3613 bool optional =
false,
3614 bool allowMultiple =
false );
3619 static QString
typeName() {
return QStringLiteral(
"band" ); }
3622 bool checkValueIsAcceptable(
const QVariant &input,
QgsProcessingContext *context =
nullptr )
const override;
3623 QString valueAsPythonString(
const QVariant &value,
QgsProcessingContext &context )
const override;
3624 QString asScriptCode()
const override;
3625 QStringList dependsOnOtherParameters()
const override;
3632 QString parentLayerParameterName()
const;
3638 void setParentLayerParameterName(
const QString &parentLayerParameterName );
3640 QVariantMap toVariantMap()
const override;
3641 bool fromVariantMap(
const QVariantMap &map )
override;
3653 bool allowMultiple()
const;
3660 void setAllowMultiple(
bool allowMultiple );
3664 QString mParentLayerParameterName;
3665 bool mAllowMultiple =
false;
3687 bool optional =
false );
3692 static QString
typeName() {
return QStringLiteral(
"layout" ); }
3695 QString valueAsPythonString(
const QVariant &value,
QgsProcessingContext &context )
const override;
3696 QString asScriptCode()
const override;
3725 const QString &parentLayoutParameterName = QString(),
3727 bool optional =
false );
3732 static QString
typeName() {
return QStringLiteral(
"layoutitem" ); }
3735 QString valueAsPythonString(
const QVariant &value,
QgsProcessingContext &context )
const override;
3736 QString asScriptCode()
const override;
3738 QVariantMap toVariantMap()
const override;
3739 bool fromVariantMap(
const QVariantMap &map )
override;
3740 QStringList dependsOnOtherParameters()
const override;
3751 QString parentLayoutParameterName()
const;
3757 void setParentLayoutParameterName(
const QString &name );
3766 int itemType()
const;
3775 void setItemType(
int type );
3778 QString mParentLayoutParameterName;
3800 QgsProcessingParameterColor(
const QString &name,
const QString &description = QString(),
const QVariant &defaultValue = QVariant(),
3801 bool opacityEnabled =
true,
3802 bool optional =
false );
3807 static QString
typeName() {
return QStringLiteral(
"color" ); }
3810 QString valueAsPythonString(
const QVariant &value,
QgsProcessingContext &context )
const override;
3811 QString asScriptCode()
const override;
3813 bool checkValueIsAcceptable(
const QVariant &input,
QgsProcessingContext *context =
nullptr )
const override;
3814 QVariantMap toVariantMap()
const override;
3815 bool fromVariantMap(
const QVariantMap &map )
override;
3823 bool opacityEnabled()
const;
3832 void setOpacityEnabled(
bool enabled );
3841 bool mAllowOpacity =
true;
3863 const QString &sourceCrsParameterName = QString(),
const QString &destinationCrsParameterName = QString(),
3864 const QVariant &staticSourceCrs = QVariant(),
const QVariant &staticDestinationCrs = QVariant(),
3865 bool optional =
false );
3870 static QString
typeName() {
return QStringLiteral(
"coordinateoperation" ); }
3873 QString valueAsPythonString(
const QVariant &value,
QgsProcessingContext &context )
const override;
3874 QString asScriptCode()
const override;
3876 QStringList dependsOnOtherParameters()
const override;
3878 QVariantMap toVariantMap()
const override;
3879 bool fromVariantMap(
const QVariantMap &map )
override;
3944 QString mSourceParameterName;
3945 QString mDestParameterName;
3946 QVariant mSourceCrs;
3969 bool optional =
false );
3974 static QString
typeName() {
return QStringLiteral(
"maptheme" ); }
3977 bool checkValueIsAcceptable(
const QVariant &input,
QgsProcessingContext *context =
nullptr )
const override;
3978 QString valueAsPythonString(
const QVariant &value,
QgsProcessingContext &context )
const override;
3979 QString asScriptCode()
const override;
3981 QVariantMap toVariantMap()
const override;
3982 bool fromVariantMap(
const QVariantMap &map )
override;
4013 const QVariant &defaultValue = QVariant(),
4014 bool optional =
false,
4015 const QDateTime &minValue = QDateTime(),
4016 const QDateTime &maxValue = QDateTime()
4022 static QString
typeName() {
return QStringLiteral(
"datetime" ); }
4025 bool checkValueIsAcceptable(
const QVariant &input,
QgsProcessingContext *context =
nullptr )
const override;
4026 QString valueAsPythonString(
const QVariant &value,
QgsProcessingContext &context )
const override;
4027 QString toolTip()
const override;
4037 QDateTime minimum()
const;
4050 void setMinimum(
const QDateTime &minimum );
4059 QDateTime maximum()
const;
4072 void setMaximum(
const QDateTime &maximum );
4086 QVariantMap toVariantMap()
const override;
4087 bool fromVariantMap(
const QVariantMap &map )
override;
4123 bool optional =
false );
4128 static QString
typeName() {
return QStringLiteral(
"providerconnection" ); }
4131 bool checkValueIsAcceptable(
const QVariant &input,
QgsProcessingContext *context =
nullptr )
const override;
4132 QString valueAsPythonString(
const QVariant &value,
QgsProcessingContext &context )
const override;
4133 QString asScriptCode()
const override;
4135 QVariantMap toVariantMap()
const override;
4136 bool fromVariantMap(
const QVariantMap &map )
override;
4157 QString mProviderId;
4183 QgsProcessingParameterDatabaseSchema(
const QString &name,
const QString &description,
const QString &connectionParameterName = QString(),
const QVariant &defaultValue = QVariant(),
4184 bool optional =
false );
4189 static QString
typeName() {
return QStringLiteral(
"databaseschema" ); }
4192 bool checkValueIsAcceptable(
const QVariant &input,
QgsProcessingContext *context =
nullptr )
const override;
4193 QString valueAsPythonString(
const QVariant &value,
QgsProcessingContext &context )
const override;
4194 QString asScriptCode()
const override;
4196 QVariantMap toVariantMap()
const override;
4197 bool fromVariantMap(
const QVariantMap &map )
override;
4198 QStringList dependsOnOtherParameters()
const override;
4204 QString parentConnectionParameterName()
const;
4210 void setParentConnectionParameterName(
const QString &name );
4219 QString mParentConnectionParameterName;
4247 const QString &connectionParameterName = QString(),
4248 const QString &schemaParameterName = QString(),
4249 const QVariant &defaultValue = QVariant(),
4250 bool optional =
false,
4251 bool allowNewTableNames =
false );
4256 static QString
typeName() {
return QStringLiteral(
"databasetable" ); }
4259 bool checkValueIsAcceptable(
const QVariant &input,
QgsProcessingContext *context =
nullptr )
const override;
4260 QString valueAsPythonString(
const QVariant &value,
QgsProcessingContext &context )
const override;
4261 QString asScriptCode()
const override;
4263 QVariantMap toVariantMap()
const override;
4264 bool fromVariantMap(
const QVariantMap &map )
override;
4265 QStringList dependsOnOtherParameters()
const override;
4271 QString parentConnectionParameterName()
const;
4277 void setParentConnectionParameterName(
const QString &name );
4283 QString parentSchemaParameterName()
const;
4289 void setParentSchemaParameterName(
const QString &name );
4302 bool allowNewTableNames()
const;
4310 void setAllowNewTableNames(
bool allowed );
4314 QString mParentConnectionParameterName;
4315 QString mParentSchemaParameterName;
4316 bool mAllowNewTableNames =
false;
4334 const QVariant &defaultValue = QVariant(),
bool optional =
false );
4339 static QString
typeName() {
return QStringLiteral(
"pointcloud" ); }
4342 bool checkValueIsAcceptable(
const QVariant &input,
QgsProcessingContext *context =
nullptr )
const override;
4343 QString valueAsPythonString(
const QVariant &value,
QgsProcessingContext &context )
const override;
4345 QVariant valueAsJsonObject(
const QVariant &value,
QgsProcessingContext &context )
const override;
4346 QString createFileFilter()
const override;
4369 const QVariant &defaultValue = QVariant(),
bool optional =
false );
4374 static QString
typeName() {
return QStringLiteral(
"annotation" ); }
4377 bool checkValueIsAcceptable(
const QVariant &input,
QgsProcessingContext *context =
nullptr )
const override;
4378 QString valueAsPythonString(
const QVariant &value,
QgsProcessingContext &context )
const override;
4380 QVariant valueAsJsonObject(
const QVariant &value,
QgsProcessingContext &context )
const override;
4406 const QVariant &defaultValue = QVariant(),
4407 bool optional =
false,
4408 bool createByDefault =
true );
4413 static QString
typeName() {
return QStringLiteral(
"pointCloudDestination" ); }
4416 bool checkValueIsAcceptable(
const QVariant &input,
QgsProcessingContext *context =
nullptr )
const override;
4417 QString valueAsPythonString(
const QVariant &value,
QgsProcessingContext &context )
const override;
4419 QString defaultFileExtension() const override;
4420 QString createFileFilter() const override;
4426 virtual QStringList supportedOutputPointCloudLayerExtensions() const;
4448 const QString &parentLayerParameterName = QString(),
4449 bool allowMultiple =
false,
4450 bool optional =
false,
4451 bool defaultToAllAttributes =
false );
4456 static QString
typeName() {
return QStringLiteral(
"attribute" ); }
4459 bool checkValueIsAcceptable(
const QVariant &input,
QgsProcessingContext *context =
nullptr )
const override;
4460 QString valueAsPythonString(
const QVariant &value,
QgsProcessingContext &context )
const override;
4461 QString asScriptCode()
const override;
4463 QStringList dependsOnOtherParameters()
const override;
4469 QString parentLayerParameterName()
const;
4475 void setParentLayerParameterName(
const QString &parentLayerParameterName );
4481 bool allowMultiple()
const;
4487 void setAllowMultiple(
bool allowMultiple );
4497 bool defaultToAllAttributes()
const;
4507 void setDefaultToAllAttributes(
bool enabled );
4509 QVariantMap toVariantMap()
const override;
4510 bool fromVariantMap(
const QVariantMap &map )
override;
4519 QString mParentLayerParameterName;
4520 bool mAllowMultiple =
false;
4521 bool mDefaultToAllAttributes =
false;
4542 const QVariant &defaultValue = QVariant(),
4543 bool optional =
false,
4544 bool createByDefault =
true );
4549 static QString
typeName() {
return QStringLiteral(
"vectorTileDestination" ); }
4552 bool checkValueIsAcceptable(
const QVariant &input,
QgsProcessingContext *context =
nullptr )
const override;
4553 QString valueAsPythonString(
const QVariant &value,
QgsProcessingContext &context )
const override;
4555 QString defaultFileExtension() const override;
4556 QString createFileFilter() const override;
4562 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
