QGIS API Documentation 3.27.0-Master (a46f227e17)
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"
24
30{
31 public:
33 const QgsGeometryCheckerUtils::LayerFeature &layerFeature,
34 const QgsPointXY &errorLocation,
35 const QgsGeometryCheckerUtils::LayerFeature &containingFeature
36 )
37 : QgsGeometryCheckError( check, layerFeature, errorLocation, QgsVertexId(), containingFeature.id(), ValueOther )
38 , mContainingFeature( qMakePair( containingFeature.layer()->id(), containingFeature.feature().id() ) )
39 { }
40 const QPair<QString, QgsFeatureId> &containingFeature() const { return mContainingFeature; }
41
42 bool isEqual( QgsGeometryCheckError *other ) const override
43 {
44 return other->check() == check() &&
45 other->featureId() == featureId() &&
46 static_cast<QgsGeometryContainedCheckError *>( other )->containingFeature() == containingFeature();
47 }
48
49 private:
50 QPair<QString, QgsFeatureId> mContainingFeature;
51};
52
57class ANALYSIS_EXPORT QgsGeometryContainedCheck : public QgsGeometryCheck
58{
59 Q_DECLARE_TR_FUNCTIONS( QgsGeometryContainedCheck )
60 public:
61 enum ResolutionMethod { Delete, NoChange };
62
63 explicit QgsGeometryContainedCheck( QgsGeometryCheckContext *context, const QVariantMap &configuration )
64 : QgsGeometryCheck( context, configuration ) {}
65 QList<QgsWkbTypes::GeometryType> compatibleGeometryTypes() const override { return factoryCompatibleGeometryTypes(); }
66 void collectErrors( const QMap<QString, QgsFeaturePool *> &featurePools, QList<QgsGeometryCheckError *> &errors, QStringList &messages, QgsFeedback *feedback, const LayerFeatureIds &ids = LayerFeatureIds() ) const override;
67 void fixError( const QMap<QString, QgsFeaturePool *> &featurePools, QgsGeometryCheckError *error, int method, const QMap<QString, int> &mergeAttributeIndices, Changes &changes ) const override;
68 Q_DECL_DEPRECATED QStringList resolutionMethods() const override;
69 QString id() const override { return factoryId(); }
70 QString description() const override { return factoryDescription(); }
71 QgsGeometryCheck::CheckType checkType() const override { return factoryCheckType(); }
72
74 static bool factoryIsCompatible( QgsVectorLayer *layer ) SIP_SKIP { return factoryCompatibleGeometryTypes().contains( layer->geometryType() ); }
75 static QString factoryDescription() { return tr( "Within" ); }
76 static QString factoryId() { return QStringLiteral( "QgsGeometryContainedCheck" ); }
78};
79
80#endif // QGS_GEOMETRY_COVER_CHECK_H
Base class for feedback objects to be used for cancellation of something running in a worker thread.
Definition: qgsfeedback.h:45
Base configuration for geometry checks.
This represents an error reported by a geometry check.
QgsFeatureId featureId() const
The id of the feature on which this error has been detected.
const QgsGeometryCheck * check() const
The geometry check that created this error.
This class implements a geometry check.
CheckType
The type of a check.
@ FeatureCheck
The check controls geometries as a whole.
A layer feature combination to uniquely identify and access a feature in a set of layers.
bool isEqual(QgsGeometryCheckError *other) const override
Check if this error is equal to other.
const QPair< QString, QgsFeatureId > & containingFeature() const
QgsGeometryContainedCheckError(const QgsGeometryCheck *check, const QgsGeometryCheckerUtils::LayerFeature &layerFeature, const QgsPointXY &errorLocation, const QgsGeometryCheckerUtils::LayerFeature &containingFeature)
static QgsGeometryCheck::CheckType factoryCheckType()
static bool factoryIsCompatible(QgsVectorLayer *layer)
QString description() const override
Returns a human readable description for this check.
QString id() const override
Returns an id for this check.
QgsGeometryCheck::CheckType checkType() const override
Returns the check type.
static QList< QgsWkbTypes::GeometryType > factoryCompatibleGeometryTypes()
QgsGeometryContainedCheck(QgsGeometryCheckContext *context, const QVariantMap &configuration)
QList< QgsWkbTypes::GeometryType > compatibleGeometryTypes() const override
A list of geometry types for which this check can be performed.
A class to represent a 2D point.
Definition: qgspointxy.h:59
Represents a vector layer which manages a vector based data sets.
#define SIP_SKIP
Definition: qgis_sip.h:126
Utility class for identifying a unique vertex within a geometry.
Definition: qgsvertexid.h:31