18 #ifndef QGSPROCESSINGPARAMETERTYPEIMPL_H 19 #define QGSPROCESSINGPARAMETERTYPEIMPL_H 24 #include <QCoreApplication> 44 return QCoreApplication::translate(
"Processing",
"A raster layer parameter." );
47 QString
name()
const override 49 return QCoreApplication::translate(
"Processing",
"Raster Layer" );
54 return QStringLiteral(
"from qgis.core import QgsProcessingParameterRasterLayer" );
59 return QStringLiteral(
"QgsProcessingParameterRasterLayer" );
62 QString
id()
const override 64 return QStringLiteral(
"raster" );
69 return QStringList() << QObject::tr(
"str: layer ID" )
70 << QObject::tr(
"str: layer name" )
71 << QObject::tr(
"str: layer source" )
72 << QStringLiteral(
"QgsProperty" )
73 << QStringLiteral(
"QgsRasterLayer" );
93 return QCoreApplication::translate(
"Processing",
"A mesh layer parameter." );
96 QString
name()
const override 98 return QCoreApplication::translate(
"Processing",
"Mesh Layer" );
103 return QStringLiteral(
"from qgis.core import QgsProcessingParameterMeshLayer" );
108 return QStringLiteral(
"QgsProcessingParameterMeshLayer" );
111 QString
id()
const override 113 return QStringLiteral(
"mesh" );
118 return QStringList() << QObject::tr(
"str: layer ID" )
119 << QObject::tr(
"str: layer name" )
120 << QObject::tr(
"str: layer source" )
121 << QStringLiteral(
"QgsMeshLayer" );
141 return QCoreApplication::translate(
"Processing",
"A vector layer parameter, e.g. for algorithms which change layer styles, edit layers in place, or other operations which affect an entire layer." );
144 QString
name()
const override 146 return QCoreApplication::translate(
"Processing",
"Vector Layer" );
151 return QStringLiteral(
"from qgis.core import QgsProcessingParameterVectorLayer" );
156 return QStringLiteral(
"QgsProcessingParameterVectorLayer" );
159 QString
id()
const override 161 return QStringLiteral(
"vector" );
166 return QStringList() << QObject::tr(
"str: layer ID" )
167 << QObject::tr(
"str: layer name" )
168 << QObject::tr(
"str: layer source" )
169 << QStringLiteral(
"QgsProperty" )
170 << QStringLiteral(
"QgsVectorLayer" );
190 return QCoreApplication::translate(
"Processing",
"A generic map layer parameter, which accepts either vector or raster layers." );
193 QString
name()
const override 195 return QCoreApplication::translate(
"Processing",
"Map Layer" );
198 QString
id()
const override 200 return QStringLiteral(
"layer" );
205 return QStringLiteral(
"from qgis.core import QgsProcessingParameterMapLayer" );
210 return QStringLiteral(
"QgsProcessingParameterMapLayer" );
215 return QStringList() << QObject::tr(
"str: layer ID" )
216 << QObject::tr(
"str: layer name" )
217 << QObject::tr(
"str: layer source" )
218 << QStringLiteral(
"QgsMapLayer" )
219 << QStringLiteral(
"QgsProperty" )
220 << QStringLiteral(
"QgsRasterLayer" )
221 << QStringLiteral(
"QgsVectorLayer" );
241 return QCoreApplication::translate(
"Processing",
"A boolean parameter, for true/false values." );
244 QString
name()
const override 246 return QCoreApplication::translate(
"Processing",
"Boolean" );
249 QString
id()
const override 251 return QStringLiteral(
"boolean" );
256 return QStringLiteral(
"from qgis.core import QgsProcessingParameterBoolean" );
261 return QStringLiteral(
"QgsProcessingParameterBoolean" );
266 return QStringList() << QStringLiteral(
"bool" )
267 << QStringLiteral(
"int" )
268 << QStringLiteral(
"str" )
269 << QStringLiteral(
"QgsProperty" );
289 return QCoreApplication::translate(
"Processing",
"An expression parameter, to add custom expressions based on layer fields." );
292 QString
name()
const override 294 return QCoreApplication::translate(
"Processing",
"Expression" );
297 QString
id()
const override 299 return QStringLiteral(
"expression" );
304 return QStringLiteral(
"from qgis.core import QgsProcessingParameterExpression" );
309 return QStringLiteral(
"QgsProcessingParameterExpression" );
314 return QStringList() << QStringLiteral(
"str" )
315 << QStringLiteral(
"QgsProperty" );
335 return QCoreApplication::translate(
"Processing",
"A coordinate reference system (CRS) input parameter." );
338 QString
name()
const override 340 return QCoreApplication::translate(
"Processing",
"CRS" );
343 QString
id()
const override 345 return QStringLiteral(
"crs" );
350 return QStringLiteral(
"from qgis.core import QgsProcessingParameterCrs" );
355 return QStringLiteral(
"QgsProcessingParameterCrs" );
361 << QStringLiteral(
"str: 'ProjectCrs'" )
362 << QObject::tr(
"str: CRS auth ID (e.g. 'EPSG:3111')" )
363 << QObject::tr(
"str: CRS PROJ4 (e.g. 'PROJ4:…')" )
364 << QObject::tr(
"str: CRS WKT (e.g. 'WKT:…')" )
365 << QObject::tr(
"str: layer ID. CRS of layer is used." )
366 << QObject::tr(
"str: layer name. CRS of layer is used." )
367 << QObject::tr(
"str: layer source. CRS of layer is used." )
368 << QObject::tr(
"QgsCoordinateReferenceSystem" )
369 << QObject::tr(
"QgsMapLayer: CRS of layer is used" )
370 << QObject::tr(
"QgsProcessingFeatureSourceDefinition: CRS of source is used" )
371 << QStringLiteral(
"QgsProperty" );
391 return QCoreApplication::translate(
"Processing",
"A numeric range parameter for processing algorithms." );
394 QString
name()
const override 396 return QCoreApplication::translate(
"Processing",
"Range" );
399 QString
id()
const override 401 return QStringLiteral(
"range" );
406 return QStringLiteral(
"from qgis.core import QgsProcessingParameterRange" );
411 return QStringLiteral(
"QgsProcessingParameterRange" );
416 return QStringList() << QObject::tr(
"list[float]: list of 2 float values" )
417 << QObject::tr(
"list[str]: list of strings representing floats" )
418 << QObject::tr(
"str: as two comma delimited floats, e.g. '1,10'" )
419 << QStringLiteral(
"QgsProperty" );
439 return QCoreApplication::translate(
"Processing",
"A geographic point parameter." );
442 QString
name()
const override 444 return QCoreApplication::translate(
"Processing",
"Point" );
447 QString
id()
const override 449 return QStringLiteral(
"point" );
454 return QStringLiteral(
"from qgis.core import QgsProcessingParameterPoint" );
459 return QStringLiteral(
"QgsProcessingParameterPoint" );
464 return QStringList() << QObject::tr(
"str: as an 'x,y' string, e.g. '1.5,10.1'" )
465 << QStringLiteral(
"QgsPointXY" )
466 << QStringLiteral(
"QgsProperty" )
467 << QStringLiteral(
"QgsReferencedPointXY" );
487 return QCoreApplication::translate(
"Processing",
"An enumerated type parameter." );
490 QString
name()
const override 492 return QCoreApplication::translate(
"Processing",
"Enum" );
495 QString
id()
const override 497 return QStringLiteral(
"enum" );
502 return QStringLiteral(
"from qgis.core import QgsProcessingParameterEnum" );
507 return QStringLiteral(
"QgsProcessingParameterEnum" );
512 return QStringList() << QStringLiteral(
"int" )
513 << QObject::tr(
"str: as string representation of int, e.g. '1'" )
514 << QStringLiteral(
"QgsProperty" );
534 return QCoreApplication::translate(
"Processing",
"A map extent parameter." );
537 QString
name()
const override 539 return QCoreApplication::translate(
"Processing",
"Extent" );
542 QString
id()
const override 544 return QStringLiteral(
"extent" );
549 return QStringLiteral(
"from qgis.core import QgsProcessingParameterExtent" );
554 return QStringLiteral(
"QgsProcessingParameterExtent" );
559 return QStringList() << QObject::tr(
"str: as comma delimited list of x min, x max, y min, y max. E.g. '4,10,101,105'" )
560 << QObject::tr(
"str: layer ID. Extent of layer is used." )
561 << QObject::tr(
"str: layer name. Extent of layer is used." )
562 << QObject::tr(
"str: layer source. Extent of layer is used." )
563 << QObject::tr(
"QgsMapLayer: Extent of layer is used" )
564 << QObject::tr(
"QgsProcessingFeatureSourceDefinition: Extent of source is used" )
565 << QStringLiteral(
"QgsProperty" )
566 << QStringLiteral(
"QgsRectangle" )
567 << QStringLiteral(
"QgsReferencedRectangle" );
587 return QCoreApplication::translate(
"Processing",
"A table (matrix) parameter for processing algorithms." );
590 QString
name()
const override 592 return QCoreApplication::translate(
"Processing",
"Matrix" );
595 QString
id()
const override 597 return QStringLiteral(
"matrix" );
602 return QStringLiteral(
"from qgis.core import QgsProcessingParameterMatrix" );
607 return QStringLiteral(
"QgsProcessingParameterMatrix" );
612 return QStringList() << QObject::tr(
"str: as comma delimited list of values" )
613 << QStringLiteral(
"list" )
614 << QStringLiteral(
"QgsProperty" );
634 return QCoreApplication::translate(
"Processing",
"A file or folder parameter, for use with non-map layer file sources or folders." );
637 QString
name()
const override 639 return QCoreApplication::translate(
"Processing",
"File/Folder" );
642 QString
id()
const override 644 return QStringLiteral(
"file" );
649 return QStringLiteral(
"from qgis.core import QgsProcessingParameterFile" );
654 return QStringLiteral(
"QgsProcessingParameterFile" );
659 return QStringList() << QStringLiteral(
"str" )
660 << QStringLiteral(
"QgsProperty" );
680 return QCoreApplication::translate(
"Processing",
"A vector field parameter, for selecting an existing field from a vector source." );
683 QString
name()
const override 685 return QCoreApplication::translate(
"Processing",
"Vector Field" );
688 QString
id()
const override 690 return QStringLiteral(
"field" );
695 return QStringLiteral(
"from qgis.core import QgsProcessingParameterField" );
700 return QStringLiteral(
"QgsProcessingParameterField" );
705 return QStringList() << QStringLiteral(
"str" )
706 << QStringLiteral(
"QgsProperty" );
727 return QCoreApplication::translate(
"Processing",
"A vector layer destination parameter." );
730 QString
name()
const override 732 return QCoreApplication::translate(
"Processing",
"Vector Destination" );
735 QString
id()
const override 737 return QStringLiteral(
"vectorDestination" );
742 return QStringLiteral(
"from qgis.core import QgsProcessingParameterVectorDestination" );
747 return QStringLiteral(
"QgsProcessingParameterVectorDestination" );
750 ParameterFlags
flags()
const override 753 flags.setFlag( ParameterFlag::ExposeToModeler,
false );
759 return QStringList() << QStringLiteral(
"str" )
760 << QStringLiteral(
"QgsProperty" )
761 << QStringLiteral(
"QgsProcessingOutputLayerDefinition" );
782 return QCoreApplication::translate(
"Processing",
"A generic file based destination parameter." );
785 QString
name()
const override 787 return QCoreApplication::translate(
"Processing",
"File Destination" );
790 QString
id()
const override 792 return QStringLiteral(
"fileDestination" );
797 return QStringLiteral(
"from qgis.core import QgsProcessingParameterFileDestination" );
802 return QStringLiteral(
"QgsProcessingParameterFileDestination" );
805 ParameterFlags
flags()
const override 808 flags.setFlag( ParameterFlag::ExposeToModeler,
false );
814 return QStringList() << QStringLiteral(
"str" )
815 << QStringLiteral(
"QgsProperty" );
837 return QCoreApplication::translate(
"Processing",
"A folder destination parameter." );
840 QString
name()
const override 842 return QCoreApplication::translate(
"Processing",
"Folder Destination" );
845 QString
id()
const override 847 return QStringLiteral(
"folderDestination" );
852 return QStringLiteral(
"from qgis.core import QgsProcessingParameterFolderDestination" );
857 return QStringLiteral(
"QgsProcessingParameterFolderDestination" );
860 ParameterFlags
flags()
const override 863 flags.setFlag( ParameterFlag::ExposeToModeler,
false );
869 return QStringList() << QStringLiteral(
"str" )
870 << QStringLiteral(
"QgsProperty" );
891 return QCoreApplication::translate(
"Processing",
"A raster layer destination parameter." );
894 QString
name()
const override 896 return QCoreApplication::translate(
"Processing",
"Raster Destination" );
899 QString
id()
const override 901 return QStringLiteral(
"rasterDestination" );
906 return QStringLiteral(
"from qgis.core import QgsProcessingParameterRasterDestination" );
911 return QStringLiteral(
"QgsProcessingParameterRasterDestination" );
914 ParameterFlags
flags()
const override 917 flags.setFlag( ParameterFlag::ExposeToModeler,
false );
923 return QStringList() << QStringLiteral(
"str" )
924 << QStringLiteral(
"QgsProperty" )
925 << QStringLiteral(
"QgsProcessingOutputLayerDefinition" );
945 return QCoreApplication::translate(
"Processing",
"A freeform string parameter." );
948 QString
name()
const override 950 return QCoreApplication::translate(
"Processing",
"String" );
953 QString
id()
const override 955 return QStringLiteral(
"string" );
960 return QStringLiteral(
"from qgis.core import QgsProcessingParameterString" );
965 return QStringLiteral(
"QgsProcessingParameterString" );
970 return QStringList() << QStringLiteral(
"str" )
971 << QStringLiteral(
"QgsProperty" );
991 return QCoreApplication::translate(
"Processing",
"A authentication configuration parameter." );
994 QString
name()
const override 996 return QCoreApplication::translate(
"Processing",
"Authentication Configuration" );
999 QString
id()
const override 1001 return QStringLiteral(
"authcfg" );
1006 return QStringLiteral(
"from qgis.core import QgsProcessingParameterAuthConfig" );
1011 return QStringLiteral(
"QgsProcessingParameterAuthConfig" );
1016 return QStringList() << QStringLiteral(
"str" );
1036 return QCoreApplication::translate(
"Processing",
"An input allowing selection of multiple sources, including multiple map layers or file sources." );
1039 QString
name()
const override 1041 return QCoreApplication::translate(
"Processing",
"Multiple Input" );
1044 QString
id()
const override 1046 return QStringLiteral(
"multilayer" );
1051 return QStringLiteral(
"from qgis.core import QgsProcessingParameterMultipleLayers" );
1056 return QStringLiteral(
"QgsProcessingParameterMultipleLayers" );
1061 return QStringList() << QObject::tr(
"list[str]: list of layer IDs" )
1062 << QObject::tr(
"list[str]: list of layer names" )
1063 << QObject::tr(
"list[str]: list of layer sources" )
1064 << QStringLiteral(
"list[QgsMapLayer]" )
1065 << QStringLiteral(
"QgsProperty" );
1085 return QCoreApplication::translate(
"Processing",
"A vector feature parameter, e.g. for algorithms which operate on the features within a layer." );
1088 QString
name()
const override 1090 return QCoreApplication::translate(
"Processing",
"Vector Features" );
1093 QString
id()
const override 1095 return QStringLiteral(
"source" );
1100 return QStringLiteral(
"from qgis.core import QgsProcessingParameterFeatureSource" );
1105 return QStringLiteral(
"QgsProcessingParameterFeatureSource" );
1110 return QStringList() << QObject::tr(
"str: layer ID" )
1111 << QObject::tr(
"str: layer name" )
1112 << QObject::tr(
"str: layer source" )
1113 << QStringLiteral(
"QgsProcessingFeatureSourceDefinition" )
1114 << QStringLiteral(
"QgsProperty" )
1115 << QStringLiteral(
"QgsVectorLayer" );
1135 return QCoreApplication::translate(
"Processing",
"A numeric parameter, including float or integer values." );
1138 QString
name()
const override 1140 return QCoreApplication::translate(
"Processing",
"Number" );
1143 QString
id()
const override 1145 return QStringLiteral(
"number" );
1150 return QStringLiteral(
"from qgis.core import QgsProcessingParameterNumber" );
1155 return QStringLiteral(
"QgsProcessingParameterNumber" );
1160 return QStringList() << QStringLiteral(
"int" )
1161 << QStringLiteral(
"float" )
1162 << QStringLiteral(
"QgsProperty" );
1182 return QCoreApplication::translate(
"Processing",
"A numeric parameter representing a distance measure." );
1185 QString
name()
const override 1187 return QCoreApplication::translate(
"Processing",
"Distance" );
1190 QString
id()
const override 1192 return QStringLiteral(
"distance" );
1197 return QStringLiteral(
"from qgis.core import QgsProcessingParameterDistance" );
1202 return QStringLiteral(
"QgsProcessingParameterDistance" );
1207 return QStringList() << QStringLiteral(
"int" )
1208 << QStringLiteral(
"float" )
1209 << QStringLiteral(
"QgsProperty" );
1230 return QCoreApplication::translate(
"Processing",
"A raster band parameter, for selecting an existing band from a raster source." );
1233 QString
name()
const override 1235 return QCoreApplication::translate(
"Processing",
"Raster Band" );
1238 QString
id()
const override 1240 return QStringLiteral(
"band" );
1245 return QStringLiteral(
"from qgis.core import QgsProcessingParameterBand" );
1250 return QStringLiteral(
"QgsProcessingParameterBand" );
1255 return QStringList() << QStringLiteral(
"int" )
1256 << QStringLiteral(
"QgsProperty" );
1275 ParameterFlags
flags()
const override 1278 flags.setFlag( ParameterFlag::ExposeToModeler,
false );
1284 return QCoreApplication::translate(
"Processing",
"A feature sink destination parameter." );
1287 QString
name()
const override 1289 return QCoreApplication::translate(
"Processing",
"Feature Sink" );
1292 QString
id()
const override 1294 return QStringLiteral(
"sink" );
1299 return QStringLiteral(
"from qgis.core import QgsProcessingParameterFeatureSink" );
1304 return QStringLiteral(
"QgsProcessingParameterFeatureSink" );
1309 return QStringList() << QObject::tr(
"str: destination vector file, e.g. 'd:/test.shp'" )
1310 << QObject::tr(
"str: 'memory:' to store result in temporary memory layer" )
1311 << QObject::tr(
"str: using vector provider ID prefix and destination URI, e.g. 'postgres:…' to store result in PostGIS table" )
1312 << QStringLiteral(
"QgsProcessingOutputLayerDefinition" )
1313 << QStringLiteral(
"QgsProperty" );
1318 #endif // QGSPROCESSINGPARAMETERTYPEIMPL_H A boolean parameter for processing algorithms.
A feature sink parameter for Processing algorithms.
A vector layer destination parameter, for specifying the destination path for a vector layer created ...
An input file or folder parameter for processing algorithms.
A parameter for processing algorithms which accepts multiple map layers.
A generic file based destination parameter, for specifying the destination path for a file (non-map l...
A vector layer or feature source field parameter for processing algorithms.
A mesh layer parameter for processing algorithms.
A map layer parameter for processing algorithms.
virtual QString id() const =0
A static id for this type which will be used for storing this parameter type.
An expression parameter for processing algorithms.
A folder destination parameter, for specifying the destination path for a folder created by the algor...
virtual QStringList acceptedPythonTypes() const
Returns a list of the Python data types accepted as values for the parameter.
A numeric range parameter for processing algorithms.
An expression parameter for processing algorithms.
A raster band parameter for Processing algorithms.
A vector layer or feature source field parameter for processing algorithms.
A numeric parameter for processing algorithms.
A distance parameter for processing algorithms.
A string parameter for processing algorithms.
A feature sink output for processing algorithms.
A raster layer destination parameter, for specifying the destination path for a raster layer created ...
A vector layer parameter for processing algorithms.
A numeric range parameter for processing algorithms.
A boolean parameter for processing algorithms.
A generic map layer parameter for processing algorithms.
An input file or folder parameter for processing algorithms.
A raster layer parameter for processing algorithms.
A raster layer parameter for processing algorithms.
virtual QgsProcessingParameterDefinition * create(const QString &name) const =0
Creates a new parameter of this type.
A raster layer destination parameter, for specifying the destination path for a raster layer created ...
An enum based parameter for processing algorithms, allowing for selection from predefined values...
virtual QString name() const =0
A human readable and translatable short name for this parameter type.
A double numeric parameter for distance values.
A authentication configuration parameter for processing algorithms.
A vector layer (with or without geometry) parameter for processing algorithms.
A mesh layer parameter for processing algorithms.
A coordinate reference system parameter for processing algorithms.
A rectangular map extent parameter for processing algorithms.
A numeric parameter for processing algorithms.
A generic file based destination parameter, for specifying the destination path for a file (non-map l...
A point parameter for processing algorithms.
A table (matrix) parameter for processing algorithms.
A vector layer destination parameter, for specifying the destination path for a vector layer created ...
A parameter for processing algorithms which accepts multiple map layers.
A point parameter for processing algorithms.
A crs parameter for processing algorithms.
virtual QString description() const =0
A human readable and translatable description for this parameter type.
An input feature source (such as vector layers) parameter for processing algorithms.
A folder destination parameter, for specifying the destination path for a folder created by the algor...
virtual QString className() const
Returns the corresponding class name for the parameter type.
Makes metadata of processing parameters available.
Base class for the definition of processing parameters.
virtual QString pythonImportString() const
Returns a valid Python import string for importing the corresponding parameter type, e.g.
An input feature source (such as vector layers) parameter for processing algorithms.
A rectangular map extent parameter for processing algorithms.
An enum based parameter for processing algorithms, allowing for selection from predefined values...
A table (matrix) parameter for processing algorithms.
A string parameter for authentication configuration configuration ID values.
virtual ParameterFlags flags() const
Determines if this parameter is available in the modeler.
A raster band parameter for Processing algorithms.
A string parameter for processing algorithms.