Class: QgsProcessingModelParameter¶
-
class
qgis.core.
QgsProcessingModelParameter
(parameterName: str = '')¶ Bases:
QgsProcessingModelComponent
Constructor for
QgsProcessingModelParameter
. The parameter name should match one of the parameters from the parent model.QgsProcessingModelParameter(
QgsProcessingModelParameter
)Represents an input parameter used by the model.
New in version 3.0.
- Parameters
parameterName –
-
loadVariant
(self, map: Dict[str, Any]) → bool¶ Loads this parameter from a QVariantMap.
See also
- Parameters
map (Dict[str) –
- Return type
bool
-
parameterName
(self) → str¶ Returns the associated parameter name. The parameter name should match one of the parameters from the parent model.
See also
- Return type
str
-
restoreCommonProperties
(self, map: Dict[str, Any])¶ Restores the component properties from a QVariantMap.
See also
-
saveCommonProperties
(self, map: Dict[str, Any])¶ Saves the component properties to a QVariantMap.
See also
-
setParameterName
(self, name: str)¶ Sets the associated parameter name. The parameter name should match one of the parameters from the parent model.
See also
- Parameters
name (str) –
-
toVariant
(self) → Any¶ Saves this parameter to a QVariant.
See also
- Return type
Any