QGIS API Documentation  3.14.0-Pi (9f7028fd23)
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  Q_DECL_DEPRECATED 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
Definition: qgsgeometrycontainedcheck.h:55
QgsGeometryContainedCheck::compatibleGeometryTypes
QList< QgsWkbTypes::GeometryType > compatibleGeometryTypes() const override
A list of geometry types for which this check can be performed.
Definition: qgsgeometrycontainedcheck.h:62
QgsGeometryCheckError::check
const QgsGeometryCheck * check() const
The geometry check that created this error.
Definition: qgsgeometrycheckerror.h:80
QgsGeometryContainedCheckError::QgsGeometryContainedCheckError
QgsGeometryContainedCheckError(const QgsGeometryCheck *check, const QgsGeometryCheckerUtils::LayerFeature &layerFeature, const QgsPointXY &errorLocation, const QgsGeometryCheckerUtils::LayerFeature &containingFeature)
Definition: qgsgeometrycontainedcheck.h:31
QgsGeometryContainedCheck::checkType
QgsGeometryCheck::CheckType checkType() const override
Returns the check type.
Definition: qgsgeometrycontainedcheck.h:68
QgsGeometryCheckError::featureId
QgsFeatureId featureId() const
The id of the feature on which this error has been detected.
Definition: qgsgeometrycheckerror.h:90
QgsGeometryContainedCheckError::isEqual
bool isEqual(QgsGeometryCheckError *other) const override
Check if this error is equal to other.
Definition: qgsgeometrycontainedcheck.h:41
QgsGeometryContainedCheckError::containingFeature
const QPair< QString, QgsFeatureId > & containingFeature() const
Definition: qgsgeometrycontainedcheck.h:39
QgsGeometryCheck::resolutionMethods
virtual Q_DECL_DEPRECATED QStringList resolutionMethods() const
Returns a list of descriptions for available resolutions for errors.
Definition: qgsgeometrycheck.cpp:77
qgsgeometrycheckerror.h
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:143
QgsGeometryCheck
Definition: qgsgeometrycheck.h:91
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
QgsGeometryContainedCheck::factoryCompatibleGeometryTypes
static QList< QgsWkbTypes::GeometryType > factoryCompatibleGeometryTypes()
Definition: qgsgeometrycontainedcheck.h:70
qgsgeometrycheck.h
QgsGeometryContainedCheck::factoryDescription
static QString factoryDescription()
Definition: qgsgeometrycontainedcheck.h:72
QgsGeometryContainedCheck::id
QString id() const override
Returns an id for this check.
Definition: qgsgeometrycontainedcheck.h:66
QgsFeedback
Definition: qgsfeedback.h:43
QgsGeometryContainedCheck::factoryIsCompatible
static bool factoryIsCompatible(QgsVectorLayer *layer)
Definition: qgsgeometrycontainedcheck.h:71
QgsGeometryCheckContext
Definition: qgsgeometrycheckcontext.h:31
QgsGeometryCheckerUtils::LayerFeature
Definition: qgsgeometrycheckerutils.h:51
QgsGeometryContainedCheck::description
QString description() const override
Returns a human readable description for this check.
Definition: qgsgeometrycontainedcheck.h:67
QgsGeometryContainedCheck::QgsGeometryContainedCheck
QgsGeometryContainedCheck(QgsGeometryCheckContext *context, const QVariantMap &configuration)
Definition: qgsgeometrycontainedcheck.h:60
qgsvectorlayer.h
QgsPointXY
Definition: qgspointxy.h:43
QgsWkbTypes::LineGeometry
@ LineGeometry
Definition: qgswkbtypes.h:142
QgsWkbTypes::PointGeometry
@ PointGeometry
Definition: qgswkbtypes.h:141
QgsVectorLayer
Definition: qgsvectorlayer.h:385
QgsGeometryCheck::CheckType
CheckType
The type of a check.
Definition: qgsgeometrycheck.h:155
QgsVertexId
Utility class for identifying a unique vertex within a geometry.
Definition: qgsabstractgeometry.h:1033
QgsGeometryContainedCheck::factoryId
static QString factoryId()
Definition: qgsgeometrycontainedcheck.h:73
QgsGeometryCheck::FeatureCheck
@ FeatureCheck
The check controls geometries as a whole.
Definition: qgsgeometrycheck.h:158
QgsGeometryCheckError
Definition: qgsgeometrycheckerror.h:35
QgsGeometryContainedCheckError
Definition: qgsgeometrycontainedcheck.h:28
QgsGeometryContainedCheck::ResolutionMethod
ResolutionMethod
Definition: qgsgeometrycontainedcheck.h:58
QgsGeometryContainedCheck::factoryCheckType
static QgsGeometryCheck::CheckType factoryCheckType()
Definition: qgsgeometrycontainedcheck.h:74