QgsGeometryOverlapCheckError class

An error of a QgsGeometryOverlapCheck.

Reference

Base classes

class QgsGeometryCheckError: This represents an error reported by a geometry check.

Constructors, destructors, conversion operators

QgsGeometryOverlapCheckError(const QgsGeometryCheck* check, const QgsGeometryCheckerUtils::LayerFeature& layerFeature, const QgsGeometry& geometry, const QgsPointXY& errorLocation, const QVariant& value, const QgsGeometryCheckerUtils::LayerFeature& overlappedFeature): Creates a new overlap check error for check and the layerFeature combination.

Public functions

auto closeMatch(QgsGeometryCheckError*) const -> bool override: Check if this error is almost equal to other.
auto description() const -> QString override: The error description.
auto handleChanges(const QgsGeometryCheck::Changes& changes) -> bool override: Apply a list of changes.
auto isEqual(QgsGeometryCheckError* other) const -> bool override: Check if this error is equal to other.
auto overlappedFeature() const -> const OverlappedFeature&: Returns the overlapped feature.

Function documentation

QgsGeometryOverlapCheckError::QgsGeometryOverlapCheckError(const QgsGeometryCheck* check, const QgsGeometryCheckerUtils::LayerFeature& layerFeature, const QgsGeometry& geometry, const QgsPointXY& errorLocation, const QVariant& value, const QgsGeometryCheckerUtils::LayerFeature& overlappedFeature)

Creates a new overlap check error for check and the layerFeature combination.

The geometry and errorLocation ned to be in map coordinates. The value is the area of the overlapping area in map units. The overlappedFeature provides more details about the overlap.

bool QgsGeometryOverlapCheckError::closeMatch(QgsGeometryCheckError*) const override

Check if this error is almost equal to other.

If this returns true, it can be used to update existing errors after re-checking.

QString QgsGeometryOverlapCheckError::description() const override

The error description.

By default the description of the parent check will be returned.

bool QgsGeometryOverlapCheckError::isEqual(QgsGeometryCheckError* other) const override

Check if this error is equal to other.

Is reimplemented by subclasses with additional information, comparison of base information is done in parent class.