QGIS API Documentation  3.8.0-Zanzibar (11aff65)
qgsgeometrygapcheck.h
Go to the documentation of this file.
1 /***************************************************************************
2  qgsgeometrygapcheck.h
3  ---------------------
4  begin : September 2015
5  copyright : (C) 2014 by Sandro Mani / Sourcepole AG
6  email : smani at sourcepole dot ch
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 QGS_GEOMETRY_GAP_CHECK_H
19 #define QGS_GEOMETRY_GAP_CHECK_H
20 
21 #include "qgsgeometrycheck.h"
22 #include "qgsgeometrycheckerror.h"
23 #include "qgsfeatureid.h"
24 
31 class ANALYSIS_EXPORT QgsGeometryGapCheckError : public QgsGeometryCheckError
32 {
33  public:
34 
42  const QString &layerId,
43  const QgsGeometry &geometry,
44  const QMap<QString, QgsFeatureIds> &neighbors,
45  double area,
46  const QgsRectangle &gapAreaBBox )
47  : QgsGeometryCheckError( check, layerId, FID_NULL, geometry, geometry.constGet()->centroid(), QgsVertexId(), area, ValueArea )
48  , mNeighbors( neighbors )
49  , mGapAreaBBox( gapAreaBBox )
50  {
51  }
52 
56  const QMap<QString, QgsFeatureIds> &neighbors() const { return mNeighbors; }
57 
58  bool isEqual( QgsGeometryCheckError *other ) const override;
59 
60  bool closeMatch( QgsGeometryCheckError *other ) const override;
61 
62  void update( const QgsGeometryCheckError *other ) override;
63 
64  bool handleChanges( const QgsGeometryCheck::Changes & /*changes*/ ) override;
65 
66  QgsRectangle affectedAreaBBox() const override;
67 
68  QMap<QString, QgsFeatureIds > involvedFeatures() const override;
69 
70  QIcon icon() const override;
71 
72  private:
73  QMap<QString, QgsFeatureIds> mNeighbors;
74  QgsRectangle mGapAreaBBox;
75 };
76 
77 
84 class ANALYSIS_EXPORT QgsGeometryGapCheck : public QgsGeometryCheck
85 {
86  Q_GADGET
87  public:
90  {
92  NoChange
93  };
94  Q_ENUM( ResolutionMethod )
95 
96 
102  explicit QgsGeometryGapCheck( const QgsGeometryCheckContext *context, const QVariantMap &configuration );
103 
104  QList<QgsWkbTypes::GeometryType> compatibleGeometryTypes() const override { return factoryCompatibleGeometryTypes(); }
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  QStringList resolutionMethods() const override;
108 
109  QString description() const override;
110  QString id() const override;
111  QgsGeometryCheck::Flags flags() const override;
112  QgsGeometryCheck::CheckType checkType() const override { return factoryCheckType(); }
113 
115  static QString factoryDescription() SIP_SKIP;
116  static QString factoryId() SIP_SKIP;
117  static QgsGeometryCheck::Flags factoryFlags() SIP_SKIP;
118  static QList<QgsWkbTypes::GeometryType> factoryCompatibleGeometryTypes() SIP_SKIP;
119  static bool factoryIsCompatible( QgsVectorLayer *layer ) SIP_SKIP;
120  static QgsGeometryCheck::CheckType factoryCheckType() SIP_SKIP;
122 
123  private:
124  bool mergeWithNeighbor( const QMap<QString, QgsFeaturePool *> &featurePools,
125  QgsGeometryGapCheckError *err, Changes &changes, QString &errMsg ) const;
126 
127  const double mGapThresholdMapUnits;
128 };
129 
130 #endif // QGS_GEOMETRY_GAP_CHECK_H
A rectangle specified with double values.
Definition: qgsrectangle.h:41
QgsGeometryGapCheckError(const QgsGeometryCheck *check, const QString &layerId, const QgsGeometry &geometry, const QMap< QString, QgsFeatureIds > &neighbors, double area, const QgsRectangle &gapAreaBBox)
Create a new gap check error produced by check on the layer layerId.
QList< QgsWkbTypes::GeometryType > compatibleGeometryTypes() const override
A list of geometry types for which this check can be performed.
virtual void update(const QgsGeometryCheckError *other)
Update this error with the information from other.
Checks for gaps between neighbouring polygons.
#define FID_NULL
Definition: qgsfeatureid.h:26
virtual bool closeMatch(QgsGeometryCheckError *) const
Check if this error is almost equal to other.
CheckType
The type of a check.
A geometry is the spatial representation of a feature.
Definition: qgsgeometry.h:111
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.
An error produced by a QgsGeometryGapCheck.
Utility class for identifying a unique vertex within a geometry.
#define SIP_SKIP
Definition: qgis_sip.h:119
virtual QString id() const =0
Returns an id for this check.
This class implements a geometry check.
ResolutionMethod
Resolution methods for geometry gap checks.
QgsGeometryCheck::CheckType checkType() const override
Returns the check type.
A list of layers and feature ids for each of these layers.
virtual QIcon icon() const
Returns an icon that should be shown for this kind of error.
const QMap< QString, QgsFeatureIds > & neighbors() const
A map of layers and feature ids of the neighbors of the gap.
virtual QMap< QString, QgsFeatureIds > involvedFeatures() const
Returns a list of involved features.
QMap< QString, QMap< QgsFeatureId, QList< QgsGeometryCheck::Change > > > Changes
A collection of changes.
virtual QString description() const =0
Returns a human readable description for this check.
virtual QgsRectangle affectedAreaBBox() const
The bounding box of the affected area of the error.
virtual void fixError(const QMap< QString, QgsFeaturePool *> &featurePools, QgsGeometryCheckError *error, int method, const QMap< QString, int > &mergeAttributeIndices, Changes &changes) const
Fix the error error with the specified method.
virtual bool handleChanges(const QgsGeometryCheck::Changes &changes)
Apply a list of changes.
virtual QStringList resolutionMethods() const =0
Returns a list of descriptions for available resolutions for errors.
virtual QgsGeometryCheck::Flags flags() const
Flags for this geometry check.
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.
Represents a vector layer which manages a vector based data sets.
virtual bool isEqual(QgsGeometryCheckError *other) const
Check if this error is equal to other.
Merge the gap with the polygon with the longest shared edge.