A collection of utilities for working with parameters when running a processing algorithm. More...

#include <qgsprocessingparameters.h>

Static Public Member Functions
static QString	descriptionFromName (const QString &name)
	Creates an autogenerated parameter description from a parameter name. More...

static bool	isDynamic (const QVariantMap &parameters, const QString &name)
	Returns `true` if the parameter with matching name is a dynamic parameter, and must be evaluated once for every input feature processed. More...

static QgsAnnotationLayer *	parameterAsAnnotationLayer (const QgsProcessingParameterDefinition *definition, const QVariant &value, QgsProcessingContext &context)
	Evaluates the parameter with matching definition and value to an annotation layer. More...

static QgsAnnotationLayer *	parameterAsAnnotationLayer (const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters, QgsProcessingContext &context)
	Evaluates the parameter with matching definition to an annotation layer. More...

static bool	parameterAsBool (const QgsProcessingParameterDefinition *definition, const QVariant &value, const QgsProcessingContext &context)
	Evaluates the parameter with matching definition and value to a static boolean value. More...

static bool	parameterAsBool (const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters, const QgsProcessingContext &context)
	Evaluates the parameter with matching definition to a static boolean value. More...

static bool	parameterAsBoolean (const QgsProcessingParameterDefinition *definition, const QVariant &value, const QgsProcessingContext &context)
	Evaluates the parameter with matching definition and value to a static boolean value. More...

static bool	parameterAsBoolean (const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters, const QgsProcessingContext &context)
	Evaluates the parameter with matching definition to a static boolean value. More...

static QColor	parameterAsColor (const QgsProcessingParameterDefinition *definition, const QVariant &value, QgsProcessingContext &context)
	Returns the color associated with an color parameter value, or an invalid color if the parameter was not set. More...

static QColor	parameterAsColor (const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters, QgsProcessingContext &context)
	Returns the color associated with an point parameter value, or an invalid color if the parameter was not set. More...

