QGIS API Documentation  3.8.0-Zanzibar (11aff65)
qgssinglegeometrycheck.h
Go to the documentation of this file.
1 /***************************************************************************
2  qgssinglegeometrycheck.h
3  --------------------------------------
4 Date : 6.9.2018
5 Copyright : (C) 2018 by Matthias Kuhn
6 email : [email protected]
7  ***************************************************************************
8  * *
9  * This program is free software; you can redistribute it and/or modify *
10  * it under the terms of the GNU General Public License as published by *
11  * the Free Software Foundation; either version 2 of the License, or *
12  * (at your option) any later version. *
13  * *
14  ***************************************************************************/
15 
16 #ifndef QGSSINGLEGEOMETRYCHECK_H
17 #define QGSSINGLEGEOMETRYCHECK_H
18 
19 #include <QList>
20 #include <QCoreApplication>
21 
22 #include "qgsgeometry.h"
23 #include "qgsgeometrycheck.h"
24 #include "qgsgeometrycheckerror.h"
25 
26 #include "qgis_analysis.h"
27 
28 class QgsFeature;
30 
39 class ANALYSIS_EXPORT QgsSingleGeometryCheckError
40 {
41  public:
42 
46  QgsSingleGeometryCheckError( const QgsSingleGeometryCheck *check, const QgsGeometry &geometry, const QgsGeometry &errorLocation, const QgsVertexId &vertexId = QgsVertexId() )
47  : mCheck( check )
48  , mGeometry( geometry )
49  , mErrorLocation( errorLocation )
50  , mVertexId( vertexId )
51  {}
52 
53  virtual ~QgsSingleGeometryCheckError() = default;
54 
59  virtual void update( const QgsSingleGeometryCheckError *other );
60 
66  virtual bool isEqual( const QgsSingleGeometryCheckError *other ) const;
67 
71  virtual bool handleChanges( const QList<QgsGeometryCheck::Change> &changes ) SIP_SKIP;
72 
76  virtual QString description() const;
77 
83  const QgsSingleGeometryCheck *check() const;
84 
90  QgsGeometry errorLocation() const;
91 
97  QgsVertexId vertexId() const;
98 
99  protected:
100  const QgsSingleGeometryCheck *mCheck = nullptr;
104 };
105 
116 {
117  public:
118 
123 
127  QgsSingleGeometryCheckError *singleError() const;
128 
129  bool handleChanges( const QgsGeometryCheck::Changes &changes ) override SIP_SKIP;
130 
131  private:
132  QgsSingleGeometryCheckError *mError = nullptr;
133 };
134 
145 class ANALYSIS_EXPORT QgsSingleGeometryCheck : public QgsGeometryCheck
146 {
147  public:
148 
153  const QVariantMap &configuration )
154  : QgsGeometryCheck( context, configuration )
155  {}
156 
157  void collectErrors( const QMap<QString, QgsFeaturePool *> &featurePools,
158  QList<QgsGeometryCheckError *> &errors,
159  QStringList &messages,
160  QgsFeedback *feedback = nullptr,
162 
171  virtual QList<QgsSingleGeometryCheckError *> processGeometry( const QgsGeometry &geometry ) const = 0;
172 
173  private:
174 
180  QgsGeometryCheckErrorSingle *convertToGeometryCheckError( QgsSingleGeometryCheckError *singleGeometryCheckError, const QgsGeometryCheckerUtils::LayerFeature &layerFeature ) const;
181 
182 };
183 
184 #endif // QGSSINGLEGEOMETRYCHECK_H
QgsSingleGeometryCheckError(const QgsSingleGeometryCheck *check, const QgsGeometry &geometry, const QgsGeometry &errorLocation, const QgsVertexId &vertexId=QgsVertexId())
Creates a new single geometry check error.
QgsSingleGeometryCheck(const QgsGeometryCheckContext *context, const QVariantMap &configuration)
Creates a new single geometry check.
A geometry is the spatial representation of a feature.
Definition: qgsgeometry.h:111
The feature class encapsulates a single feature including its id, geometry and a list of field/values...
Definition: qgsfeature.h:55
Base class for geometry checks for a single geometry without any context of the layer or other layers...
Base class for feedback objects to be used for cancellation of something running in a worker thread...
Definition: qgsfeedback.h:44
Base configuration for geometry checks.
Utility class for identifying a unique vertex within a geometry.
#define SIP_SKIP
Definition: qgis_sip.h:119
A layer feature combination to uniquely identify and access a feature in a set of layers...
This class implements a geometry check.
Wraps a QgsSingleGeometryError into a standard QgsGeometryCheckError.
A list of layers and feature ids for each of these layers.
An error from a QgsSingleGeometryCheck.
#define FINAL
Definition: qgis_sip.h:216
QMap< QString, QMap< QgsFeatureId, QList< QgsGeometryCheck::Change > > > Changes
A collection of changes.
virtual bool handleChanges(const QgsGeometryCheck::Changes &changes)
Apply a list of changes.
This represents an error reported by a geometry check.
virtual void collectErrors(const QMap< QString, QgsFeaturePool *> &featurePools, QList< QgsGeometryCheckError *> &errors, QStringList &messages, QgsFeedback *feedback, const LayerFeatureIds &ids=QgsGeometryCheck::LayerFeatureIds()) const =0
The main worker method.