QGIS API Documentation  3.17.0-Master (df2c9ff931)
qgsgeometryareacheck.h
Go to the documentation of this file.
1 /***************************************************************************
2  qgsgeometryareacheck.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_AREA_CHECK_H
19 #define QGS_GEOMETRY_AREA_CHECK_H
20 
21 #include "qgsgeometrycheck.h"
22 
23 class QgsSurface;
24 
28 class ANALYSIS_EXPORT QgsGeometryAreaCheck : public QgsGeometryCheck
29 {
30  Q_DECLARE_TR_FUNCTIONS( QgsGeometryAreaCheck )
31  public:
32  enum ResolutionMethod { MergeLongestEdge, MergeLargestArea, MergeIdenticalAttribute, Delete, NoChange };
33 
34  QgsGeometryAreaCheck( QgsGeometryCheckContext *context, const QVariantMap &configuration )
35  : QgsGeometryCheck( context, configuration )
36  , mAreaThreshold( configurationValue<double>( "areaThreshold" ) )
37  {}
38  QList<QgsWkbTypes::GeometryType> compatibleGeometryTypes() const override { return factoryCompatibleGeometryTypes(); }
39  void collectErrors( const QMap<QString, QgsFeaturePool *> &featurePools, QList<QgsGeometryCheckError *> &errors, QStringList &messages, QgsFeedback *feedback, const LayerFeatureIds &ids = LayerFeatureIds() ) const override;
40  void fixError( const QMap<QString, QgsFeaturePool *> &featurePools, QgsGeometryCheckError *error, int method, const QMap<QString, int> &mergeAttributeIndices, Changes &changes ) const override;
41  Q_DECL_DEPRECATED QStringList resolutionMethods() const override;
42  QString id() const override { return factoryId(); }
43  QgsGeometryCheck::CheckType checkType() const override { return factoryCheckType(); }
44 
45  static QList<QgsWkbTypes::GeometryType> factoryCompatibleGeometryTypes() {return {QgsWkbTypes::PolygonGeometry}; }
46  static bool factoryIsCompatible( QgsVectorLayer *layer ) SIP_SKIP { return factoryCompatibleGeometryTypes().contains( layer->geometryType() ); }
47  static QString factoryDescription() { return tr( "Minimal area" ); }
48  QString description() const override { return factoryDescription(); }
49  static QString factoryId() { return QStringLiteral( "QgsGeometryAreaCheck" ); }
51 
52  private:
53  virtual bool checkThreshold( double layerToMapUnits, const QgsAbstractGeometry *geom, double &value ) const;
54  bool mergeWithNeighbor( const QMap<QString, QgsFeaturePool *> &featurePools, const QString &layerId, QgsFeature &feature, int partIdx, int method, int mergeAttributeIndex, Changes &changes, QString &errMsg ) const;
55 
56  const double mAreaThreshold;
57 };
58 
59 #endif // QGS_GEOMETRY_AREA_CHECK_H
QList< QgsWkbTypes::GeometryType > compatibleGeometryTypes() const override
A list of geometry types for which this check can be performed.
static QString factoryDescription()
QgsGeometryCheck::CheckType checkType() const override
Returns the check type.
static QList< QgsWkbTypes::GeometryType > factoryCompatibleGeometryTypes()
Base configuration for geometry checks.
CheckType
The type of a check.
The feature class encapsulates a single feature including its id, geometry and a list of field/values...
Definition: qgsfeature.h:55
virtual Q_DECL_DEPRECATED QStringList resolutionMethods() const
Returns a list of descriptions for available resolutions for errors.
Base class for feedback objects to be used for cancellation of something running in a worker thread...
Definition: qgsfeedback.h:43
The check controls geometries as a whole.
static bool factoryIsCompatible(QgsVectorLayer *layer)
#define SIP_SKIP
Definition: qgis_sip.h:126
This class implements a geometry check.
Abstract base class for all geometries.
static QgsGeometryCheck::CheckType factoryCheckType()
A list of layers and feature ids for each of these layers.
QString id() const override
Returns an id for this check.
QMap< QString, QMap< QgsFeatureId, QList< QgsGeometryCheck::Change > > > Changes
A collection of changes.
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.
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.
QgsGeometryAreaCheck(QgsGeometryCheckContext *context, const QVariantMap &configuration)
QString description() const override
Returns a human readable description for this check.
static QString factoryId()