Class: QgsProcessingParameterMeshDatasetGroups¶

A parameter for processing algorithms that need a list of mesh dataset groups.

A valid value for this parameter is a list (QVariantList) of dataset groups index in the mesh layer scope Dataset group index can be evaluated with the method valueAsDatasetGroup()

Note

This parameter is dependent on a mesh layer parameter (see QgsProcessingParameterMeshLayer)

Added in version 3.18.

Class Hierarchy¶

Base classes¶

QgsProcessingParameterDefinition

Base class for the definition of processing parameters.

Methods

`isDataTypeSupported`	Returns whether the data type is supported by the parameter
`meshLayerParameterName`	Returns the name of the mesh layer parameter

Static Methods

`typeName`	Returns the type name for the parameter class.
`valueAsDatasetGroup`	Returns the value as a list if dataset group indexes

class qgis.core.QgsProcessingParameterMeshDatasetGroups[source]¶

Bases: QgsProcessingParameterDefinition

__init__(name: str | None, description: str | None = '', meshLayerParameterName: str | None = '', supportedDataType: Any = unknown - type(), optional: bool = False)

Constructor

Parameters:

name (Optional[str]) – name of the parameter
description (Optional[str] = '') – description of the parameter
meshLayerParameterName (Optional[str] = '') – name of the associated mesh layer parameter
supportedDataType (Any = unknown-type()) – a set of QgsMeshDatasetGroupMetadata.DataType values for data types supported by the parameter
optional (bool = False) – whether the parameter is optional

__init__(a0: QgsProcessingParameterMeshDatasetGroups)

Parameters:: a0 (QgsProcessingParameterMeshDatasetGroups)

isDataTypeSupported(self, dataType: QgsMeshDatasetGroupMetadata.DataType) → bool[source]¶

Returns whether the data type is supported by the parameter

Parameters:: dataType (QgsMeshDatasetGroupMetadata.DataType)
Return type:: bool

meshLayerParameterName(self) → str[source]¶

Returns the name of the mesh layer parameter

Return type:: str

static typeName() → str[source]¶

Returns the type name for the parameter class.

Return type:: str

static valueAsDatasetGroup(value: Any) → List[int]¶

Returns the value as a list if dataset group indexes

Parameters:: value (Any)
Return type:: List[int]