static QString	parameterAsCompatibleSourceLayerPath (const QgsProcessingParameterDefinition definition, const QVariantMap &parameters, 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 format. More...

static QString	parameterAsCompatibleSourceLayerPathAndLayerName (const QgsProcessingParameterDefinition definition, const QVariantMap &parameters, 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 compatible format. More...

static QString	parameterAsConnectionName (const QgsProcessingParameterDefinition *definition, const QVariant &value, const QgsProcessingContext &context)
	Evaluates the parameter with matching definition and value to a connection name string. More...

static QString	parameterAsConnectionName (const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters, const QgsProcessingContext &context)
	Evaluates the parameter with matching definition to a connection name string. More...

static QgsCoordinateReferenceSystem	parameterAsCrs (const QgsProcessingParameterDefinition *definition, const QVariant &value, QgsProcessingContext &context)
	Evaluates the parameter with matching definition and value to a coordinate reference system. More...

static QgsCoordinateReferenceSystem	parameterAsCrs (const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters, QgsProcessingContext &context)
	Evaluates the parameter with matching definition to a coordinate reference system. More...

static QString	parameterAsDatabaseTableName (const QgsProcessingParameterDefinition *definition, const QVariant &value, const QgsProcessingContext &context)
	Evaluates the parameter with matching definition and value to a database table name. More...

static QString	parameterAsDatabaseTableName (const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters, const QgsProcessingContext &context)
	Evaluates the parameter with matching definition to a database table name. More...

static QDate	parameterAsDate (const QgsProcessingParameterDefinition *definition, const QVariant &value, const QgsProcessingContext &context)
	Evaluates the parameter with matching definition and value to a static date value. More...

static QDate	parameterAsDate (const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters, const QgsProcessingContext &context)
	Evaluates the parameter with matching definition to a static date value. More...

static QDateTime	parameterAsDateTime (const QgsProcessingParameterDefinition *definition, const QVariant &value, const QgsProcessingContext &context)
	Evaluates the parameter with matching definition and value to a static datetime value. More...

static QDateTime	parameterAsDateTime (const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters, const QgsProcessingContext &context)
	Evaluates the parameter with matching definition to a static datetime value. More...

static double	parameterAsDouble (const QgsProcessingParameterDefinition *definition, const QVariant &value, const QgsProcessingContext &context)
	Evaluates the parameter with matching definition and value to a static double value. More...

static double	parameterAsDouble (const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters, const QgsProcessingContext &context)
	Evaluates the parameter with matching definition to a static double value. More...

static int	parameterAsEnum (const QgsProcessingParameterDefinition *definition, const QVariant &value, const QgsProcessingContext &context)
	Evaluates the parameter with matching definition and value to a enum value. More...

static int	parameterAsEnum (const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters, const QgsProcessingContext &context)
	Evaluates the parameter with matching definition to a enum value. More...

static QList< int >	parameterAsEnums (const QgsProcessingParameterDefinition *definition, const QVariant &value, const QgsProcessingContext &context)
	Evaluates the parameter with matching definition and value to list of enum values. More...

static QList< int >	parameterAsEnums (const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters, const QgsProcessingContext &context)
	Evaluates the parameter with matching definition to list of enum values. More...

static QString	parameterAsEnumString (const QgsProcessingParameterDefinition *definition, const QVariant &value, const QgsProcessingContext &context)
	Evaluates the parameter with matching definition and value to a static enum string. More...

static QString	parameterAsEnumString (const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters, const QgsProcessingContext &context)
	Evaluates the parameter with matching definition to a static enum string. More...

static QStringList	parameterAsEnumStrings (const QgsProcessingParameterDefinition *definition, const QVariant &value, const QgsProcessingContext &context)
	Evaluates the parameter with matching definition and value to list of static enum strings. More...

static QStringList	parameterAsEnumStrings (const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters, const QgsProcessingContext &context)
	Evaluates the parameter with matching definition to list of static enum strings. More...

static QString	parameterAsExpression (const QgsProcessingParameterDefinition *definition, const QVariant &value, const QgsProcessingContext &context)
	Evaluates the parameter with matching definitionand value to an expression. More...

static QString	parameterAsExpression (const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters, const QgsProcessingContext &context)
	Evaluates the parameter with matching definition to an expression. More...

static QgsRectangle	parameterAsExtent (const QgsProcessingParameterDefinition *definition, const QVariant &value, QgsProcessingContext &context, const QgsCoordinateReferenceSystem &crs=QgsCoordinateReferenceSystem())
	Evaluates the parameter with matching definition and value to a rectangular extent. More...

static QgsRectangle	parameterAsExtent (const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters, QgsProcessingContext &context, const QgsCoordinateReferenceSystem &crs=QgsCoordinateReferenceSystem())
	Evaluates the parameter with matching definition to a rectangular extent. More...

static QgsCoordinateReferenceSystem	parameterAsExtentCrs (const QgsProcessingParameterDefinition *definition, const QVariant &value, QgsProcessingContext &context)
	Returns the coordinate reference system associated with an extent parameter value. More...

static QgsCoordinateReferenceSystem	parameterAsExtentCrs (const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters, QgsProcessingContext &context)
	Returns the coordinate reference system associated with an extent parameter value. More...

static QgsGeometry	parameterAsExtentGeometry (const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters, QgsProcessingContext &context, const QgsCoordinateReferenceSystem &crs=QgsCoordinateReferenceSystem())
	Evaluates the parameter with matching definition to a rectangular extent, and returns a geometry covering this extent. More...

static QStringList	parameterAsFields (const QgsProcessingParameterDefinition *definition, const QVariant &value, QgsProcessingContext &context)
	Evaluates the parameter with matching definition and value to a list of fields. More...

static QStringList	parameterAsFields (const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters, QgsProcessingContext &context)
	Evaluates the parameter with matching definition to a list of fields. More...

static QString	parameterAsFile (const QgsProcessingParameterDefinition *definition, const QVariant &value, QgsProcessingContext &context)
	Evaluates the parameter with matching definition and value to a file/folder name. More...

static QString	parameterAsFile (const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters, QgsProcessingContext &context)
	Evaluates the parameter with matching definition to a file/folder name. More...

static QStringList	parameterAsFileList (const QgsProcessingParameterDefinition *definition, const QVariant &value, QgsProcessingContext &context)
	Evaluates the parameter with matching definition to a list of files (for QgsProcessingParameterMultipleLayers in QgsProcessing:TypeFile mode). More...

static QStringList	parameterAsFileList (const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters, QgsProcessingContext &context)
	Evaluates the parameter with matching definition to a list of files (for QgsProcessingParameterMultipleLayers in QgsProcessing:TypeFile mode). More...

static QString	parameterAsFileOutput (const QgsProcessingParameterDefinition *definition, const QVariant &value, QgsProcessingContext &context)
	Evaluates the parameter with matching definition and value to a file based output destination. More...

static QString	parameterAsFileOutput (const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters, QgsProcessingContext &context)
	Evaluates the parameter with matching definition to a file based output destination. More...

static QgsGeometry	parameterAsGeometry (const QgsProcessingParameterDefinition *definition, const QVariant &value, QgsProcessingContext &context, const QgsCoordinateReferenceSystem &crs=QgsCoordinateReferenceSystem())
	Evaluates the parameter with matching definition and value to a geometry. More...

static QgsGeometry	parameterAsGeometry (const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters, QgsProcessingContext &context, const QgsCoordinateReferenceSystem &crs=QgsCoordinateReferenceSystem())
	Evaluates the parameter with matching definition to a geometry. More...

static QgsCoordinateReferenceSystem	parameterAsGeometryCrs (const QgsProcessingParameterDefinition *definition, const QVariant &value, QgsProcessingContext &context)
	Returns the coordinate reference system associated with an point parameter value. More...

static QgsCoordinateReferenceSystem	parameterAsGeometryCrs (const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters, QgsProcessingContext &context)
	Returns the coordinate reference system associated with a geometry parameter value. More...

static int	parameterAsInt (const QgsProcessingParameterDefinition *definition, const QVariant &value, const QgsProcessingContext &context)
	Evaluates the parameter with matching definition and value to a static integer value. More...

static int	parameterAsInt (const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters, const QgsProcessingContext &context)
	Evaluates the parameter with matching definition to a static integer value. More...

static QList< int >	parameterAsInts (const QgsProcessingParameterDefinition *definition, const QVariant &value, const QgsProcessingContext &context)
	Evaluates the parameter with matching definition and value to a list of integer values. More...

static QList< int >	parameterAsInts (const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters, const QgsProcessingContext &context)
	Evaluates the parameter with matching definition to a list of integer values. More...

static QgsMapLayer *	parameterAsLayer (const QgsProcessingParameterDefinition *definition, const QVariant &value, QgsProcessingContext &context, QgsProcessingUtils::LayerHint layerHint=QgsProcessingUtils::LayerHint::UnknownType)
	Evaluates the parameter with matching definition and value to a map layer. More...

static QgsMapLayer *	parameterAsLayer (const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingUtils::LayerHint layerHint=QgsProcessingUtils::LayerHint::UnknownType)
	Evaluates the parameter with matching definition to a map layer. More...

static QList< QgsMapLayer * >	parameterAsLayerList (const QgsProcessingParameterDefinition *definition, const QVariant &value, QgsProcessingContext &context)
	Evaluates the parameter with matching definition and value to a list of map layers. More...

static QList< QgsMapLayer * >	parameterAsLayerList (const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters, QgsProcessingContext &context)
	Evaluates the parameter with matching definition to a list of map layers. More...

static QgsPrintLayout *	parameterAsLayout (const QgsProcessingParameterDefinition *definition, const QVariant &value, QgsProcessingContext &context)
	Evaluates the parameter with matching definition and value to a print layout. More...

static QgsPrintLayout *	parameterAsLayout (const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters, QgsProcessingContext &context)
	Evaluates the parameter with matching definition to a print layout. More...

static QgsLayoutItem *	parameterAsLayoutItem (const QgsProcessingParameterDefinition definition, const QVariant &value, QgsProcessingContext &context, QgsPrintLayout layout)
	Evaluates the parameter with matching definition and value to a print layout, taken from the specified layout. More...

static QgsLayoutItem *	parameterAsLayoutItem (const QgsProcessingParameterDefinition definition, const QVariantMap &parameters, QgsProcessingContext &context, QgsPrintLayout layout)
	Evaluates the parameter with matching definition to a print layout item, taken from the specified layout. More...

static QVariantList	parameterAsMatrix (const QgsProcessingParameterDefinition *definition, const QVariant &value, QgsProcessingContext &context)
	Evaluates the parameter with matching definition and value to a matrix/table of values. More...

static QVariantList	parameterAsMatrix (const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters, QgsProcessingContext &context)
	Evaluates the parameter with matching definition to a matrix/table of values. More...

static QgsMeshLayer *	parameterAsMeshLayer (const QgsProcessingParameterDefinition *definition, const QVariant &value, QgsProcessingContext &context)
	Evaluates the parameter with matching definition and value to a mesh layer. More...

static QgsMeshLayer *	parameterAsMeshLayer (const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters, QgsProcessingContext &context)
	Evaluates the parameter with matching definition and value to a mesh layer. More...

static QString	parameterAsOutputLayer (const QgsProcessingParameterDefinition *definition, const QVariant &value, QgsProcessingContext &context)
	Evaluates the parameter with matching definition and value to a output layer destination. More...

static QString	parameterAsOutputLayer (const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters, QgsProcessingContext &context)
	Evaluates the parameter with matching definition to a output layer destination. More...

static QgsPointXY	parameterAsPoint (const QgsProcessingParameterDefinition *definition, const QVariant &value, QgsProcessingContext &context, const QgsCoordinateReferenceSystem &crs=QgsCoordinateReferenceSystem())
	Evaluates the parameter with matching definition and value to a point. More...

static QgsPointXY	parameterAsPoint (const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters, QgsProcessingContext &context, const QgsCoordinateReferenceSystem &crs=QgsCoordinateReferenceSystem())
	Evaluates the parameter with matching definition to a point. More...

static QgsPointCloudLayer *	parameterAsPointCloudLayer (const QgsProcessingParameterDefinition *definition, const QVariant &value, QgsProcessingContext &context)
	Evaluates the parameter with matching definition and value to a point cloud layer. More...

static QgsPointCloudLayer *	parameterAsPointCloudLayer (const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters, QgsProcessingContext &context)
	Evaluates the parameter with matching definition to a point cloud layer. More...

static QgsCoordinateReferenceSystem	parameterAsPointCrs (const QgsProcessingParameterDefinition *definition, const QVariant &value, QgsProcessingContext &context)
	Returns the coordinate reference system associated with an point parameter value. More...

static QgsCoordinateReferenceSystem	parameterAsPointCrs (const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters, QgsProcessingContext &context)
	Returns the coordinate reference system associated with an point parameter value. More...

static QList< double >	parameterAsRange (const QgsProcessingParameterDefinition *definition, const QVariant &value, QgsProcessingContext &context)
	Evaluates the parameter with matching definition and value to a range of values. More...

static QList< double >	parameterAsRange (const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters, QgsProcessingContext &context)
	Evaluates the parameter with matching definition to a range of values. More...

static QgsRasterLayer *	parameterAsRasterLayer (const QgsProcessingParameterDefinition *definition, const QVariant &value, QgsProcessingContext &context)
	Evaluates the parameter with matching definition and value to a raster layer. More...

static QgsRasterLayer *	parameterAsRasterLayer (const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters, QgsProcessingContext &context)
	Evaluates the parameter with matching definition to a raster layer. More...

static QString	parameterAsSchema (const QgsProcessingParameterDefinition *definition, const QVariant &value, const QgsProcessingContext &context)
	Evaluates the parameter with matching definition and value to a database schema name. More...

static QString	parameterAsSchema (const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters, const QgsProcessingContext &context)
	Evaluates the parameter with matching definition to a database schema name. More...

static QgsFeatureSink *	parameterAsSink (const QgsProcessingParameterDefinition *definition, const QVariant &value, 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()) SIP_THROW(QgsProcessingException)
	Evaluates the parameter with matching definition and value to a feature sink. More...

static QgsFeatureSink *	parameterAsSink (const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters, 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. More...

static QgsProcessingFeatureSource *	parameterAsSource (const QgsProcessingParameterDefinition *definition, const QVariant &value, QgsProcessingContext &context)
	Evaluates the parameter with matching definition and value to a feature source. More...

static QgsProcessingFeatureSource *	parameterAsSource (const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters, QgsProcessingContext &context)
	Evaluates the parameter with matching definition to a feature source. More...

static QString	parameterAsString (const QgsProcessingParameterDefinition *definition, const QVariant &value, const QgsProcessingContext &context)
	Evaluates the parameter with matching definition and value to a static string value. More...

static QString	parameterAsString (const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters, const QgsProcessingContext &context)
	Evaluates the parameter with matching definition to a static string value. More...

static QTime	parameterAsTime (const QgsProcessingParameterDefinition *definition, const QVariant &value, const QgsProcessingContext &context)
	Evaluates the parameter with matching definition and value to a static time value. More...

static QTime	parameterAsTime (const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters, const QgsProcessingContext &context)
	Evaluates the parameter with matching definition to a static time value. More...

static QgsVectorLayer *	parameterAsVectorLayer (const QgsProcessingParameterDefinition *definition, const QVariant &value, QgsProcessingContext &context)
	Evaluates the parameter with matching definition and value to a vector layer. More...

static QgsVectorLayer *	parameterAsVectorLayer (const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters, QgsProcessingContext &context)
	Evaluates the parameter with matching definition to a vector layer. More...

static QgsProcessingParameterDefinition *	parameterFromScriptCode (const QString &code)
	Creates a new QgsProcessingParameterDefinition using the configuration from a supplied script code string. More...

static QgsProcessingParameterDefinition *	parameterFromVariantMap (const QVariantMap &map)
	Creates a new QgsProcessingParameterDefinition using the configuration from a supplied variant map. More...

Detailed Description

A collection of utilities for working with parameters when running a processing algorithm.

Parameters are stored in a QVariantMap and referenced by a unique string key. The QVariants in parameters are not usually accessed directly, and instead the high level API provided through QgsProcessingParameters parameterAsString(), parameterAsDouble() are used instead.

Parameters are evaluated using a provided QgsProcessingContext, allowing the evaluation to understand available map layers and expression contexts (for expression based parameters).

Since: QGIS 3.0

Definition at line 947 of file qgsprocessingparameters.h.

Member Function Documentation

◆ descriptionFromName()

QString QgsProcessingParameters::descriptionFromName ( const QString & name )

static

Creates an autogenerated parameter description from a parameter name.

Definition at line 2272 of file qgsprocessingparameters.cpp.

◆ isDynamic()

bool QgsProcessingParameters::isDynamic	(	const QVariantMap &	parameters,
		const QString &	name
	)

static

Returns true if the parameter with matching name is a dynamic parameter, and must be evaluated once for every input feature processed.

Definition at line 113 of file qgsprocessingparameters.cpp.

◆ parameterAsAnnotationLayer() [1/2]

QgsAnnotationLayer * QgsProcessingParameters::parameterAsAnnotationLayer	(	const QgsProcessingParameterDefinition *	definition,
		const QVariant &	value,
		QgsProcessingContext &	context
	)

static

Evaluates the parameter with matching definition and value to an annotation layer.

Layers will be taken from context's active project. Callers do not need to handle deletion of the returned layer.

Warning: Working with annotation layers is generally not thread safe (unless the layers are from a QgsProject loaded directly in a background thread). Ensure your algorithm returns the QgsProcessingAlgorithm::FlagNoThreading flag or only accesses annotation layers from a prepareAlgorithm() or postProcessAlgorithm() step.

Since: QGIS 3.22

Definition at line 2180 of file qgsprocessingparameters.cpp.

◆ parameterAsAnnotationLayer() [2/2]

QgsAnnotationLayer * QgsProcessingParameters::parameterAsAnnotationLayer	(	const QgsProcessingParameterDefinition *	definition,
		const QVariantMap &	parameters,
		QgsProcessingContext &	context
	)

static

Evaluates the parameter with matching definition to an annotation layer.

Layers will be taken from context's active project. Callers do not need to handle deletion of the returned layer.

Warning: Working with annotation layers is generally not thread safe (unless the layers are from a QgsProject loaded directly in a background thread). Ensure your algorithm returns the QgsProcessingAlgorithm::FlagNoThreading flag or only accesses annotation layers from a prepareAlgorithm() or postProcessAlgorithm() step.

Since: QGIS 3.22

Definition at line 2175 of file qgsprocessingparameters.cpp.

◆ parameterAsBool() [1/2]

bool QgsProcessingParameters::parameterAsBool	(	const QgsProcessingParameterDefinition *	definition,
		const QVariant &	value,
		const QgsProcessingContext &	context
	)

static

Evaluates the parameter with matching definition and value to a static boolean value.

Since: QGIS 3.4

Definition at line 618 of file qgsprocessingparameters.cpp.

◆ parameterAsBool() [2/2]

bool QgsProcessingParameters::parameterAsBool	(	const QgsProcessingParameterDefinition *	definition,
		const QVariantMap &	parameters,
		const QgsProcessingContext &	context
	)

static

Evaluates the parameter with matching definition to a static boolean value.

Definition at line 602 of file qgsprocessingparameters.cpp.

◆ parameterAsBoolean() [1/2]

bool QgsProcessingParameters::parameterAsBoolean	(	const QgsProcessingParameterDefinition *	definition,
		const QVariant &	value,
		const QgsProcessingContext &	context
	)

static

Evaluates the parameter with matching definition and value to a static boolean value.

Since: QGIS 3.8

Definition at line 634 of file qgsprocessingparameters.cpp.

◆ parameterAsBoolean() [2/2]

bool QgsProcessingParameters::parameterAsBoolean	(	const QgsProcessingParameterDefinition *	definition,
		const QVariantMap &	parameters,
		const QgsProcessingContext &	context
	)

static

Evaluates the parameter with matching definition to a static boolean value.

Since: QGIS 3.8

Definition at line 610 of file qgsprocessingparameters.cpp.

◆ parameterAsColor() [1/2]

QColor QgsProcessingParameters::parameterAsColor	(	const QgsProcessingParameterDefinition *	definition,
		const QVariant &	value,
		QgsProcessingContext &	context
	)

static

Returns the color associated with an color parameter value, or an invalid color if the parameter was not set.

Since: QGIS 3.10

Definition at line 2081 of file qgsprocessingparameters.cpp.

◆ parameterAsColor() [2/2]

QColor QgsProcessingParameters::parameterAsColor	(	const QgsProcessingParameterDefinition *	definition,
		const QVariantMap &	parameters,
		QgsProcessingContext &	context
	)

static

Returns the color associated with an point parameter value, or an invalid color if the parameter was not set.

Since: QGIS 3.10

Definition at line 2073 of file qgsprocessingparameters.cpp.

◆ parameterAsCompatibleSourceLayerPath()

QString QgsProcessingParameters::parameterAsCompatibleSourceLayerPath	(	const QgsProcessingParameterDefinition *	definition,
		const QVariantMap &	parameters,
		QgsProcessingContext &	context,
		const QStringList &	compatibleFormats,
		const QString &	preferredFormat = `QString( "shp" )`,
		QgsProcessingFeedback *	feedback = `nullptr`
	)

static

Evaluates the parameter with matching definition to a source vector layer file path of compatible format.

If the parameter is evaluated to an existing layer, and that layer is not of the format listed in the compatibleFormats argument, then the layer will first be exported to a compatible format in a temporary location. The function will then return the path to that temporary file.

compatibleFormats should consist entirely of lowercase file extensions, e.g. 'shp'.

The preferredFormat argument is used to specify to desired file extension to use when a temporary layer export is required. This defaults to shapefiles, because shapefiles are the future (don't believe the geopackage hype!).

When an algorithm is capable of handling multi-layer input files (such as Geopackage), it is preferable to use parameterAsCompatibleSourceLayerPathAndLayerName() which may avoid conversion in more situations.

Definition at line 829 of file qgsprocessingparameters.cpp.

◆ parameterAsCompatibleSourceLayerPathAndLayerName()

QString QgsProcessingParameters::parameterAsCompatibleSourceLayerPathAndLayerName	(	const QgsProcessingParameterDefinition *	definition,
		const QVariantMap &	parameters,
		QgsProcessingContext &	context,
		const QStringList &	compatibleFormats,
		const QString &	preferredFormat = `QString( "shp" )`,
		QgsProcessingFeedback *	feedback = `nullptr`,
		QString *	layerName = `nullptr`
	)

static

Evaluates the parameter with matching definition to a source vector layer file path and layer name of compatible format.

If the parameter is evaluated to an existing layer, and that layer is not of the format listed in the compatibleFormats argument, then the layer will first be exported to a compatible format in a temporary location. The function will then return the path to that temporary file.

compatibleFormats should consist entirely of lowercase file extensions, e.g. 'shp'.

The preferredFormat argument is used to specify to desired file extension to use when a temporary layer export is required. This defaults to shapefiles, because shapefiles are the future (don't believe the geopackage hype!).

This method should be preferred over parameterAsCompatibleSourceLayerPath() when an algorithm is able to correctly handle files with multiple layers. Unlike parameterAsCompatibleSourceLayerPath(), it will not force a conversion in this case and will return the target layer name in the layerName argument.

Parameters

definition	associated parameter definition
parameters	input parameter value map
context	processing context
compatibleFormats	a list of lowercase file extensions compatible with the algorithm
preferredFormat	preferred format extension to use if conversion if required
feedback	feedback object
layerName	will be set to the target layer name for multi-layer sources (e.g. Geopackage)

Returns: path to source layer, or nearly converted compatible layer

See also: parameterAsCompatibleSourceLayerPath()

Since: QGIS 3.10

Definition at line 834 of file qgsprocessingparameters.cpp.

◆ parameterAsConnectionName() [1/2]

QString QgsProcessingParameters::parameterAsConnectionName	(	const QgsProcessingParameterDefinition *	definition,
		const QVariant &	value,
		const QgsProcessingContext &	context
	)

static

Evaluates the parameter with matching definition and value to a connection name string.

Since: QGIS 3.14

Definition at line 2128 of file qgsprocessingparameters.cpp.

◆ parameterAsConnectionName() [2/2]

QString QgsProcessingParameters::parameterAsConnectionName	(	const QgsProcessingParameterDefinition *	definition,
		const QVariantMap &	parameters,
		const QgsProcessingContext &	context
	)

static

Evaluates the parameter with matching definition to a connection name string.

Since: QGIS 3.14

Definition at line 2120 of file qgsprocessingparameters.cpp.

◆ parameterAsCrs() [1/2]

QgsCoordinateReferenceSystem QgsProcessingParameters::parameterAsCrs	(	const QgsProcessingParameterDefinition *	definition,
		const QVariant &	value,
		QgsProcessingContext &	context
	)

static

Evaluates the parameter with matching definition and value to a coordinate reference system.

Since: QGIS 3.4

Definition at line 1053 of file qgsprocessingparameters.cpp.

◆ parameterAsCrs() [2/2]

QgsCoordinateReferenceSystem QgsProcessingParameters::parameterAsCrs	(	const QgsProcessingParameterDefinition *	definition,
		const QVariantMap &	parameters,
		QgsProcessingContext &	context
	)

static

Evaluates the parameter with matching definition to a coordinate reference system.

Definition at line 1045 of file qgsprocessingparameters.cpp.

◆ parameterAsDatabaseTableName() [1/2]

QString QgsProcessingParameters::parameterAsDatabaseTableName	(	const QgsProcessingParameterDefinition *	definition,
		const QVariant &	value,
		const QgsProcessingContext &	context
	)

static

Evaluates the parameter with matching definition and value to a database table name.

Since: QGIS 3.14

Definition at line 2158 of file qgsprocessingparameters.cpp.

◆ parameterAsDatabaseTableName() [2/2]

QString QgsProcessingParameters::parameterAsDatabaseTableName	(	const QgsProcessingParameterDefinition *	definition,
		const QVariantMap &	parameters,
		const QgsProcessingContext &	context
	)

static

Evaluates the parameter with matching definition to a database table name.

Since: QGIS 3.14

Definition at line 2150 of file qgsprocessingparameters.cpp.

◆ parameterAsDate() [1/2]

QDate QgsProcessingParameters::parameterAsDate	(	const QgsProcessingParameterDefinition *	definition,
		const QVariant &	value,
		const QgsProcessingContext &	context
	)

static

Evaluates the parameter with matching definition and value to a static date value.

See also: parameterAsDateTime(); parameterAsTime()

Since: QGIS 3.14

Definition at line 352 of file qgsprocessingparameters.cpp.

◆ parameterAsDate() [2/2]

QDate QgsProcessingParameters::parameterAsDate	(	const QgsProcessingParameterDefinition *	definition,
		const QVariantMap &	parameters,
		const QgsProcessingContext &	context
	)

static

Evaluates the parameter with matching definition to a static date value.

See also: parameterAsDateTime(); parameterAsTime()

Since: QGIS 3.14

Definition at line 344 of file qgsprocessingparameters.cpp.

◆ parameterAsDateTime() [1/2]

QDateTime QgsProcessingParameters::parameterAsDateTime	(	const QgsProcessingParameterDefinition *	definition,
		const QVariant &	value,
		const QgsProcessingContext &	context
	)

static

Evaluates the parameter with matching definition and value to a static datetime value.

See also: parameterAsDate(); parameterAsTime()

Since: QGIS 3.14

Definition at line 315 of file qgsprocessingparameters.cpp.

◆ parameterAsDateTime() [2/2]

QDateTime QgsProcessingParameters::parameterAsDateTime	(	const QgsProcessingParameterDefinition *	definition,
		const QVariantMap &	parameters,
		const QgsProcessingContext &	context
	)

static

Evaluates the parameter with matching definition to a static datetime value.

See also: parameterAsDate(); parameterAsTime()

Since: QGIS 3.14

Definition at line 307 of file qgsprocessingparameters.cpp.

◆ parameterAsDouble() [1/2]

double QgsProcessingParameters::parameterAsDouble	(	const QgsProcessingParameterDefinition *	definition,
		const QVariant &	value,
		const QgsProcessingContext &	context
	)

static

Evaluates the parameter with matching definition and value to a static double value.

Since: QGIS 3.4

Definition at line 190 of file qgsprocessingparameters.cpp.

◆ parameterAsDouble() [2/2]

double QgsProcessingParameters::parameterAsDouble	(	const QgsProcessingParameterDefinition *	definition,
		const QVariantMap &	parameters,
		const QgsProcessingContext &	context
	)

static

Evaluates the parameter with matching definition to a static double value.

Definition at line 182 of file qgsprocessingparameters.cpp.

◆ parameterAsEnum() [1/2]

int QgsProcessingParameters::parameterAsEnum	(	const QgsProcessingParameterDefinition *	definition,
		const QVariant &	value,
		const QgsProcessingContext &	context
	)

static

Evaluates the parameter with matching definition and value to a enum value.

Since: QGIS 3.4

Definition at line 432 of file qgsprocessingparameters.cpp.

◆ parameterAsEnum() [2/2]

int QgsProcessingParameters::parameterAsEnum	(	const QgsProcessingParameterDefinition *	definition,
		const QVariantMap &	parameters,
		const QgsProcessingContext &	context
	)

static

Evaluates the parameter with matching definition to a enum value.

Definition at line 424 of file qgsprocessingparameters.cpp.

◆ parameterAsEnums() [1/2]

QList< int > QgsProcessingParameters::parameterAsEnums	(	const QgsProcessingParameterDefinition *	definition,
		const QVariant &	value,
		const QgsProcessingContext &	context
	)

static

Evaluates the parameter with matching definition and value to list of enum values.

Since: QGIS 3.4

Definition at line 454 of file qgsprocessingparameters.cpp.

◆ parameterAsEnums() [2/2]

QList< int > QgsProcessingParameters::parameterAsEnums	(	const QgsProcessingParameterDefinition *	definition,
		const QVariantMap &	parameters,
		const QgsProcessingContext &	context
	)

static

Evaluates the parameter with matching definition to list of enum values.

Definition at line 446 of file qgsprocessingparameters.cpp.

◆ parameterAsEnumString() [1/2]

QString QgsProcessingParameters::parameterAsEnumString	(	const QgsProcessingParameterDefinition *	definition,
		const QVariant &	value,
		const QgsProcessingContext &	context
	)

static

Evaluates the parameter with matching definition and value to a static enum string.

Since: QGIS 3.18

Definition at line 523 of file qgsprocessingparameters.cpp.

◆ parameterAsEnumString() [2/2]

QString QgsProcessingParameters::parameterAsEnumString	(	const QgsProcessingParameterDefinition *	definition,
		const QVariantMap &	parameters,
		const QgsProcessingContext &	context
	)

static

Evaluates the parameter with matching definition to a static enum string.

Since: QGIS 3.18

Definition at line 515 of file qgsprocessingparameters.cpp.

◆ parameterAsEnumStrings() [1/2]

QStringList QgsProcessingParameters::parameterAsEnumStrings	(	const QgsProcessingParameterDefinition *	definition,
		const QVariant &	value,
		const QgsProcessingContext &	context
	)

static

Evaluates the parameter with matching definition and value to list of static enum strings.

Since: QGIS 3.18

Definition at line 544 of file qgsprocessingparameters.cpp.

◆ parameterAsEnumStrings() [2/2]

QStringList QgsProcessingParameters::parameterAsEnumStrings	(	const QgsProcessingParameterDefinition *	definition,
		const QVariantMap &	parameters,
		const QgsProcessingContext &	context
	)

static

Evaluates the parameter with matching definition to list of static enum strings.

Since: QGIS 3.18

Definition at line 536 of file qgsprocessingparameters.cpp.

◆ parameterAsExpression() [1/2]

QString QgsProcessingParameters::parameterAsExpression	(	const QgsProcessingParameterDefinition *	definition,
		const QVariant &	value,
		const QgsProcessingContext &	context
	)

static

Evaluates the parameter with matching definitionand value to an expression.

Since: QGIS 3.4

Definition at line 162 of file qgsprocessingparameters.cpp.

◆ parameterAsExpression() [2/2]

QString QgsProcessingParameters::parameterAsExpression	(	const QgsProcessingParameterDefinition *	definition,
		const QVariantMap &	parameters,
		const QgsProcessingContext &	context
	)

static

Evaluates the parameter with matching definition to an expression.

Definition at line 154 of file qgsprocessingparameters.cpp.

◆ parameterAsExtent() [1/2]

QgsRectangle QgsProcessingParameters::parameterAsExtent	(	const QgsProcessingParameterDefinition *	definition,
		const QVariant &	value,
		QgsProcessingContext &	context,
		const QgsCoordinateReferenceSystem &	crs = `QgsCoordinateReferenceSystem()`
	)

static

Evaluates the parameter with matching definition and value to a rectangular extent.

If crs is set, and the original coordinate reference system of the parameter can be determined, then the extent will be automatically reprojected so that it is in the specified crs. In this case the extent of the reproject rectangle will be returned.

See also: parameterAsExtentGeometry(); parameterAsExtentCrs()

Since: QGIS 3.4

Definition at line 1070 of file qgsprocessingparameters.cpp.

◆ parameterAsExtent() [2/2]

QgsRectangle QgsProcessingParameters::parameterAsExtent	(	const QgsProcessingParameterDefinition *	definition,
		const QVariantMap &	parameters,
		QgsProcessingContext &	context,
		const QgsCoordinateReferenceSystem &	crs = `QgsCoordinateReferenceSystem()`
	)

static

Evaluates the parameter with matching definition to a rectangular extent.

If crs is set, and the original coordinate reference system of the parameter can be determined, then the extent will be automatically reprojected so that it is in the specified crs. In this case the extent of the reproject rectangle will be returned.

See also: parameterAsExtentGeometry(); parameterAsExtentCrs()

Definition at line 1061 of file qgsprocessingparameters.cpp.

◆ parameterAsExtentCrs() [1/2]

QgsCoordinateReferenceSystem QgsProcessingParameters::parameterAsExtentCrs	(	const QgsProcessingParameterDefinition *	definition,
		const QVariant &	value,
		QgsProcessingContext &	context
	)

static

Returns the coordinate reference system associated with an extent parameter value.

See also: parameterAsExtent()

Definition at line 1318 of file qgsprocessingparameters.cpp.

◆ parameterAsExtentCrs() [2/2]

QgsCoordinateReferenceSystem QgsProcessingParameters::parameterAsExtentCrs	(	const QgsProcessingParameterDefinition *	definition,
		const QVariantMap &	parameters,
		QgsProcessingContext &	context
	)

static

Returns the coordinate reference system associated with an extent parameter value.

See also: parameterAsExtent()

Definition at line 1312 of file qgsprocessingparameters.cpp.

◆ parameterAsExtentGeometry()

QgsGeometry QgsProcessingParameters::parameterAsExtentGeometry	(	const QgsProcessingParameterDefinition *	definition,
		const QVariantMap &	parameters,
		QgsProcessingContext &	context,
		const QgsCoordinateReferenceSystem &	crs = `QgsCoordinateReferenceSystem()`
	)

static

Evaluates the parameter with matching definition to a rectangular extent, and returns a geometry covering this extent.

If crs is set, and the original coordinate reference system of the parameter can be determined, then the extent will be automatically reprojected so that it is in the specified crs. Unlike parameterAsExtent(), the reprojected rectangle returned by this function will no longer be a rectangle itself (i.e. this method returns the geometry of the actual reprojected rectangle, while parameterAsExtent() returns just the extent of the reprojected rectangle).

See also: parameterAsExtent(); parameterAsExtentCrs()

Definition at line 1194 of file qgsprocessingparameters.cpp.

◆ parameterAsFields() [1/2]

QStringList QgsProcessingParameters::parameterAsFields	(	const QgsProcessingParameterDefinition *	definition,
		const QVariant &	value,
		QgsProcessingContext &	context
	)

static

Evaluates the parameter with matching definition and value to a list of fields.

Since: QGIS 3.4

Definition at line 1974 of file qgsprocessingparameters.cpp.

◆ parameterAsFields() [2/2]

QStringList QgsProcessingParameters::parameterAsFields	(	const QgsProcessingParameterDefinition *	definition,
		const QVariantMap &	parameters,
		QgsProcessingContext &	context
	)

static

Evaluates the parameter with matching definition to a list of fields.

Definition at line 1966 of file qgsprocessingparameters.cpp.

◆ parameterAsFile() [1/2]

QString QgsProcessingParameters::parameterAsFile	(	const QgsProcessingParameterDefinition *	definition,
		const QVariant &	value,
		QgsProcessingContext &	context
	)

static

Evaluates the parameter with matching definition and value to a file/folder name.

Since: QGIS 3.4

Definition at line 1696 of file qgsprocessingparameters.cpp.

◆ parameterAsFile() [2/2]

QString QgsProcessingParameters::parameterAsFile	(	const QgsProcessingParameterDefinition *	definition,
		const QVariantMap &	parameters,
		QgsProcessingContext &	context
	)

static

Evaluates the parameter with matching definition to a file/folder name.

Definition at line 1685 of file qgsprocessingparameters.cpp.

◆ parameterAsFileList() [1/2]

QStringList QgsProcessingParameters::parameterAsFileList	(	const QgsProcessingParameterDefinition *	definition,
		const QVariant &	value,
		QgsProcessingContext &	context
	)

static

Evaluates the parameter with matching definition to a list of files (for QgsProcessingParameterMultipleLayers in QgsProcessing:TypeFile mode).

Since: QGIS 3.10

Definition at line 1846 of file qgsprocessingparameters.cpp.

◆ parameterAsFileList() [2/2]

QStringList QgsProcessingParameters::parameterAsFileList	(	const QgsProcessingParameterDefinition *	definition,
		const QVariantMap &	parameters,
		QgsProcessingContext &	context
	)

static

Evaluates the parameter with matching definition to a list of files (for QgsProcessingParameterMultipleLayers in QgsProcessing:TypeFile mode).

Since: QGIS 3.10

Definition at line 1892 of file qgsprocessingparameters.cpp.

◆ parameterAsFileOutput() [1/2]

QString QgsProcessingParameters::parameterAsFileOutput	(	const QgsProcessingParameterDefinition *	definition,
		const QVariant &	value,
		QgsProcessingContext &	context
	)

static

Evaluates the parameter with matching definition and value to a file based output destination.

Since: QGIS 3.4

Definition at line 1002 of file qgsprocessingparameters.cpp.

◆ parameterAsFileOutput() [2/2]

QString QgsProcessingParameters::parameterAsFileOutput	(	const QgsProcessingParameterDefinition *	definition,
		const QVariantMap &	parameters,
		QgsProcessingContext &	context
	)

static

Evaluates the parameter with matching definition to a file based output destination.

Definition at line 992 of file qgsprocessingparameters.cpp.

◆ parameterAsGeometry() [1/2]

QgsGeometry QgsProcessingParameters::parameterAsGeometry	(	const QgsProcessingParameterDefinition *	definition,
		const QVariant &	value,
		QgsProcessingContext &	context,
		const QgsCoordinateReferenceSystem &	crs = `QgsCoordinateReferenceSystem()`
	)

static

Evaluates the parameter with matching definition and value to a geometry.

Since: QGIS 3.16

Definition at line 1520 of file qgsprocessingparameters.cpp.

◆ parameterAsGeometry() [2/2]

QgsGeometry QgsProcessingParameters::parameterAsGeometry	(	const QgsProcessingParameterDefinition *	definition,
		const QVariantMap &	parameters,
		QgsProcessingContext &	context,
		const QgsCoordinateReferenceSystem &	crs = `QgsCoordinateReferenceSystem()`
	)

static

Evaluates the parameter with matching definition to a geometry.

Since: QGIS 3.16

Definition at line 1512 of file qgsprocessingparameters.cpp.

◆ parameterAsGeometryCrs() [1/2]

QgsCoordinateReferenceSystem QgsProcessingParameters::parameterAsGeometryCrs	(	const QgsProcessingParameterDefinition *	definition,
		const QVariant &	value,
		QgsProcessingContext &	context
	)

static

Returns the coordinate reference system associated with an point parameter value.

See also: parameterAsGeometry()

Since: QGIS 3.16

Definition at line 1638 of file qgsprocessingparameters.cpp.

◆ parameterAsGeometryCrs() [2/2]

QgsCoordinateReferenceSystem QgsProcessingParameters::parameterAsGeometryCrs	(	const QgsProcessingParameterDefinition *	definition,
		const QVariantMap &	parameters,
		QgsProcessingContext &	context
	)

static

Returns the coordinate reference system associated with a geometry parameter value.

See also: parameterAsGeometry()

Since: QGIS 3.16

Definition at line 1632 of file qgsprocessingparameters.cpp.

◆ parameterAsInt() [1/2]

int QgsProcessingParameters::parameterAsInt	(	const QgsProcessingParameterDefinition *	definition,
		const QVariant &	value,
		const QgsProcessingContext &	context
	)

static

Evaluates the parameter with matching definition and value to a static integer value.

Since: QGIS 3.4

Definition at line 217 of file qgsprocessingparameters.cpp.

◆ parameterAsInt() [2/2]

int QgsProcessingParameters::parameterAsInt	(	const QgsProcessingParameterDefinition *	definition,
		const QVariantMap &	parameters,
		const QgsProcessingContext &	context
	)

static

Evaluates the parameter with matching definition to a static integer value.

Definition at line 209 of file qgsprocessingparameters.cpp.

◆ parameterAsInts() [1/2]

QList< int > QgsProcessingParameters::parameterAsInts	(	const QgsProcessingParameterDefinition *	definition,
		const QVariant &	value,
		const QgsProcessingContext &	context
	)

static

Evaluates the parameter with matching definition and value to a list of integer values.

Since: QGIS 3.4

Definition at line 259 of file qgsprocessingparameters.cpp.

◆ parameterAsInts() [2/2]

QList< int > QgsProcessingParameters::parameterAsInts	(	const QgsProcessingParameterDefinition *	definition,
		const QVariantMap &	parameters,
		const QgsProcessingContext &	context
	)

static

Evaluates the parameter with matching definition to a list of integer values.

Since: QGIS 3.4

Definition at line 251 of file qgsprocessingparameters.cpp.

◆ parameterAsLayer() [1/2]

QgsMapLayer * QgsProcessingParameters::parameterAsLayer	(	const QgsProcessingParameterDefinition *	definition,
		const QVariant &	value,
		QgsProcessingContext &	context,
		QgsProcessingUtils::LayerHint	layerHint = `QgsProcessingUtils::LayerHint::UnknownType`
	)

static

Evaluates the parameter with matching definition and value to a map layer.

Layers will either be taken from context's active project, or loaded from external sources and stored temporarily in the context. In either case, callers do not need to handle deletion of the returned layer.

Since: QGIS 3.4

Definition at line 854 of file qgsprocessingparameters.cpp.

◆ parameterAsLayer() [2/2]

QgsMapLayer * QgsProcessingParameters::parameterAsLayer	(	const QgsProcessingParameterDefinition *	definition,
		const QVariantMap &	parameters,
		QgsProcessingContext &	context,
		QgsProcessingUtils::LayerHint	layerHint = `QgsProcessingUtils::LayerHint::UnknownType`
	)

static

Evaluates the parameter with matching definition to a map layer.

Layers will either be taken from context's active project, or loaded from external sources and stored temporarily in the context. In either case, callers do not need to handle deletion of the returned layer.

Definition at line 846 of file qgsprocessingparameters.cpp.

◆ parameterAsLayerList() [1/2]

QList< QgsMapLayer * > QgsProcessingParameters::parameterAsLayerList	(	const QgsProcessingParameterDefinition *	definition,
		const QVariant &	value,
		QgsProcessingContext &	context
	)

static

Evaluates the parameter with matching definition and value to a list of map layers.

Since: QGIS 3.4

Definition at line 1759 of file qgsprocessingparameters.cpp.

◆ parameterAsLayerList() [2/2]

QList< QgsMapLayer * > QgsProcessingParameters::parameterAsLayerList	(	const QgsProcessingParameterDefinition *	definition,
		const QVariantMap &	parameters,
		QgsProcessingContext &	context
	)

static

Evaluates the parameter with matching definition to a list of map layers.

Definition at line 1751 of file qgsprocessingparameters.cpp.

◆ parameterAsLayout() [1/2]

QgsPrintLayout * QgsProcessingParameters::parameterAsLayout	(	const QgsProcessingParameterDefinition *	definition,
		const QVariant &	value,
		QgsProcessingContext &	context
	)

static

Evaluates the parameter with matching definition and value to a print layout.

Warning: This method is not safe to run in a background thread, so it must either be used within a prepareAlgorithm implementation (which runs in the main thread), or the algorithm must return the FlagNoThreading flag.

Since: QGIS 3.8

Definition at line 2031 of file qgsprocessingparameters.cpp.

◆ parameterAsLayout() [2/2]

QgsPrintLayout * QgsProcessingParameters::parameterAsLayout	(	const QgsProcessingParameterDefinition *	definition,
		const QVariantMap &	parameters,
		QgsProcessingContext &	context
	)

static

Evaluates the parameter with matching definition to a print layout.

Warning: This method is not safe to run in a background thread, so it must either be used within a prepareAlgorithm implementation (which runs in the main thread), or the algorithm must return the FlagNoThreading flag.

Since: QGIS 3.8

Definition at line 2023 of file qgsprocessingparameters.cpp.

◆ parameterAsLayoutItem() [1/2]

QgsLayoutItem * QgsProcessingParameters::parameterAsLayoutItem	(	const QgsProcessingParameterDefinition *	definition,
		const QVariant &	value,
		QgsProcessingContext &	context,
		QgsPrintLayout *	layout
	)

static

Evaluates the parameter with matching definition and value to a print layout, taken from the specified layout.

Warning: This method is not safe to run in a background thread, so it must either be used within a prepareAlgorithm implementation (which runs in the main thread), or the algorithm must return the FlagNoThreading flag.

Since: QGIS 3.8

Definition at line 2055 of file qgsprocessingparameters.cpp.

◆ parameterAsLayoutItem() [2/2]

QgsLayoutItem * QgsProcessingParameters::parameterAsLayoutItem	(	const QgsProcessingParameterDefinition *	definition,
		const QVariantMap &	parameters,
		QgsProcessingContext &	context,
		QgsPrintLayout *	layout
	)

static

Evaluates the parameter with matching definition to a print layout item, taken from the specified layout.

Warning: This method is not safe to run in a background thread, so it must either be used within a prepareAlgorithm implementation (which runs in the main thread), or the algorithm must return the FlagNoThreading flag.

Since: QGIS 3.8

Definition at line 2047 of file qgsprocessingparameters.cpp.

◆ parameterAsMatrix() [1/2]

QVariantList QgsProcessingParameters::parameterAsMatrix	(	const QgsProcessingParameterDefinition *	definition,
		const QVariant &	value,
		QgsProcessingContext &	context
	)

static

Evaluates the parameter with matching definition and value to a matrix/table of values.

Tables are collapsed to a 1 dimensional list.

Since: QGIS 3.4

Definition at line 1715 of file qgsprocessingparameters.cpp.

◆ parameterAsMatrix() [2/2]

QVariantList QgsProcessingParameters::parameterAsMatrix	(	const QgsProcessingParameterDefinition *	definition,
		const QVariantMap &	parameters,
		QgsProcessingContext &	context
	)

static

Evaluates the parameter with matching definition to a matrix/table of values.

Tables are collapsed to a 1 dimensional list.

Definition at line 1707 of file qgsprocessingparameters.cpp.

◆ parameterAsMeshLayer() [1/2]

QgsMeshLayer * QgsProcessingParameters::parameterAsMeshLayer	(	const QgsProcessingParameterDefinition *	definition,
		const QVariant &	value,
		QgsProcessingContext &	context
	)

static

Evaluates the parameter with matching definition and value to a mesh layer.

Layers will either be taken from context's active project, or loaded from external sources and stored temporarily in the context. In either case, callers do not need to handle deletion of the returned layer.

Since: QGIS 3.6

Definition at line 918 of file qgsprocessingparameters.cpp.

◆ parameterAsMeshLayer() [2/2]

QgsMeshLayer * QgsProcessingParameters::parameterAsMeshLayer	(	const QgsProcessingParameterDefinition *	definition,
		const QVariantMap &	parameters,
		QgsProcessingContext &	context
	)

static

Evaluates the parameter with matching definition and value to a mesh layer.

Layers will either be taken from context's active project, or loaded from external sources and stored temporarily in the context. In either case, callers do not need to handle deletion of the returned layer.

Since: QGIS 3.6

Definition at line 913 of file qgsprocessingparameters.cpp.

◆ parameterAsOutputLayer() [1/2]

QString QgsProcessingParameters::parameterAsOutputLayer	(	const QgsProcessingParameterDefinition *	definition,
		const QVariant &	value,
		QgsProcessingContext &	context
	)

static

Evaluates the parameter with matching definition and value to a output layer destination.

Since: QGIS 3.4

Definition at line 933 of file qgsprocessingparameters.cpp.

◆ parameterAsOutputLayer() [2/2]

QString QgsProcessingParameters::parameterAsOutputLayer	(	const QgsProcessingParameterDefinition *	definition,
		const QVariantMap &	parameters,
		QgsProcessingContext &	context
	)

static

Evaluates the parameter with matching definition to a output layer destination.

Definition at line 923 of file qgsprocessingparameters.cpp.

◆ parameterAsPoint() [1/2]

QgsPointXY QgsProcessingParameters::parameterAsPoint	(	const QgsProcessingParameterDefinition *	definition,
		const QVariant &	value,
		QgsProcessingContext &	context,
		const QgsCoordinateReferenceSystem &	crs = `QgsCoordinateReferenceSystem()`
	)

static

Evaluates the parameter with matching definition and value to a point.

If crs is set then the point will be automatically reprojected so that it is in the specified crs.

See also: parameterAsPointCrs()

Since: QGIS 3.4

Definition at line 1402 of file qgsprocessingparameters.cpp.

◆ parameterAsPoint() [2/2]

QgsPointXY QgsProcessingParameters::parameterAsPoint	(	const QgsProcessingParameterDefinition *	definition,
		const QVariantMap &	parameters,
		QgsProcessingContext &	context,
		const QgsCoordinateReferenceSystem &	crs = `QgsCoordinateReferenceSystem()`
	)

static

Evaluates the parameter with matching definition to a point.

If crs is set then the point will be automatically reprojected so that it is in the specified crs.

See also: parameterAsPointCrs()

Definition at line 1394 of file qgsprocessingparameters.cpp.

◆ parameterAsPointCloudLayer() [1/2]

QgsPointCloudLayer * QgsProcessingParameters::parameterAsPointCloudLayer	(	const QgsProcessingParameterDefinition *	definition,
		const QVariant &	value,
		QgsProcessingContext &	context
	)

static

Evaluates the parameter with matching definition and value to a point cloud layer.

Layers will either be taken from context's active project, or loaded from external sources and stored temporarily in the context. In either case, callers do not need to handle deletion of the returned layer.

Since: QGIS 3.22

Definition at line 2170 of file qgsprocessingparameters.cpp.

◆ parameterAsPointCloudLayer() [2/2]

QgsPointCloudLayer * QgsProcessingParameters::parameterAsPointCloudLayer	(	const QgsProcessingParameterDefinition *	definition,
		const QVariantMap &	parameters,
		QgsProcessingContext &	context
	)

static

Evaluates the parameter with matching definition to a point cloud layer.

Layers will either be taken from context's active project, or loaded from external sources and stored temporarily in the context. In either case, callers do not need to handle deletion of the returned layer.

Since: QGIS 3.22

Definition at line 2165 of file qgsprocessingparameters.cpp.

◆ parameterAsPointCrs() [1/2]

QgsCoordinateReferenceSystem QgsProcessingParameters::parameterAsPointCrs	(	const QgsProcessingParameterDefinition *	definition,
		const QVariant &	value,
		QgsProcessingContext &	context
	)

static

Returns the coordinate reference system associated with an point parameter value.

See also: parameterAsPoint()

Since: QGIS 3.8

Definition at line 1484 of file qgsprocessingparameters.cpp.

◆ parameterAsPointCrs() [2/2]

QgsCoordinateReferenceSystem QgsProcessingParameters::parameterAsPointCrs	(	const QgsProcessingParameterDefinition *	definition,
		const QVariantMap &	parameters,
		QgsProcessingContext &	context
	)

static

Returns the coordinate reference system associated with an point parameter value.

See also: parameterAsPoint()

Definition at line 1478 of file qgsprocessingparameters.cpp.

◆ parameterAsRange() [1/2]

QList< double > QgsProcessingParameters::parameterAsRange	(	const QgsProcessingParameterDefinition *	definition,
		const QVariant &	value,
		QgsProcessingContext &	context
	)

static

Evaluates the parameter with matching definition and value to a range of values.

Since: QGIS 3.4

Definition at line 1908 of file qgsprocessingparameters.cpp.

◆ parameterAsRange() [2/2]

QList< double > QgsProcessingParameters::parameterAsRange	(	const QgsProcessingParameterDefinition *	definition,
		const QVariantMap &	parameters,
		QgsProcessingContext &	context
	)

static

Evaluates the parameter with matching definition to a range of values.

Definition at line 1900 of file qgsprocessingparameters.cpp.

◆ parameterAsRasterLayer() [1/2]

QgsRasterLayer * QgsProcessingParameters::parameterAsRasterLayer	(	const QgsProcessingParameterDefinition *	definition,
		const QVariant &	value,
		QgsProcessingContext &	context
	)

static

Evaluates the parameter with matching definition and value to a raster layer.

Layers will either be taken from context's active project, or loaded from external sources and stored temporarily in the context. In either case, callers do not need to handle deletion of the returned layer.

Since: QGIS 3.4

Definition at line 908 of file qgsprocessingparameters.cpp.

◆ parameterAsRasterLayer() [2/2]

QgsRasterLayer * QgsProcessingParameters::parameterAsRasterLayer	(	const QgsProcessingParameterDefinition *	definition,
		const QVariantMap &	parameters,
		QgsProcessingContext &	context
	)

static

Evaluates the parameter with matching definition to a raster layer.

Layers will either be taken from context's active project, or loaded from external sources and stored temporarily in the context. In either case, callers do not need to handle deletion of the returned layer.

Definition at line 903 of file qgsprocessingparameters.cpp.

◆ parameterAsSchema() [1/2]

QString QgsProcessingParameters::parameterAsSchema	(	const QgsProcessingParameterDefinition *	definition,
		const QVariant &	value,
		const QgsProcessingContext &	context
	)

static

Evaluates the parameter with matching definition and value to a database schema name.

Since: QGIS 3.14

Definition at line 2143 of file qgsprocessingparameters.cpp.

◆ parameterAsSchema() [2/2]

QString QgsProcessingParameters::parameterAsSchema	(	const QgsProcessingParameterDefinition *	definition,
		const QVariantMap &	parameters,
		const QgsProcessingContext &	context
	)

static

Evaluates the parameter with matching definition to a database schema name.

Since: QGIS 3.14

Definition at line 2135 of file qgsprocessingparameters.cpp.

◆ parameterAsSink() [1/2]

QgsFeatureSink * QgsProcessingParameters::parameterAsSink	(	const QgsProcessingParameterDefinition *	definition,
		const QVariant &	value,
		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()`
	)

static

Evaluates the parameter with matching definition and value to a feature sink.

The fields, geometryType and crs parameters dictate the properties of the resulting feature sink.

Sinks will either be taken from context's active project, or created from external providers and stored temporarily in the context. The destinationIdentifier argument will be set to a string which can be used to retrieve the layer corresponding to the sink, e.g. via calling QgsProcessingUtils::mapLayerFromString().

The createOptions argument is used to pass on creation options such as layer name.

The datasourceOptions and layerOptions arguments is used to pass on GDAL-specific format driver options.

This function creates a new object and the caller takes responsibility for deleting the returned object.

Exceptions

QgsProcessingException

Since: QGIS 3.4

Definition at line 664 of file qgsprocessingparameters.cpp.

◆ parameterAsSink() [2/2]

QgsFeatureSink * QgsProcessingParameters::parameterAsSink	(	const QgsProcessingParameterDefinition *	definition,
		const QVariantMap &	parameters,
		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()`
	)

static

Evaluates the parameter with matching definition to a feature sink.

The fields, geometryType and crs parameters dictate the properties of the resulting feature sink.

Sinks will either be taken from context's active project, or created from external providers and stored temporarily in the context. The destinationIdentifier argument will be set to a string which can be used to retrieve the layer corresponding to the sink, e.g. via calling QgsProcessingUtils::mapLayerFromString().

The createOptions argument is used to pass on creation options such as layer name.

The datasourceOptions and layerOptions arguments is used to pass on GDAL-specific format driver options.

This function creates a new object and the caller takes responsibility for deleting the returned object.

Definition at line 650 of file qgsprocessingparameters.cpp.

◆ parameterAsSource() [1/2]

QgsProcessingFeatureSource * QgsProcessingParameters::parameterAsSource	(	const QgsProcessingParameterDefinition *	definition,
		const QVariant &	value,
		QgsProcessingContext &	context
	)

static

Evaluates the parameter with matching definition and value to a feature source.

Sources will either be taken from context's active project, or loaded from external sources and stored temporarily in the context.

This function creates a new object and the caller takes responsibility for deleting the returned object.

Since: QGIS 3.4

Definition at line 747 of file qgsprocessingparameters.cpp.

◆ parameterAsSource() [2/2]

QgsProcessingFeatureSource * QgsProcessingParameters::parameterAsSource	(	const QgsProcessingParameterDefinition *	definition,
		const QVariantMap &	parameters,
		QgsProcessingContext &	context
	)

static

Evaluates the parameter with matching definition to a feature source.

Sources will either be taken from context's active project, or loaded from external sources and stored temporarily in the context.

This function creates a new object and the caller takes responsibility for deleting the returned object.

Definition at line 739 of file qgsprocessingparameters.cpp.

◆ parameterAsString() [1/2]

QString QgsProcessingParameters::parameterAsString	(	const QgsProcessingParameterDefinition *	definition,
		const QVariant &	value,
		const QgsProcessingContext &	context
	)

static

Evaluates the parameter with matching definition and value to a static string value.

Since: QGIS 3.4

Definition at line 130 of file qgsprocessingparameters.cpp.

◆ parameterAsString() [2/2]

QString QgsProcessingParameters::parameterAsString	(	const QgsProcessingParameterDefinition *	definition,
		const QVariantMap &	parameters,
		const QgsProcessingContext &	context
	)

static

Evaluates the parameter with matching definition to a static string value.

Definition at line 122 of file qgsprocessingparameters.cpp.

◆ parameterAsTime() [1/2]

QTime QgsProcessingParameters::parameterAsTime	(	const QgsProcessingParameterDefinition *	definition,
		const QVariant &	value,
		const QgsProcessingContext &	context
	)

static

Evaluates the parameter with matching definition and value to a static time value.

See also: parameterAsDateTime(); parameterAsDate()

Since: QGIS 3.14

Definition at line 389 of file qgsprocessingparameters.cpp.

◆ parameterAsTime() [2/2]

QTime QgsProcessingParameters::parameterAsTime	(	const QgsProcessingParameterDefinition *	definition,
		const QVariantMap &	parameters,
		const QgsProcessingContext &	context
	)

static

Evaluates the parameter with matching definition to a static time value.

See also: parameterAsDateTime(); parameterAsDate()

Since: QGIS 3.14

Definition at line 381 of file qgsprocessingparameters.cpp.

◆ parameterAsVectorLayer() [1/2]

QgsVectorLayer * QgsProcessingParameters::parameterAsVectorLayer	(	const QgsProcessingParameterDefinition *	definition,
		const QVariant &	value,
		QgsProcessingContext &	context
	)

static

Evaluates the parameter with matching definition and value to a vector layer.

Layers will either be taken from context's active project, or loaded from external sources and stored temporarily in the context. In either case, callers do not need to handle deletion of the returned layer.

Since: QGIS 3.4

Definition at line 1040 of file qgsprocessingparameters.cpp.

◆ parameterAsVectorLayer() [2/2]

QgsVectorLayer * QgsProcessingParameters::parameterAsVectorLayer	(	const QgsProcessingParameterDefinition *	definition,
		const QVariantMap &	parameters,
		QgsProcessingContext &	context
	)

static

Evaluates the parameter with matching definition to a vector layer.

Layers will either be taken from context's active project, or loaded from external sources and stored temporarily in the context. In either case, callers do not need to handle deletion of the returned layer.

Definition at line 1035 of file qgsprocessingparameters.cpp.

◆ parameterFromScriptCode()

QgsProcessingParameterDefinition * QgsProcessingParameters::parameterFromScriptCode ( const QString & code )

static

Creates a new QgsProcessingParameterDefinition using the configuration from a supplied script code string.

The caller takes responsibility for deleting the returned object.

Definition at line 2279 of file qgsprocessingparameters.cpp.

◆ parameterFromVariantMap()

QgsProcessingParameterDefinition * QgsProcessingParameters::parameterFromVariantMap ( const QVariantMap & map )

static

Creates a new QgsProcessingParameterDefinition using the configuration from a supplied variant map.

The caller takes responsibility for deleting the returned object.

Definition at line 2185 of file qgsprocessingparameters.cpp.

The documentation for this class was generated from the following files:

/build/qgis-3.30.0+99sid/src/core/processing/qgsprocessingparameters.h
/build/qgis-3.30.0+99sid/src/core/processing/qgsprocessingparameters.cpp

Static Public Member Functions

Detailed Description

Member Function Documentation

◆ descriptionFromName()

◆ isDynamic()

◆ parameterAsAnnotationLayer() [1/2]

◆ parameterAsAnnotationLayer() [2/2]

◆ parameterAsBool() [1/2]

◆ parameterAsBool() [2/2]

◆ parameterAsBoolean() [1/2]

◆ parameterAsBoolean() [2/2]

◆ parameterAsColor() [1/2]

◆ parameterAsColor() [2/2]

◆ parameterAsCompatibleSourceLayerPath()

◆ parameterAsCompatibleSourceLayerPathAndLayerName()

◆ parameterAsConnectionName() [1/2]

◆ parameterAsConnectionName() [2/2]

◆ parameterAsCrs() [1/2]

◆ parameterAsCrs() [2/2]

◆ parameterAsDatabaseTableName() [1/2]

◆ parameterAsDatabaseTableName() [2/2]

◆ parameterAsDate() [1/2]

◆ parameterAsDate() [2/2]

◆ parameterAsDateTime() [1/2]

◆ parameterAsDateTime() [2/2]

◆ parameterAsDouble() [1/2]

◆ parameterAsDouble() [2/2]

◆ parameterAsEnum() [1/2]

◆ parameterAsEnum() [2/2]

◆ parameterAsEnums() [1/2]

◆ parameterAsEnums() [2/2]

◆ parameterAsEnumString() [1/2]

◆ parameterAsEnumString() [2/2]

◆ parameterAsEnumStrings() [1/2]

◆ parameterAsEnumStrings() [2/2]

◆ parameterAsExpression() [1/2]

◆ parameterAsExpression() [2/2]

◆ parameterAsExtent() [1/2]

◆ parameterAsExtent() [2/2]

◆ parameterAsExtentCrs() [1/2]

◆ parameterAsExtentCrs() [2/2]

◆ parameterAsExtentGeometry()

◆ parameterAsFields() [1/2]

◆ parameterAsFields() [2/2]

◆ parameterAsFile() [1/2]

◆ parameterAsFile() [2/2]

◆ parameterAsFileList() [1/2]

◆ parameterAsFileList() [2/2]

◆ parameterAsFileOutput() [1/2]

◆ parameterAsFileOutput() [2/2]

◆ parameterAsGeometry() [1/2]

◆ parameterAsGeometry() [2/2]

◆ parameterAsGeometryCrs() [1/2]

◆ parameterAsGeometryCrs() [2/2]

◆ parameterAsInt() [1/2]

◆ parameterAsInt() [2/2]

◆ parameterAsInts() [1/2]

◆ parameterAsInts() [2/2]

◆ parameterAsLayer() [1/2]

◆ parameterAsLayer() [2/2]

◆ parameterAsLayerList() [1/2]

◆ parameterAsLayerList() [2/2]

◆ parameterAsLayout() [1/2]

◆ parameterAsLayout() [2/2]

◆ parameterAsLayoutItem() [1/2]

◆ parameterAsLayoutItem() [2/2]

◆ parameterAsMatrix() [1/2]

◆ parameterAsMatrix() [2/2]

◆ parameterAsMeshLayer() [1/2]

◆ parameterAsMeshLayer() [2/2]

◆ parameterAsOutputLayer() [1/2]

◆ parameterAsOutputLayer() [2/2]

◆ parameterAsPoint() [1/2]

◆ parameterAsPoint() [2/2]

◆ parameterAsPointCloudLayer() [1/2]

◆ parameterAsPointCloudLayer() [2/2]

◆ parameterAsPointCrs() [1/2]

◆ parameterAsPointCrs() [2/2]

◆ parameterAsRange() [1/2]

◆ parameterAsRange() [2/2]