Class: QgsProcessingParameterPointCloudAttribute

A point cloud layer attribute parameter for Processing algorithms.

Added in version 3.32.

Class Hierarchy

Base classes

QgsProcessingParameterDefinition

Base class for the definition of processing parameters.

class qgis.core.QgsProcessingParameterPointCloudAttribute

Bases: QgsProcessingParameterDefinition

__init__(name: str | None, description: str | None = '', defaultValue: Any = None, parentLayerParameterName: str | None = '', allowMultiple: bool = False, optional: bool = False, defaultToAllAttributes: bool = False)

Constructor for QgsProcessingParameterField.

Parameters:

• name (Optional[str])

• description (Optional[str] = '')

• defaultValue (Any = None)

• parentLayerParameterName (Optional[str] = '')

• allowMultiple (bool = False)

• optional (bool = False)

• defaultToAllAttributes (bool = False)

__init__(a0: QgsProcessingParameterPointCloudAttribute)

Parameters:

a0 (QgsProcessingParameterPointCloudAttribute)

allowMultiple(self) → bool

Returns whether multiple field selections are permitted.

See also

setAllowMultiple()

Return type:

bool

defaultToAllAttributes(self) → bool

Returns whether a parameter which allows multiple selections (see allowMultiple()) should automatically select all attributes as the default value.

If True, this will override any existing defaultValue() set on the parameter.

See also

setDefaultToAllAttributes()

Return type:

bool

static fromScriptCode(name: str | None, description: str | None, isOptional: bool, definition: str | None) → QgsProcessingParameterPointCloudAttribute | None

Creates a new parameter using the definition from a script code.

Parameters:

• name (Optional[str])

• description (Optional[str])

• isOptional (bool)

• definition (Optional[str])

Return type:

Optional[QgsProcessingParameterPointCloudAttribute]

parentLayerParameterName(self) → str

Returns the name of the parent layer parameter, or an empty string if this is not set.

See also

setParentLayerParameterName()

Return type:

str

setAllowMultiple(self, allowMultiple: bool)

Sets whether multiple field selections are permitted.

See also

allowMultiple()

Parameters:

allowMultiple (bool)

setDefaultToAllAttributes(self, enabled: bool)

Sets whether a parameter which allows multiple selections (see allowMultiple()) should automatically select all attributes as the default value.

If True, this will override any existing defaultValue() set on the parameter.

See also

defaultToAllAttributes()

Parameters:

enabled (bool)

setParentLayerParameterName(self, parentLayerParameterName: str | None)

Sets the name of the parent layer parameter. Use an empty string if this is not required.

See also

parentLayerParameterName()

Parameters:

parentLayerParameterName (Optional[str])

static typeName() → str

Returns the type name for the parameter class.

Return type:

str