QGIS API Documentation  3.16.0-Hannover (43b64b13f3)
qgsgeometrypointinpolygoncheck.h
Go to the documentation of this file.
1 /***************************************************************************
2  qgsgeometrypointinpolygoncheck.h
3  ---------------------
4  begin : June 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 QGSGEOMETRYPOINTINPOLYGONCHECK_H
19 #define QGSGEOMETRYPOINTINPOLYGONCHECK_H
20 
21 #include "qgsgeometrycheck.h"
22 
26 class ANALYSIS_EXPORT QgsGeometryPointInPolygonCheck : public QgsGeometryCheck
27 {
28  Q_DECLARE_TR_FUNCTIONS( QgsGeometryPointInPolygonCheck )
29  public:
30  QgsGeometryPointInPolygonCheck( QgsGeometryCheckContext *context, const QVariantMap &configuration )
31  : QgsGeometryCheck( context, configuration )
32  {}
33  static QList<QgsWkbTypes::GeometryType> factoryCompatibleGeometryTypes() {return {QgsWkbTypes::PointGeometry}; }
34  static bool factoryIsCompatible( QgsVectorLayer *layer ) SIP_SKIP { return factoryCompatibleGeometryTypes().contains( layer->geometryType() ); }
35  QList<QgsWkbTypes::GeometryType> compatibleGeometryTypes() const override { return factoryCompatibleGeometryTypes(); }
36  void collectErrors( const QMap<QString, QgsFeaturePool *> &featurePools, QList<QgsGeometryCheckError *> &errors, QStringList &messages, QgsFeedback *feedback, const LayerFeatureIds &ids = LayerFeatureIds() ) const override;
37  void fixError( const QMap<QString, QgsFeaturePool *> &featurePools, QgsGeometryCheckError *error, int method, const QMap<QString, int> &mergeAttributeIndices, Changes &changes ) const override;
38  Q_DECL_DEPRECATED QStringList resolutionMethods() const override;
39  static QString factoryDescription() { return tr( "Point not in polygon" ); }
40  QString description() const override { return factoryDescription(); }
41  static QString factoryId() { return QStringLiteral( "QgsGeometryPointInPolygonCheck" ); }
42  QString id() const override { return factoryId(); }
43  QgsGeometryCheck::CheckType checkType() const override { return factoryCheckType(); }
44  static QgsGeometryCheck::CheckType factoryCheckType() SIP_SKIP;
45 
46  enum ResolutionMethod { NoChange };
47 };
48 
49 #endif // QGSGEOMETRYPOINTINPOLYGONCHECK_H
QgsGeometryPointInPolygonCheck::checkType
QgsGeometryCheck::CheckType checkType() const override
Returns the check type.
Definition: qgsgeometrypointinpolygoncheck.h:43
QgsGeometryPointInPolygonCheck::factoryId
static QString factoryId()
Definition: qgsgeometrypointinpolygoncheck.h:41
QgsGeometryPointInPolygonCheck::QgsGeometryPointInPolygonCheck
QgsGeometryPointInPolygonCheck(QgsGeometryCheckContext *context, const QVariantMap &configuration)
Definition: qgsgeometrypointinpolygoncheck.h:30
QgsGeometryPointInPolygonCheck::id
QString id() const override
Returns an id for this check.
Definition: qgsgeometrypointinpolygoncheck.h:42
QgsGeometryCheck::resolutionMethods
virtual Q_DECL_DEPRECATED QStringList resolutionMethods() const
Returns a list of descriptions for available resolutions for errors.
Definition: qgsgeometrycheck.cpp:77
QgsGeometryPointInPolygonCheck::ResolutionMethod
ResolutionMethod
Definition: qgsgeometrypointinpolygoncheck.h:46
QgsGeometryPointInPolygonCheck::factoryIsCompatible
static bool factoryIsCompatible(QgsVectorLayer *layer)
Definition: qgsgeometrypointinpolygoncheck.h:34
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.
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
qgsgeometrycheck.h
QgsFeedback
Base class for feedback objects to be used for cancellation of something running in a worker thread.
Definition: qgsfeedback.h:44
QgsGeometryPointInPolygonCheck::factoryDescription
static QString factoryDescription()
Definition: qgsgeometrypointinpolygoncheck.h:39
QgsGeometryCheckContext
Base configuration for geometry checks.
Definition: qgsgeometrycheckcontext.h:32
QgsGeometryPointInPolygonCheck::description
QString description() const override
Returns a human readable description for this check.
Definition: qgsgeometrypointinpolygoncheck.h:40
QgsGeometryPointInPolygonCheck::factoryCompatibleGeometryTypes
static QList< QgsWkbTypes::GeometryType > factoryCompatibleGeometryTypes()
Definition: qgsgeometrypointinpolygoncheck.h:33
QgsWkbTypes::PointGeometry
@ PointGeometry
Definition: qgswkbtypes.h:142
QgsGeometryPointInPolygonCheck::compatibleGeometryTypes
QList< QgsWkbTypes::GeometryType > compatibleGeometryTypes() const override
A list of geometry types for which this check can be performed.
Definition: qgsgeometrypointinpolygoncheck.h:35
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
QgsGeometryPointInPolygonCheck
Definition: qgsgeometrypointinpolygoncheck.h:27
QgsGeometryCheckError
This represents an error reported by a geometry check.
Definition: qgsgeometrycheckerror.h:36