QGIS API Documentation  3.9.0-Master (224899f119)
Public Slots | Signals | Public Member Functions | Static Public Member Functions | List of all members
QgsGeometryValidator Class Reference

#include <qgsgeometryvalidator.h>

Inheritance diagram for QgsGeometryValidator:
Inheritance graph
[legend]

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. More...
 
void validationFinished (const QString &summary)
 Sent when the validation is finished. More...
 

Public Member Functions

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

Static Public Member Functions

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

Detailed Description

Definition at line 28 of file qgsgeometryvalidator.h.

Constructor & Destructor Documentation

◆ QgsGeometryValidator()

QgsGeometryValidator::QgsGeometryValidator ( const QgsGeometry geometry,
QVector< QgsGeometry::Error > *  errors = nullptr,
QgsGeometry::ValidationMethod  method = QgsGeometry::ValidatorQgisInternal 
)

Constructor for QgsGeometryValidator.

Definition at line 22 of file qgsgeometryvalidator.cpp.

◆ ~QgsGeometryValidator()

QgsGeometryValidator::~QgsGeometryValidator ( )
override

Definition at line 31 of file qgsgeometryvalidator.cpp.

Member Function Documentation

◆ addError

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

Definition at line 334 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 213 of file qgsgeometryvalidator.cpp.

◆ stop()

void QgsGeometryValidator::stop ( )

Definition at line 37 of file qgsgeometryvalidator.cpp.

◆ validateGeometry()

void QgsGeometryValidator::validateGeometry ( const QgsGeometry geometry,
QVector< QgsGeometry::Error > &  errors,
QgsGeometry::ValidationMethod  method = QgsGeometry::ValidatorQgisInternal 
)
static

Validate geometry and produce a list of geometry errors.

This method blocks the thread until the validation is finished.

Definition at line 340 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: