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 parameteroptional – whether the parameter is optional
QgsProcessingParameterMeshDatasetGroups(
QgsProcessingParameterMeshDatasetGroups
)Methods
- param outputType:
- param input:
- rtype:
QgsProcessingParameterDefinition
- rtype:
List[str]
Returns whether the data type is supported by the parameter
Returns the name of the mesh layer parameter
- rtype:
str
Returns the type name for the parameter class.
Returns the
value
as a list if dataset group indexes- 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:
input (Any) –
context (
QgsProcessingContext
= None) –
- Return type:
bool
- clone(self) QgsProcessingParameterDefinition ¶
- Return type:
- dependsOnOtherParameters(self) List[str] ¶
- Return type:
List[str]
- 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
- 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:
value (Any) –
context (QgsProcessingContext) –
- Return type:
str