Class: QgsProcessingParameterPointCloudAttribute¶

A point cloud layer attribute parameter for Processing algorithms.

Added in version 3.32.

List of all members, including inherited members

Class Hierarchy¶

Base classes¶

QgsProcessingParameterDefinition

Base class for the definition of processing parameters.

Methods

`allowMultiple`	Returns whether multiple field selections are permitted.
`defaultToAllAttributes`	Returns whether a parameter which allows multiple selections (see `allowMultiple()`) should automatically select all attributes as the default value.
`parentLayerParameterName`	Returns the name of the parent layer parameter, or an empty string if this is not set.
`setAllowMultiple`	Sets whether multiple field selections are permitted.
`setDefaultToAllAttributes`	Sets whether a parameter which allows multiple selections (see `allowMultiple()`) should automatically select all attributes as the default value.
`setParentLayerParameterName`	Sets the name of the parent layer parameter.

Static Methods

`fromScriptCode`	Creates a new parameter using the definition from a script code.
`typeName`	Returns the type name for the parameter class.

class qgis.core.QgsProcessingParameterPointCloudAttribute[source]¶

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[source]¶

Returns whether multiple field selections are permitted.

See also

setAllowMultiple()

Return type:: bool

defaultToAllAttributes(self) → bool[source]¶

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[source]¶

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[source]¶

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)[source]¶

Sets whether multiple field selections are permitted.

See also

allowMultiple()

Parameters:: allowMultiple (bool)

setDefaultToAllAttributes(self, enabled: bool)[source]¶

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)[source]¶

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[source]¶

Returns the type name for the parameter class.

Return type:: str