QGIS API Documentation 3.41.0-Master (af5edcb665c)
Loading...
Searching...
No Matches
qgssinglegeometrycheck.h
Go to the documentation of this file.
1/***************************************************************************
2 qgssinglegeometrycheck.h
3 --------------------------------------
4Date : 6.9.2018
5Copyright : (C) 2018 by Matthias Kuhn
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#ifndef QGSSINGLEGEOMETRYCHECK_H
17#define QGSSINGLEGEOMETRYCHECK_H
18
19#include <QList>
20#include <QCoreApplication>
21
22#include "qgsgeometry.h"
23#include "qgsgeometrycheck.h"
25
26#include "qgis_analysis.h"
27
28class QgsFeature;
30
39class ANALYSIS_EXPORT QgsSingleGeometryCheckError
40{
41 public:
45 QgsSingleGeometryCheckError( const QgsSingleGeometryCheck *check, const QgsGeometry &geometry, const QgsGeometry &errorLocation, const QgsVertexId &vertexId = QgsVertexId() )
46 : mCheck( check )
47 , mGeometry( geometry )
48 , mErrorLocation( errorLocation )
49 , mVertexId( vertexId )
50 {}
51
52 virtual ~QgsSingleGeometryCheckError() = default;
53
58 virtual void update( const QgsSingleGeometryCheckError *other );
59
65 virtual bool isEqual( const QgsSingleGeometryCheckError *other ) const;
66
70 virtual bool handleChanges( const QList<QgsGeometryCheck::Change> &changes ) SIP_SKIP;
71
75 virtual QString description() const;
76
82 const QgsSingleGeometryCheck *check() const;
83
89 QgsGeometry errorLocation() const;
90
96 QgsVertexId vertexId() const;
97
98 protected:
99 const QgsSingleGeometryCheck *mCheck = nullptr;
103};
104
115{
116 public:
121
125 QgsSingleGeometryCheckError *singleError() const;
126
127 bool handleChanges( const QgsGeometryCheck::Changes &changes ) override SIP_SKIP;
128
129 private:
130#ifdef SIP_RUN
132#endif
133
134 QgsSingleGeometryCheckError *mError = nullptr;
135};
136
147class ANALYSIS_EXPORT QgsSingleGeometryCheck : public QgsGeometryCheck
148{
149 public:
153 QgsSingleGeometryCheck( const QgsGeometryCheckContext *context, const QVariantMap &configuration )
154 : QgsGeometryCheck( context, configuration )
155 {}
156
157 void collectErrors( const QMap<QString, QgsFeaturePool *> &featurePools, QList<QgsGeometryCheckError *> &errors, QStringList &messages, QgsFeedback *feedback = nullptr, const QgsGeometryCheck::LayerFeatureIds &ids = QgsGeometryCheck::LayerFeatureIds() ) const FINAL;
158
167 virtual QList<QgsSingleGeometryCheckError *> processGeometry( const QgsGeometry &geometry ) const = 0;
168
169 private:
175 QgsGeometryCheckErrorSingle *convertToGeometryCheckError( QgsSingleGeometryCheckError *singleGeometryCheckError, const QgsGeometryCheckerUtils::LayerFeature &layerFeature ) const;
176};
177
178#endif // QGSSINGLEGEOMETRYCHECK_H
The feature class encapsulates a single feature including its unique ID, geometry and a list of field...
Definition qgsfeature.h:58
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.
Wraps a QgsSingleGeometryError into a standard QgsGeometryCheckError.
This represents an error reported by a geometry check.
This class implements a geometry check.
QMap< QString, QMap< QgsFeatureId, QList< QgsGeometryCheck::Change > > > Changes
A collection of changes.
A layer feature combination to uniquely identify and access a feature in a set of layers.
Contains utilities required for geometry checks.
A geometry is the spatial representation of a feature.
An error from a QgsSingleGeometryCheck.
virtual ~QgsSingleGeometryCheckError()=default
QgsSingleGeometryCheckError(const QgsSingleGeometryCheck *check, const QgsGeometry &geometry, const QgsGeometry &errorLocation, const QgsVertexId &vertexId=QgsVertexId())
Creates a new single geometry check error.
Base class for geometry checks for a single geometry without any context of the layer or other layers...
QgsSingleGeometryCheck(const QgsGeometryCheckContext *context, const QVariantMap &configuration)
Creates a new single geometry check.
#define SIP_SKIP
Definition qgis_sip.h:126
#define FINAL
Definition qgis_sip.h:242
void CPL_STDCALL collectErrors(CPLErr, int, const char *msg)
A list of layers and feature ids for each of these layers.
Utility class for identifying a unique vertex within a geometry.
Definition qgsvertexid.h:30