QGIS API Documentation  3.16.0-Hannover (43b64b13f3)
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 
29 class ANALYSIS_EXPORT QgsGeometryFollowBoundariesCheck : public QgsGeometryCheck
30 {
31  Q_DECLARE_TR_FUNCTIONS( QgsGeometryFollowBoundariesCheck )
32  public:
33  QgsGeometryFollowBoundariesCheck( QgsGeometryCheckContext *context, const QVariantMap &configuration, QgsVectorLayer *checkLayer );
35  static QList<QgsWkbTypes::GeometryType> factoryCompatibleGeometryTypes() {return {QgsWkbTypes::PolygonGeometry}; }
36  static bool factoryIsCompatible( QgsVectorLayer *layer ) SIP_SKIP { return factoryCompatibleGeometryTypes().contains( layer->geometryType() ); }
37  QList<QgsWkbTypes::GeometryType> compatibleGeometryTypes() const override { return factoryCompatibleGeometryTypes(); }
38  void collectErrors( const QMap<QString, QgsFeaturePool *> &featurePools, QList<QgsGeometryCheckError *> &errors, QStringList &messages, QgsFeedback *feedback, const LayerFeatureIds &ids = LayerFeatureIds() ) const override;
39  void fixError( const QMap<QString, QgsFeaturePool *> &featurePools, QgsGeometryCheckError *error, int method, const QMap<QString, int> &mergeAttributeIndices, Changes &changes ) const override;
40  Q_DECL_DEPRECATED QStringList resolutionMethods() const override;
41  static QString factoryDescription() { return tr( "Polygon does not follow boundaries" ); }
42  QString description() const override { return factoryDescription(); }
43  static QString factoryId() { return QStringLiteral( "QgsGeometryFollowBoundariesCheck" ); }
44  QString id() const override { return factoryId(); }
45  QgsGeometryCheck::CheckType checkType() const override { return factoryCheckType(); }
46  static QgsGeometryCheck::CheckType factoryCheckType() SIP_SKIP;
47  private:
48  enum ResolutionMethod { NoChange };
49  QgsVectorLayer *mCheckLayer;
50  QgsSpatialIndex *mIndex = nullptr;
51 
54 };
55 
56 #endif // QGSGEOMETRYFOLLOWBOUNDARIESCHECK_H
QgsGeometryFollowBoundariesCheck
Definition: qgsgeometryfollowboundariescheck.h:30
QgsGeometryFollowBoundariesCheck::factoryDescription
static QString factoryDescription()
Definition: qgsgeometryfollowboundariescheck.h:41
QgsGeometryFollowBoundariesCheck::compatibleGeometryTypes
QList< QgsWkbTypes::GeometryType > compatibleGeometryTypes() const override
A list of geometry types for which this check can be performed.
Definition: qgsgeometryfollowboundariescheck.h:37
QgsGeometryCheck::resolutionMethods
virtual Q_DECL_DEPRECATED QStringList resolutionMethods() const
Returns a list of descriptions for available resolutions for errors.
Definition: qgsgeometrycheck.cpp:77
QgsGeometryFollowBoundariesCheck::factoryIsCompatible
static bool factoryIsCompatible(QgsVectorLayer *layer)
Definition: qgsgeometryfollowboundariescheck.h:36
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.
QgsWkbTypes::PolygonGeometry
@ PolygonGeometry
Definition: qgswkbtypes.h:144
QgsGeometryFollowBoundariesCheck::checkType
QgsGeometryCheck::CheckType checkType() const override
Returns the check type.
Definition: qgsgeometryfollowboundariescheck.h:45
QgsGeometryCheck
This class implements a geometry check.
Definition: qgsgeometrycheck.h:92
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
SIP_SKIP
#define SIP_SKIP
Definition: qgis_sip.h:126
QgsGeometryFollowBoundariesCheck::factoryCompatibleGeometryTypes
static QList< QgsWkbTypes::GeometryType > factoryCompatibleGeometryTypes()
Definition: qgsgeometryfollowboundariescheck.h:35
QgsGeometryFollowBoundariesCheck::id
QString id() const override
Returns an id for this check.
Definition: qgsgeometryfollowboundariescheck.h:44
qgsgeometrycheck.h
QgsFeedback
Base class for feedback objects to be used for cancellation of something running in a worker thread.
Definition: qgsfeedback.h:44
QgsGeometryFollowBoundariesCheck::description
QString description() const override
Returns a human readable description for this check.
Definition: qgsgeometryfollowboundariescheck.h:42
QgsGeometryCheckContext
Base configuration for geometry checks.
Definition: qgsgeometrycheckcontext.h:32
QgsSpatialIndex
A spatial index for QgsFeature objects.
Definition: qgsspatialindex.h:68
QgsVectorLayer
Represents a vector layer which manages a vector based data sets.
Definition: qgsvectorlayer.h:387
QgsGeometryCheck::CheckType
CheckType
The type of a check.
Definition: qgsgeometrycheck.h:155
QgsGeometryCheckError
This represents an error reported by a geometry check.
Definition: qgsgeometrycheckerror.h:36
QgsGeometryFollowBoundariesCheck::factoryId
static QString factoryId()
Definition: qgsgeometryfollowboundariescheck.h:43