Class: QgsProcessingParameterMeshDatasetGroups

class qgis.core.QgsProcessingParameterMeshDatasetGroups

Bases: QgsProcessingParameterDefinition

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)

New in version 3.18.

QgsProcessingParameterMeshDatasetGroups(name: str, description: str = ‘’, meshLayerParameterName: str = ‘’, supportedDataType: object = QSet<int>(), optional: bool = False) Constructor

Parameters:

  • name – name of the parameter

  • description – description of the parameter

  • meshLayerParameterName – name of the associated mesh layer parameter

  • supportedDataType – a set of QgsMeshDatasetGroupMetadata.DataType values for data types supported by the parameter

  • optional – whether the parameter is optional

QgsProcessingParameterMeshDatasetGroups(QgsProcessingParameterMeshDatasetGroups)

Methods

asPythonString

param outputType:

checkValueIsAcceptable

param input:

clone

rtype:

QgsProcessingParameterDefinition

defaultGuiValueFromSetting

Default gui value for an algorithm parameter from settings

dependsOnOtherParameters

rtype:

List[str]

fromVariantMap

param map:

isDataTypeSupported

Returns whether the data type is supported by the parameter

meshLayerParameterName

Returns the name of the mesh layer parameter

toVariantMap

rtype:

Dict[str, Any]

type

rtype:

str

typeName

Returns the type name for the parameter class.

valueAsDatasetGroup

Returns the value as a list if dataset group indexes

valueAsPythonString

param value:
asPythonString(self, outputType: QgsProcessing.PythonOutputType = QgsProcessing.PythonQgsProcessingAlgorithmSubclass) → str
Parameters:

outputType (QgsProcessing.PythonOutputType = QgsProcessing.PythonQgsProcessingAlgorithmSubclass) –

Return type:

str

checkValueIsAcceptable(self, input: Any, context: QgsProcessingContext = None) → bool
Parameters:
Return type:

bool

clone(self) → QgsProcessingParameterDefinition
Return type:

QgsProcessingParameterDefinition

defaultGuiValueFromSetting(self) → Any

Default gui value for an algorithm parameter from settings

Returns:

default value from settings or invalid QVariant if there is no default value defined in the settings

New in version 3.34.

dependsOnOtherParameters(self) → List[str]
Return type:

List[str]

fromVariantMap(self, map: Dict[str, Any]) → bool
Parameters:

map (Dict[str) –

Return type:

bool

isDataTypeSupported(self, dataType: QgsMeshDatasetGroupMetadata.DataType) → bool

Returns whether the data type is supported by the parameter

Parameters:

dataType (QgsMeshDatasetGroupMetadata.DataType) –

Return type:

bool

meshLayerParameterName(self) → str

Returns the name of the mesh layer parameter

Return type:

str

toVariantMap(self) → Dict[str, Any]
Return type:

Dict[str, Any]

type(self) → str
Return type:

str

typeName() → str

Returns the type name for the parameter class.

Return type:

str

valueAsDatasetGroup(value: Any) → List[int]

Returns the value as a list if dataset group indexes

Parameters:

value (Any) –

Return type:

List[int]

valueAsPythonString(self, value: Any, context: QgsProcessingContext) → str
Parameters:
Return type:

str