Class: QgsGeometryCheckFactory

A factory for geometry checks.

Note

This class is a technology preview and unstable API.

Added in version 3.4.

Note

This is an abstract class, with methods which must be implemented by a subclass.

The following methods must be implemented: checkType(), createGeometryCheck(), description(), flags(), id(), isCompatible()

class qgis.analysis.QgsGeometryCheckFactory[source]

Bases: object

abstract checkType(self) → QgsGeometryCheck.CheckType[source]

The type of this check.

Return type:

QgsGeometryCheck.CheckType

abstract createGeometryCheck(self, context: QgsGeometryCheckContext | None, configuration: Dict[str, Any]) → QgsGeometryCheck | None[source]

Creates a new geometry check with context and configuration.

Parameters:
Return type:

Optional[QgsGeometryCheck]

abstract description(self) → str[source]

A human readable description for this check.

Return type:

str

abstract flags(self) → QgsGeometryCheck.Flags[source]

Flags for this check.

Return type:

QgsGeometryCheck.Flags

abstract id(self) → str[source]

The unique id for this geometry check.

Return type:

str

abstract isCompatible(self, layer: QgsVectorLayer | None) → bool[source]

Checks if this check should be made available for layer.

Parameters:

layer (Optional[QgsVectorLayer])

Return type:

bool