QGIS API Documentation  3.8.0-Zanzibar (11aff65)
qgsgeometrycontainedcheck.h
Go to the documentation of this file.
1 /***************************************************************************
2  qgsgeometrycontainedcheck.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_COVER_CHECK_H
19 #define QGS_GEOMETRY_COVER_CHECK_H
20 
21 #include "qgsgeometrycheck.h"
22 #include "qgsvectorlayer.h"
23 #include "qgsgeometrycheckerror.h"
24 
29 {
30  public:
32  const QgsGeometryCheckerUtils::LayerFeature &layerFeature,
33  const QgsPointXY &errorLocation,
34  const QgsGeometryCheckerUtils::LayerFeature &containingFeature
35  )
36  : QgsGeometryCheckError( check, layerFeature, errorLocation, QgsVertexId(), containingFeature.id(), ValueOther )
37  , mContainingFeature( qMakePair( containingFeature.layer()->id(), containingFeature.feature().id() ) )
38  { }
39  const QPair<QString, QgsFeatureId> &containingFeature() const { return mContainingFeature; }
40 
41  bool isEqual( QgsGeometryCheckError *other ) const override
42  {
43  return other->check() == check() &&
44  other->featureId() == featureId() &&
45  static_cast<QgsGeometryContainedCheckError *>( other )->containingFeature() == containingFeature();
46  }
47 
48  private:
49  QPair<QString, QgsFeatureId> mContainingFeature;
50 };
51 
55 class ANALYSIS_EXPORT QgsGeometryContainedCheck : public QgsGeometryCheck
56 {
57  public:
58  enum ResolutionMethod { Delete, NoChange };
59 
60  explicit QgsGeometryContainedCheck( QgsGeometryCheckContext *context, const QVariantMap &configuration )
61  : QgsGeometryCheck( context, configuration ) {}
62  QList<QgsWkbTypes::GeometryType> compatibleGeometryTypes() const override { return factoryCompatibleGeometryTypes(); }
63  void collectErrors( const QMap<QString, QgsFeaturePool *> &featurePools, QList<QgsGeometryCheckError *> &errors, QStringList &messages, QgsFeedback *feedback, const LayerFeatureIds &ids = LayerFeatureIds() ) const override;
64  void fixError( const QMap<QString, QgsFeaturePool *> &featurePools, QgsGeometryCheckError *error, int method, const QMap<QString, int> &mergeAttributeIndices, Changes &changes ) const override;
65  QStringList resolutionMethods() const override;
66  QString id() const override { return factoryId(); }
67  QString description() const override { return factoryDescription(); }
68  QgsGeometryCheck::CheckType checkType() const override { return factoryCheckType(); }
69 
71  static bool factoryIsCompatible( QgsVectorLayer *layer ) SIP_SKIP { return factoryCompatibleGeometryTypes().contains( layer->geometryType() ); }
72  static QString factoryDescription() { return tr( "Within" ); }
73  static QString factoryId() { return QStringLiteral( "QgsGeometryContainedCheck" ); }
75 };
76 
77 #endif // QGS_GEOMETRY_COVER_CHECK_H
QgsGeometryContainedCheck(QgsGeometryCheckContext *context, const QVariantMap &configuration)
const QPair< QString, QgsFeatureId > & containingFeature() const
QgsGeometryCheck::CheckType checkType() const override
Returns the check type.
A class to represent a 2D point.
Definition: qgspointxy.h:43
CheckType
The type of a check.
QString id() const override
Returns an id for this check.
bool isEqual(QgsGeometryCheckError *other) const override
Check if this error is equal to other.
Base class for feedback objects to be used for cancellation of something running in a worker thread...
Definition: qgsfeedback.h:44
Base configuration for geometry checks.
static QgsGeometryCheck::CheckType factoryCheckType()
QString description() const override
Returns a human readable description for this check.
static QList< QgsWkbTypes::GeometryType > factoryCompatibleGeometryTypes()
The check controls geometries as a whole.
const QgsGeometryCheck * check() const
The geometry check that created this error.
Utility class for identifying a unique vertex within a geometry.
#define SIP_SKIP
Definition: qgis_sip.h:119
A layer feature combination to uniquely identify and access a feature in a set of layers...
QList< QgsWkbTypes::GeometryType > compatibleGeometryTypes() const override
A list of geometry types for which this check can be performed.
This class implements a geometry check.
QgsGeometryContainedCheckError(const QgsGeometryCheck *check, const QgsGeometryCheckerUtils::LayerFeature &layerFeature, const QgsPointXY &errorLocation, const QgsGeometryCheckerUtils::LayerFeature &containingFeature)
A list of layers and feature ids for each of these layers.
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
Fix the error error with the specified method.
virtual QStringList resolutionMethods() const =0
Returns a list of descriptions for available resolutions for errors.
QgsFeatureId featureId() const
The id of the feature on which this error has been detected.
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.
static bool factoryIsCompatible(QgsVectorLayer *layer)