Class: QgsSingleGeometryCheckError

An error from a QgsSingleGeometryCheck.

Note

This class is a technology preview and unstable API.

Added in version 3.4.

Methods

check	The check that created this error.
description	A human readable description of this error.
errorLocation	The exact location of the error.
isEqual	Check if this error is equal to other.
update	Update this error with the information from other.
vertexId	The vertex id of the error.

class qgis.analysis.QgsSingleGeometryCheckError

Bases: object

__init__(check: QgsSingleGeometryCheck | None, geometry: QgsGeometry, errorLocation: QgsGeometry, vertexId: QgsVertexId = QgsVertexId())

Creates a new single geometry check error.

Parameters:

• check (Optional[QgsSingleGeometryCheck])

• geometry (QgsGeometry)

• errorLocation (QgsGeometry)

• vertexId (QgsVertexId = QgsVertexId())

__init__(a0: QgsSingleGeometryCheckError)

Parameters:

a0 (QgsSingleGeometryCheckError)

check(self) → QgsSingleGeometryCheck | None

The check that created this error.

Added in version 3.4.

Return type:

Optional[QgsSingleGeometryCheck]

description(self) → str

A human readable description of this error.

Return type:

str

errorLocation(self) → QgsGeometry

The exact location of the error.

Added in version 3.4.

Return type:

QgsGeometry

isEqual(self, other: QgsSingleGeometryCheckError | None) → bool

Check if this error is equal to other. Is reimplemented by subclasses with additional information, comparison of base information is done in parent class.

Parameters:

other (Optional[QgsSingleGeometryCheckError])

Return type:

bool

update(self, other: QgsSingleGeometryCheckError | None)

Update this error with the information from other. Will be used to update existing errors whenever they are re-checked.

Parameters:

other (Optional[QgsSingleGeometryCheckError])

vertexId(self) → QgsVertexId

The vertex id of the error. May be invalid depending on the check.

Added in version 3.4.

Return type:

QgsVertexId