Base class for geometry checks for a single geometry without any context of the layer or other layers in the project. Classic examples are validity checks like self-intersection. More...
#include <qgssinglegeometrycheck.h>
Inheritance diagram for QgsSingleGeometryCheck:
Public Member Functions | |
| QgsSingleGeometryCheck (const QgsGeometryCheckContext *context, const QVariantMap &configuration) | |
| Creates a new single geometry check. More... | |
| void | collectErrors (const QMap< QString, QgsFeaturePool * > &featurePools, QList< QgsGeometryCheckError * > &errors, QStringList &messages, QgsFeedback *feedback=nullptr, const QgsGeometryCheck::LayerFeatureIds &ids=QgsGeometryCheck::LayerFeatureIds()) const FINAL |
| The main worker method. More... | |
| virtual QList< QgsSingleGeometryCheckError * > | processGeometry (const QgsGeometry &geometry) const =0 |
| Check the geometry for errors. More... | |
 Public Member Functions inherited from QgsGeometryCheck | |
| QgsGeometryCheck (const QgsGeometryCheckContext *context, const QVariantMap &configuration) | |
| Create a new geometry check. More... | |
| virtual | ~QgsGeometryCheck ()=default |
| virtual QList< QgsGeometryCheckResolutionMethod > | availableResolutionMethods () const |
| Returns a list of available resolution methods. More... | |
| virtual CheckType | checkType () const =0 |
| Returns the check type. More... | |
| virtual QList< QgsWkbTypes::GeometryType > | compatibleGeometryTypes () const =0 |
| A list of geometry types for which this check can be performed. More... | |
| template<class T > | |
| T | configurationValue (const QString &name, const QVariant &defaultValue=QVariant()) |
| Returns the configuration value with the name, saved in the QGIS settings for this geometry check. More... | |
| const QgsGeometryCheckContext * | context () const |
| Returns the context. More... | |
| virtual QString | description () const =0 |
| Returns a human readable description for this check. More... | |
| 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. More... | |
| virtual QgsGeometryCheck::Flags | flags () const |
| Flags for this geometry check. More... | |
| virtual QString | id () const =0 |
| Returns an id for this check. More... | |
| virtual bool | isCompatible (QgsVectorLayer *layer) const |
| Returns if this geometry check is compatible with layer. More... | |
| virtual void | prepare (const QgsGeometryCheckContext *context, const QVariantMap &configuration) |
| Will be run in the main thread before collectErrors is called (which may be run from a background thread). More... | |
| virtual Q_DECL_DEPRECATED QStringList | resolutionMethods () const |
| Returns a list of descriptions for available resolutions for errors. More... | |
Additional Inherited Members | |
| Public Types inherited from QgsGeometryCheck | |
| typedef QMap< QString, QMap< QgsFeatureId, QList< QgsGeometryCheck::Change > > > | Changes |
| A collection of changes. More... | |
| enum | ChangeType { ChangeAdded, ChangeRemoved, ChangeChanged } |
| Description of the type of a change. More... | |
| enum | ChangeWhat { ChangeFeature, ChangePart, ChangeRing, ChangeNode } |
| Description of a change to indicate at which level a change occurred. More... | |
| enum | CheckType { FeatureNodeCheck, FeatureCheck, LayerCheck } |
| The type of a check. More... | |
| enum | Flag { AvailableInValidation = 1 << 1 } |
| Flags for geometry checks. More... | |
| Protected Member Functions inherited from QgsGeometryCheck | |
| QMap< QString, QgsFeatureIds > | allLayerFeatureIds (const QMap< QString, QgsFeaturePool * > &featurePools) const |
| Returns all layers and feature ids. More... | |
| void | deleteFeatureGeometryPart (const QMap< QString, QgsFeaturePool * > &featurePools, const QString &layerId, QgsFeature &feature, int partIdx, Changes &changes) const |
| Deletes a part of a feature geometry. More... | |
| void | deleteFeatureGeometryRing (const QMap< QString, QgsFeaturePool * > &featurePools, const QString &layerId, QgsFeature &feature, int partIdx, int ringIdx, Changes &changes) const |
| Deletes a ring in a feature geometry. More... | |
| void | replaceFeatureGeometryPart (const QMap< QString, QgsFeaturePool * > &featurePools, const QString &layerId, QgsFeature &feature, int partIdx, QgsAbstractGeometry *newPartGeom, Changes &changes) const |
| Replaces a part in a feature geometry. More... | |
| double | scaleFactor (const QPointer< QgsVectorLayer > &layer) const |
| Determines the scale factor of a layer to the map coordinate reference system. More... | |
| Protected Attributes inherited from QgsGeometryCheck | |
| QVariantMap | mConfiguration |
| const QgsGeometryCheckContext * | mContext |
Detailed Description
Base class for geometry checks for a single geometry without any context of the layer or other layers in the project. Classic examples are validity checks like self-intersection.
Subclasses need to implement the processGeometry method.
- Since
- QGIS 3.4
Definition at line 149 of file qgssinglegeometrycheck.h.
Constructor & Destructor Documentation
◆ QgsSingleGeometryCheck()
|
inline |
Creates a new single geometry check.
Definition at line 156 of file qgssinglegeometrycheck.h.
Member Function Documentation
◆ collectErrors()
|
virtual |
The main worker method.
Check all features available from featurePools and write errors found to errors. Other status messages can be written to messages. Progress should be reported to feedback. Only features and layers listed in ids should be checked.
- Since
- QGIS 3.4
Implements QgsGeometryCheck.
Definition at line 22 of file qgssinglegeometrycheck.cpp.
◆ processGeometry()
|
pure virtual |
Check the geometry for errors.
It may make use of configuration options.
Returns a list of QgsSingleGeometryCheckErrors, ownership is transferred to the caller. An empty list is returned for geometries without errors.
- Since
- QGIS 3.4
Implemented in QgsGeometrySelfIntersectionCheck, QgsGeometryIsValidCheck, QgsGeometryTypeCheck, QgsGeometryMultipartCheck, and QgsGeometrySelfContactCheck.
The documentation for this class was generated from the following files:
- /build/qgis-3.26.3+32focal/src/analysis/vector/geometry_checker/qgssinglegeometrycheck.h
- /build/qgis-3.26.3+32focal/src/analysis/vector/geometry_checker/qgssinglegeometrycheck.cpp
