QGIS API Documentation  3.23.0-Master (c716e02dd3)
qgsgeometryfollowboundariescheck.h
Go to the documentation of this file.
1 /***************************************************************************
2  qgsgeometryfollowboundariescheck.h
3  ---------------------
4  begin : September 2017
5  copyright : (C) 2017 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 QGSGEOMETRYFOLLOWBOUNDARIESCHECK_H
19 #define QGSGEOMETRYFOLLOWBOUNDARIESCHECK_H
20 
21 #include "qgsgeometrycheck.h"
22 
23 class QgsSpatialIndex;
24 
25 
30 class ANALYSIS_EXPORT QgsGeometryFollowBoundariesCheck : public QgsGeometryCheck
31 {
32  Q_DECLARE_TR_FUNCTIONS( QgsGeometryFollowBoundariesCheck )
33  public:
34  QgsGeometryFollowBoundariesCheck( QgsGeometryCheckContext *context, const QVariantMap &configuration, QgsVectorLayer *checkLayer );
36  static QList<QgsWkbTypes::GeometryType> factoryCompatibleGeometryTypes() {return {QgsWkbTypes::PolygonGeometry}; }
37  static bool factoryIsCompatible( QgsVectorLayer *layer ) SIP_SKIP { return factoryCompatibleGeometryTypes().contains( layer->geometryType() ); }
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  static QString factoryDescription() { return tr( "Polygon does not follow boundaries" ); }
43  QString description() const override { return factoryDescription(); }
44  static QString factoryId() { return QStringLiteral( "QgsGeometryFollowBoundariesCheck" ); }
45  QString id() const override { return factoryId(); }
46  QgsGeometryCheck::CheckType checkType() const override { return factoryCheckType(); }
47  static QgsGeometryCheck::CheckType factoryCheckType() SIP_SKIP;
48  private:
49  enum ResolutionMethod { NoChange };
50  QgsVectorLayer *mCheckLayer;
51  QgsSpatialIndex *mIndex = nullptr;
52 
55 };
56 
57 #endif // QGSGEOMETRYFOLLOWBOUNDARIESCHECK_H
Base class for feedback objects to be used for cancellation of something running in a worker thread.
Definition: qgsfeedback.h:45
Base configuration for geometry checks.
This represents an error reported by a geometry check.
This class implements 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.
virtual Q_DECL_DEPRECATED QStringList resolutionMethods() const
Returns a list of descriptions for available resolutions for errors.
CheckType
The type of a check.
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.
QgsGeometryCheck::CheckType checkType() const override
Returns the check type.
QList< QgsWkbTypes::GeometryType > compatibleGeometryTypes() const override
A list of geometry types for which this check can be performed.
static bool factoryIsCompatible(QgsVectorLayer *layer)
static QList< QgsWkbTypes::GeometryType > factoryCompatibleGeometryTypes()
QString id() const override
Returns an id for this check.
QString description() const override
Returns a human readable description for this check.
A spatial index for QgsFeature objects.
Represents a vector layer which manages a vector based data sets.
#define SIP_SKIP
Definition: qgis_sip.h:126