QGIS API Documentation 3.99.0-Master (26c88405ac0)
Loading...
Searching...
No Matches
QgsGeometryValidator Class Reference

Validates geometries using the QGIS geometry validation model. More...

#include <qgsgeometryvalidator.h>

Inheritance diagram for QgsGeometryValidator:

Public Slots

void addError (const QgsGeometry::Error &)

Signals

void errorFound (const QgsGeometry::Error &error)
 Sent when an error has been found during the validation process.
void validationFinished (const QString &summary)
 Sent when the validation is finished.

Public Member Functions

 QgsGeometryValidator (const QgsGeometry &geometry, QVector< QgsGeometry::Error > *errors=nullptr, Qgis::GeometryValidationEngine method=Qgis::GeometryValidationEngine::QgisInternal)
 Constructor for QgsGeometryValidator.
 ~QgsGeometryValidator () override
void run () override
void stop ()

Static Public Member Functions

static void validateGeometry (const QgsGeometry &geometry, QVector< QgsGeometry::Error > &errors, Qgis::GeometryValidationEngine method=Qgis::GeometryValidationEngine::QgisInternal)
 Validate geometry and produce a list of geometry errors.

Detailed Description

Validates geometries using the QGIS geometry validation model.

Definition at line 32 of file qgsgeometryvalidator.h.

Constructor & Destructor Documentation

◆ QgsGeometryValidator()

QgsGeometryValidator::QgsGeometryValidator ( const QgsGeometry & geometry,
QVector< QgsGeometry::Error > * errors = nullptr,
Qgis::GeometryValidationEngine method = Qgis::GeometryValidationEngine::QgisInternal )

Constructor for QgsGeometryValidator.

Definition at line 29 of file qgsgeometryvalidator.cpp.

◆ ~QgsGeometryValidator()

QgsGeometryValidator::~QgsGeometryValidator ( )
override

Definition at line 38 of file qgsgeometryvalidator.cpp.

Member Function Documentation

◆ addError

void QgsGeometryValidator::addError ( const QgsGeometry::Error & e)
slot

Definition at line 394 of file qgsgeometryvalidator.cpp.

◆ errorFound

void QgsGeometryValidator::errorFound ( const QgsGeometry::Error & error)
signal

Sent when an error has been found during the validation process.

The error contains details about the error.

◆ run()

void QgsGeometryValidator::run ( )
override

Definition at line 251 of file qgsgeometryvalidator.cpp.

◆ stop()

void QgsGeometryValidator::stop ( )

Definition at line 44 of file qgsgeometryvalidator.cpp.

◆ validateGeometry()

void QgsGeometryValidator::validateGeometry ( const QgsGeometry & geometry,
QVector< QgsGeometry::Error > & errors,
Qgis::GeometryValidationEngine method = Qgis::GeometryValidationEngine::QgisInternal )
static

Validate geometry and produce a list of geometry errors.

This method blocks the thread until the validation is finished.

Definition at line 400 of file qgsgeometryvalidator.cpp.

◆ validationFinished

void QgsGeometryValidator::validationFinished ( const QString & summary)
signal

Sent when the validation is finished.

The result is in a human readable summary, mentioning if the validation has been aborted, successfully been validated or how many errors have been found.

Since
QGIS 3.6

The documentation for this class was generated from the following files: