Class: QgsGeometryCheck¶

class qgis.analysis.QgsGeometryCheck(context: QgsGeometryCheckContext, configuration: Dict[str, Any])¶

Bases: sip.wrapper

Create a new geometry check.

QgsGeometryCheck(QgsGeometryCheck)

This class manages all known geometry check factories.

QgsGeometryCheckRegistry is not usually directly created, but rather accessed through QgsAnalysis.geometryCheckRegistry()

Note

This class is a technology preview and unstable API.

New in version 3.4.

Parameters

context (QgsGeometryCheckContext) –
configuration –

AvailableInValidation = 2¶

class Change¶

Bases: sip.wrapper

QgsGeometryCheck.Change(_what: QgsGeometryCheck.ChangeWhat, _type: QgsGeometryCheck.ChangeType, _vidx: QgsVertexId = QgsVertexId()) Create a new Change

QgsGeometryCheck.Change(QgsGeometryCheck.Change)

type¶

vidx¶

what¶

ChangeAdded = 0¶

ChangeChanged = 2¶

ChangeFeature = 0¶

ChangeNode = 3¶

ChangePart = 1¶

ChangeRemoved = 1¶

ChangeRing = 2¶

class ChangeType¶: Bases: int

class ChangeWhat¶: Bases: int

class CheckType¶: Bases: int

FeatureCheck = 1¶

FeatureNodeCheck = 0¶

class Flag¶: Bases: int

class Flags¶

Bases: sip.wrapper

QgsGeometryCheck.Flags(Union[QgsGeometryCheck.Flags, QgsGeometryCheck.Flag]) QgsGeometryCheck.Flags(QgsGeometryCheck.Flags)

baseClass¶: alias of QgsGeometryCheck

LayerCheck = 2¶

class LayerFeatureIds¶

Bases: sip.wrapper

QgsGeometryCheck.LayerFeatureIds(QgsGeometryCheck.LayerFeatureIds)

checkType(self) → QgsGeometryCheck.CheckType¶

Returns the check type.

New in version 3.4.

Return type: QgsGeometryCheck.CheckType

collectErrors(self, featurePools: object, errors: object, messages: Iterable[str], feedback: QgsFeedback, ids: QgsGeometryCheck.LayerFeatureIds = QgsGeometryCheck.LayerFeatureIds()) → Tuple[object, List[str]]¶

The main worker method. Check all features available from featurePools and write errors found to errors. Other status messages can be written to messages. Progress should be reported to feedback. Only features and layers listed in ids should be checked.

New in version 3.4.

Parameters

featurePools (object) –
errors (object) –
messages (Iterable[str]) –
feedback (QgsFeedback) –
ids (QgsGeometryCheck.LayerFeatureIds = QgsGeometryCheck.LayerFeatureIds()) –

Return type

Tuple[object, List[str]]

compatibleGeometryTypes(self) → object¶

A list of geometry types for which this check can be performed.

New in version 3.4.

Return type: object

context(self) → QgsGeometryCheckContext¶

Returns the context

New in version 3.4.

Return type: QgsGeometryCheckContext

description(self) → str¶

Returns a human readable description for this check.

New in version 3.4.

Return type: str

flags(self) → QgsGeometryCheck.Flags¶

Flags for this geometry check.

Return type: QgsGeometryCheck.Flags

id(self) → str¶

Returns an id for this check.

New in version 3.4.

Return type: str

isCompatible(self, layer: QgsVectorLayer) → bool¶

Returns if this geometry check is compatible with layer. By default it checks for the geometry type in ``compatibleGeometryTypes``().

New in version 3.4.

Parameters: layer (QgsVectorLayer) –
Return type: bool

resolutionMethods(self) → List[str]¶

Returns a list of descriptions for available resolutions for errors. The index will be passed as method to fixError().

New in version 3.4.

Return type: List[str]

staticMetaObject = <PyQt5.QtCore.QMetaObject object>¶