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.
`errorLocation`	The exact location of the error.
`vertexId`	The vertex id of the error.

Virtual Methods

In PyQGIS, only methods marked as virtual can be safely overridden in a Python subclass of QgsSingleGeometryCheckError. See the FAQ for more details.

`description`	A human readable description of this error.
`isEqual`	Check if this error is equal to other.
`update`	Update this error with the information from other.

class qgis.analysis.QgsSingleGeometryCheckError[source]¶

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[source]¶

The check that created this error.

Added in version 3.4.

Return type:: Optional[QgsSingleGeometryCheck]

virtual description(self) → str[source]¶

A human readable description of this error.

Return type:: str

errorLocation(self) → QgsGeometry[source]¶

The exact location of the error.

Added in version 3.4.

Return type:: QgsGeometry

virtual isEqual(self, other: QgsSingleGeometryCheckError | None) → bool[source]¶

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

virtual update(self, other: QgsSingleGeometryCheckError | None)[source]¶

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[source]¶

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

Added in version 3.4.

Return type:: QgsVertexId