Class: QgsSingleGeometryCheckError

class qgis.analysis.QgsSingleGeometryCheckError

Bases: sip.wrapper

An error from a QgsSingleGeometryCheck.

Note

This class is a technology preview and unstable API.

New in version 3.4.

QgsSingleGeometryCheckError(check: QgsSingleGeometryCheck, geometry: QgsGeometry, errorLocation: QgsGeometry, vertexId: QgsVertexId = QgsVertexId()) Creates a new single geometry check error.

QgsSingleGeometryCheckError(QgsSingleGeometryCheckError)

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.

check(self)QgsSingleGeometryCheck

The check that created this error.

New in version 3.4.

Return type

QgsSingleGeometryCheck

description(self)str

A human readable description of this error.

Return type

str

errorLocation(self)QgsGeometry

The exact location of the error.

New in version 3.4.

Return type

QgsGeometry

isEqual(self, other: QgsSingleGeometryCheckError)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 (QgsSingleGeometryCheckError) –

Return type

bool

update(self, other: QgsSingleGeometryCheckError)

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

Parameters

other (QgsSingleGeometryCheckError) –

vertexId(self)QgsVertexId

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

New in version 3.4.

Return type

QgsVertexId