QGIS API Documentation  3.14.0-Pi (9f7028fd23)
qgsgeometrymissingvertexcheck.h
Go to the documentation of this file.
1 /***************************************************************************
2  qgsgeometrymissingvertexcheck.h
3  ---------------------
4  begin : September 2018
5  copyright : (C) 2018 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 #define SIP_NO_FILE
17 
18 #ifndef QGSGEOMETRYMISSINGVERTEXCHECK_H
19 #define QGSGEOMETRYMISSINGVERTEXCHECK_H
20 
21 #include "qgsgeometrycheck.h"
22 #include "qgsgeometrycheckerror.h"
23 
24 class QgsCurvePolygon;
25 
37 {
38  public:
39 
44  const QgsGeometryCheckerUtils::LayerFeature &layerFeature,
45  const QgsPointXY &errorLocation,
46  QgsVertexId vidx = QgsVertexId(),
47  const QVariant &value = QVariant(),
48  ValueType valueType = ValueOther );
49 
50  QgsRectangle affectedAreaBBox() const override;
51 
57  void setAffectedAreaBBox( const QgsRectangle &affectedAreaBBox );
58 
59  QMap<QString, QgsFeatureIds> involvedFeatures() const override;
60 
67  void setInvolvedFeatures( const QMap<QString, QgsFeatureIds> &involvedFeatures );
68 
69  QIcon icon() const override;
70 
71  private:
72  QgsRectangle mAffectedAreaBBox;
73  QMap<QString, QgsFeatureIds> mInvolvedFeatures;
74 };
75 
85 class ANALYSIS_EXPORT QgsGeometryMissingVertexCheck : public QgsGeometryCheck
86 {
87  Q_GADGET
88 
89  public:
90 
95  {
97  AddMissingVertex
98  };
99  Q_ENUM( ResolutionMethod )
100 
101 
104  explicit QgsGeometryMissingVertexCheck( const QgsGeometryCheckContext *context, const QVariantMap &geometryCheckConfiguration );
105  void collectErrors( const QMap<QString, QgsFeaturePool *> &featurePools, QList<QgsGeometryCheckError *> &errors, QStringList &messages, QgsFeedback *feedback, const LayerFeatureIds &ids = LayerFeatureIds() ) const override;
106  void fixError( const QMap<QString, QgsFeaturePool *> &featurePools, QgsGeometryCheckError *error, int method, const QMap<QString, int> &mergeAttributeIndices, Changes &changes ) const override;
107  Q_DECL_DEPRECATED QStringList resolutionMethods() const override;
108 
109  QString description() const override;
110  QString id() const override;
111  QList<QgsWkbTypes::GeometryType> compatibleGeometryTypes() const override;
112  QgsGeometryCheck::Flags flags() const override;
113  QgsGeometryCheck::CheckType checkType() const override;
114 
116  static QList<QgsWkbTypes::GeometryType> factoryCompatibleGeometryTypes() SIP_SKIP;
117  static bool factoryIsCompatible( QgsVectorLayer *layer ) SIP_SKIP;
118  static QString factoryDescription() SIP_SKIP;
119  static QString factoryId() SIP_SKIP;
120  static QgsGeometryCheck::Flags factoryFlags() SIP_SKIP;
121  static QgsGeometryCheck::CheckType factoryCheckType() SIP_SKIP;
123 
124  private:
125  void processPolygon( const QgsCurvePolygon *polygon, QgsFeaturePool *featurePool, QList<QgsGeometryCheckError *> &errors, const QgsGeometryCheckerUtils::LayerFeature &layerFeature, QgsFeedback *feedback ) const;
126 
127  QgsRectangle contextBoundingBox( const QgsCurvePolygon *polygon, const QgsVertexId &vertexId, const QgsPoint &point ) const;
128 };
129 
130 
131 
132 #endif // QGSGEOMETRYMISSINGVERTEXCHECK_H
QgsGeometryCheck::compatibleGeometryTypes
virtual QList< QgsWkbTypes::GeometryType > compatibleGeometryTypes() const =0
A list of geometry types for which this check can be performed.
QgsPoint
Point geometry type, with support for z-dimension and m-values.
Definition: qgspoint.h:37
QgsGeometryMissingVertexCheck
Definition: qgsgeometrymissingvertexcheck.h:85
QgsGeometryCheckError::ValueType
ValueType
Describes the type of an error value.
Definition: qgsgeometrycheckerror.h:53
QgsCurvePolygon
Curve polygon geometry type.
Definition: qgscurvepolygon.h:34
QgsGeometryCheck::description
virtual QString description() const =0
Returns a human readable description for this check.
QgsGeometryCheck::resolutionMethods
virtual Q_DECL_DEPRECATED QStringList resolutionMethods() const
Returns a list of descriptions for available resolutions for errors.
Definition: qgsgeometrycheck.cpp:77
qgsgeometrycheckerror.h
QgsGeometryCheck::collectErrors
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.
QgsRectangle
Definition: qgsrectangle.h:41
QgsGeometryCheck
Definition: qgsgeometrycheck.h:91
QgsGeometryCheck::flags
virtual QgsGeometryCheck::Flags flags() const
Flags for this geometry check.
Definition: qgsgeometrycheck.cpp:45
QgsGeometryCheck::fixError
virtual void fixError(const QMap< QString, QgsFeaturePool * > &featurePools, QgsGeometryCheckError *error, int method, const QMap< QString, int > &mergeAttributeIndices, Changes &changes) const
Fixes the error error with the specified method.
Definition: qgsgeometrycheck.cpp:50
QgsGeometryCheck::id
virtual QString id() const =0
Returns an id for this check.
SIP_SKIP
#define SIP_SKIP
Definition: qgis_sip.h:126
qgsgeometrycheck.h
QgsGeometryCheck::checkType
virtual CheckType checkType() const =0
Returns the check type.
QgsGeometryCheckError::affectedAreaBBox
virtual QgsRectangle affectedAreaBBox() const
The bounding box of the affected area of the error.
Definition: qgsgeometrycheckerror.cpp:93
QgsFeedback
Definition: qgsfeedback.h:43
QgsGeometryCheckContext
Definition: qgsgeometrycheckcontext.h:31
QgsGeometryCheckerUtils::LayerFeature
Definition: qgsgeometrycheckerutils.h:51
QgsPointXY
Definition: qgspointxy.h:43
QgsVectorLayer
Definition: qgsvectorlayer.h:385
QgsGeometryCheck::CheckType
CheckType
The type of a check.
Definition: qgsgeometrycheck.h:155
QgsVertexId
Utility class for identifying a unique vertex within a geometry.
Definition: qgsabstractgeometry.h:1033
QgsGeometryCheckerUtils
Definition: qgsgeometrycheckerutils.h:39
QgsGeometryMissingVertexCheck::ResolutionMethod
ResolutionMethod
The available resolutions for missing vertex check.
Definition: qgsgeometrymissingvertexcheck.h:94
QgsGeometryCheckError
Definition: qgsgeometrycheckerror.h:35
QgsGeometryCheckError::icon
virtual QIcon icon() const
Returns an icon that should be shown for this kind of error.
Definition: qgsgeometrycheckerror.cpp:199
QgsGeometryMissingVertexCheck::NoChange
@ NoChange
Do nothing.
Definition: qgsgeometrymissingvertexcheck.h:96
QgsFeaturePool
Definition: qgsfeaturepool.h:37
QgsGeometryMissingVertexCheckError
Definition: qgsgeometrymissingvertexcheck.h:36
QgsGeometryCheckError::involvedFeatures
virtual QMap< QString, QgsFeatureIds > involvedFeatures() const
Returns a list of involved features.
Definition: qgsgeometrycheckerror.cpp:194