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