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()

Abstract Methods

checkType	The type of this check.
createGeometryCheck	Creates a new geometry check with context and configuration.
description	A human readable description for this check.
flags	Flags for this check.
id	The unique id for this geometry check.
isCompatible	Checks if this check should be made available for layer.

class qgis.analysis.QgsGeometryCheckFactory

Bases: object

abstract checkType(self) → QgsGeometryCheck.CheckType

The type of this check.

Return type:

QgsGeometryCheck.CheckType

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

Creates a new geometry check with context and configuration.

Parameters:

• context (Optional[QgsGeometryCheckContext])

• configuration (Dict[str, Any])

Return type:

Optional[QgsGeometryCheck]

abstract description(self) → str

A human readable description for this check.

Return type:

str

abstract flags(self) → QgsGeometryCheck.Flags

Flags for this check.

Return type:

QgsGeometryCheck.Flags

abstract id(self) → str

The unique id for this geometry check.

Return type:

str

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

Checks if this check should be made available for layer.

Parameters:

layer (Optional[QgsVectorLayer])

Return type:

bool