Class: QgsProcessingModelParameter

Represents an input parameter used by the model.

Class Hierarchy

Base classes

QgsProcessingModelComponent

Represents a component of a model algorithm.

Methods

loadVariant	Loads this parameter from a QVariantMap.
parameterName	Returns the associated parameter name.
setParameterName	Sets the associated parameter name.
toVariant	Saves this parameter to a QVariant.

class qgis.core.QgsProcessingModelParameter

Bases: QgsProcessingModelComponent

__init__(parameterName: str | None = '')

Constructor for QgsProcessingModelParameter. The parameter name should match one of the parameters from the parent model.

Parameters:

parameterName (Optional[str] = '')

__init__(a0: QgsProcessingModelParameter)

Parameters:

a0 (QgsProcessingModelParameter)

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

Loads this parameter from a QVariantMap.

See also

toVariant()

Parameters:

map (Dict[str, Any])

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

parameterName()

Return type:

str

setParameterName(self, name: str | None)

Sets the associated parameter name. The parameter name should match one of the parameters from the parent model.

See also

parameterName()

Parameters:

name (Optional[str])

toVariant(self) → Any

Saves this parameter to a QVariant.

See also

loadVariant()

Return type:

Any