QGIS API Documentation 3.28.0-Firenze (ed3ad0430f)
Public Member Functions | Protected Attributes | List of all members
QgsSingleGeometryCheckError Class Reference

An error from a QgsSingleGeometryCheck. More...

#include <qgssinglegeometrycheck.h>

Inheritance diagram for QgsSingleGeometryCheckError:
Inheritance graph
[legend]

Public Member Functions

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

Protected Attributes

const QgsSingleGeometryCheckmCheck = nullptr
 
QgsGeometry mErrorLocation
 
QgsGeometry mGeometry
 
QgsVertexId mVertexId
 

Detailed Description

An error from a QgsSingleGeometryCheck.

Note
This class is a technology preview and unstable API.
Since
QGIS 3.4

Definition at line 39 of file qgssinglegeometrycheck.h.

Constructor & Destructor Documentation

◆ QgsSingleGeometryCheckError()

QgsSingleGeometryCheckError::QgsSingleGeometryCheckError ( const QgsSingleGeometryCheck check,
const QgsGeometry geometry,
const QgsGeometry errorLocation,
const QgsVertexId vertexId = QgsVertexId() 
)
inline

Creates a new single geometry check error.

Definition at line 46 of file qgssinglegeometrycheck.h.

◆ ~QgsSingleGeometryCheckError()

virtual QgsSingleGeometryCheckError::~QgsSingleGeometryCheckError ( )
virtualdefault

Member Function Documentation

◆ check()

const QgsSingleGeometryCheck * QgsSingleGeometryCheckError::check ( ) const

The check that created this error.

Since
QGIS 3.4

Definition at line 69 of file qgssinglegeometrycheck.cpp.

◆ description()

QString QgsSingleGeometryCheckError::description ( ) const
virtual

A human readable description of this error.

Reimplemented in QgsGeometryIsValidCheckError, and QgsGeometryTypeCheckError.

Definition at line 64 of file qgssinglegeometrycheck.cpp.

◆ errorLocation()

QgsGeometry QgsSingleGeometryCheckError::errorLocation ( ) const

The exact location of the error.

Since
QGIS 3.4

Definition at line 74 of file qgssinglegeometrycheck.cpp.

◆ handleChanges()

bool QgsSingleGeometryCheckError::handleChanges ( const QList< QgsGeometryCheck::Change > &  changes)
virtual

Apply a list of changes.

Reimplemented in QgsGeometrySelfIntersectionCheckError.

Definition at line 58 of file qgssinglegeometrycheck.cpp.

◆ isEqual()

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.

Reimplemented in QgsGeometrySelfIntersectionCheckError, and QgsGeometryTypeCheckError.

Definition at line 50 of file qgssinglegeometrycheck.cpp.

◆ update()

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.

Reimplemented in QgsGeometrySelfIntersectionCheckError.

Definition at line 42 of file qgssinglegeometrycheck.cpp.

◆ vertexId()

QgsVertexId QgsSingleGeometryCheckError::vertexId ( ) const

The vertex id of the error.

May be invalid depending on the check.

Since
QGIS 3.4

Definition at line 79 of file qgssinglegeometrycheck.cpp.

Member Data Documentation

◆ mCheck

const QgsSingleGeometryCheck* QgsSingleGeometryCheckError::mCheck = nullptr
protected

Definition at line 100 of file qgssinglegeometrycheck.h.

◆ mErrorLocation

QgsGeometry QgsSingleGeometryCheckError::mErrorLocation
protected

Definition at line 102 of file qgssinglegeometrycheck.h.

◆ mGeometry

QgsGeometry QgsSingleGeometryCheckError::mGeometry
protected

Definition at line 101 of file qgssinglegeometrycheck.h.

◆ mVertexId

QgsVertexId QgsSingleGeometryCheckError::mVertexId
protected

Definition at line 103 of file qgssinglegeometrycheck.h.


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