Class: QgsGeometryCheckError

class qgis.analysis.QgsGeometryCheckError

Bases: sip.wrapper

This represents an error reported by a geometry check.

Note

This class is a technology preview and unstable API.

Methods

affectedAreaBBox

rtype

QgsRectangle

check

rtype

QgsGeometryCheck

closeMatch

Check if this error is almost equal to other.

description

rtype

str

featureId

rtype

int

geometry

rtype

QgsGeometry

icon

Returns an icon that should be shown for this kind of error.

isEqual

Check if this error is equal to other.

layerId

rtype

str

location

rtype

QgsPointXY

resolutionMessage

rtype

str

setFixFailed

param reason

setFixed

param method

setObsolete

status

rtype

QgsGeometryCheckError.Status

update

Update this error with the information from other.

value

rtype

Any

valueType

rtype

QgsGeometryCheckError.ValueType

vidx

rtype

QgsVertexId

Attributes

StatusFixFailed

StatusFixed

StatusObsolete

StatusPending

ValueArea

ValueLength

ValueOther

class Status

Bases: int

StatusFixFailed = 1
StatusFixed = 2
StatusObsolete = 3
StatusPending = 0
ValueArea = 1
ValueLength = 0
ValueOther = 2
class ValueType

Bases: int

affectedAreaBBox(self) → QgsRectangle
Return type

QgsRectangle

check(self) → QgsGeometryCheck
Return type

QgsGeometryCheck

closeMatch(self, QgsGeometryCheckError) → bool

Check if this error is almost equal to other. If this returns true, it can be used to update existing errors after re-checking.

Return type

bool

description(self) → str
Return type

str

featureId(self) → int
Return type

int

geometry(self) → QgsGeometry
Return type

QgsGeometry

icon(self) → QIcon

Returns an icon that should be shown for this kind of error.

New in version 3.8.

Return type

QIcon

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

Return type

bool

layerId(self) → str
Return type

str

location(self) → QgsPointXY
Return type

QgsPointXY

resolutionMessage(self) → str
Return type

str

setFixFailed(self, reason: str)
Parameters

reason (str) –

setFixed(self, method: int)
Parameters

method (int) –

setObsolete(self)
status(self) → QgsGeometryCheckError.Status
Return type

QgsGeometryCheckError.Status

update(self, other: QgsGeometryCheckError)

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

Parameters

other (QgsGeometryCheckError) –

value(self) → Any
Return type

Any

valueType(self) → QgsGeometryCheckError.ValueType
Return type

QgsGeometryCheckError.ValueType

vidx(self) → QgsVertexId
Return type

QgsVertexId