QgsSingleGeometryCheckError class

An error from a QgsSingleGeometryCheck.

Contents

Derived classes

class QgsGeometryIsValidCheckError
An error for a QgsGeometryIsValid check.

Constructors, destructors, conversion operators

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

Public functions

auto check() const -> const QgsSingleGeometryCheck*
The check that created this error.
auto description() const -> QString virtual
A human readable description of this error.
auto errorLocation() const -> QgsGeometry
The exact location of the error.
auto handleChanges(const QList<QgsGeometryCheck::Change>& changes) -> bool virtual
Apply a list of changes.
auto isEqual(const QgsSingleGeometryCheckError* other) const -> bool virtual
Check if this error is equal to other.
void update(const QgsSingleGeometryCheckError* other) virtual
Update this error with the information from other.
auto vertexId() const -> QgsVertexId
The vertex id of the error.

Function documentation

const QgsSingleGeometryCheck* QgsSingleGeometryCheckError::check() const

The check that created this error.

QgsGeometry QgsSingleGeometryCheckError::errorLocation() const

The exact location of the error.

bool QgsSingleGeometryCheckError::isEqual(const QgsSingleGeometryCheckError* other) const virtual

Check if this error is equal to other.

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

void QgsSingleGeometryCheckError::update(const QgsSingleGeometryCheckError* other) virtual

Update this error with the information from other.

Will be used to update existing errors whenever they are re-checked.

QgsVertexId QgsSingleGeometryCheckError::vertexId() const

The vertex id of the error.

May be invalid depending on the check.