QGIS API Documentation  3.25.0-Master (dec16ba68b)
Public Types | Public Member Functions | List of all members
QgsGeometryGapCheck Class Reference

Checks for gaps between neighbouring polygons. More...

#include <qgsgeometrygapcheck.h>

Inheritance diagram for QgsGeometryGapCheck:
Inheritance graph
[legend]

Public Types

enum  ResolutionMethod {
  MergeLongestEdge , NoChange , AddToAllowedGaps , CreateNewFeature ,
  MergeLargestArea
}
 Resolution methods for geometry gap checks. More...
 
- 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...
 

Public Member Functions

 QgsGeometryGapCheck (const QgsGeometryCheckContext *context, const QVariantMap &configuration)
 The configuration accepts a "gapThreshold" key which specifies the maximum gap size in squared map units. More...
 
QList< QgsGeometryCheckResolutionMethodavailableResolutionMethods () const override
 Returns a list of available resolution methods. More...
 
QgsGeometryCheck::CheckType checkType () const override
 Returns the check type. More...
 
void collectErrors (const QMap< QString, QgsFeaturePool * > &featurePools, QList< QgsGeometryCheckError * > &errors, QStringList &messages, QgsFeedback *feedback, const LayerFeatureIds &ids=LayerFeatureIds()) const override
 The main worker method. More...
 
QList< QgsWkbTypes::GeometryTypecompatibleGeometryTypes () const override
 A list of geometry types for which this check can be performed. More...
 
QString description () const override
 Returns a human readable description for this check. More...
 
void fixError (const QMap< QString, QgsFeaturePool * > &featurePools, QgsGeometryCheckError *error, int method, const QMap< QString, int > &mergeAttributeIndices, Changes &changes) const override
 Fixes the error error with the specified method. More...
 
QgsGeometryCheck::Flags flags () const override
 Flags for this geometry check. More...
 
QString id () const override
 Returns an id for this check. More...
 
void prepare (const QgsGeometryCheckContext *context, const QVariantMap &configuration) override
 Will be run in the main thread before collectErrors is called (which may be run from a background thread). More...
 
Q_DECL_DEPRECATED QStringList resolutionMethods () const override
 Returns a list of descriptions for available resolutions 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
 
template<class 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 QgsGeometryCheckContextcontext () const
 Returns the context. More...
 
virtual bool isCompatible (QgsVectorLayer *layer) const
 Returns if this geometry check is compatible with layer. More...
 

Additional Inherited Members

- Protected Member Functions inherited from QgsGeometryCheck
QMap< QString, QgsFeatureIdsallLayerFeatureIds (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 QgsGeometryCheckContextmContext
 

Detailed Description

Checks for gaps between neighbouring polygons.

Since
QGIS 3.4

Definition at line 89 of file qgsgeometrygapcheck.h.

Member Enumeration Documentation

◆ ResolutionMethod

Resolution methods for geometry gap checks.

Enumerator
MergeLongestEdge 

Merge the gap with the polygon with the longest shared edge.

NoChange 

Do not handle the error.

AddToAllowedGaps 

Add gap geometry to allowed gaps layer.

CreateNewFeature 

Create a new feature with the gap geometry.

MergeLargestArea 

Merge with neighbouring polygon with largest area.

Definition at line 96 of file qgsgeometrygapcheck.h.

Constructor & Destructor Documentation

◆ QgsGeometryGapCheck()

QgsGeometryGapCheck::QgsGeometryGapCheck ( const QgsGeometryCheckContext context,
const QVariantMap &  configuration 
)
explicit

The configuration accepts a "gapThreshold" key which specifies the maximum gap size in squared map units.

Any gaps which are larger than this area are accepted. If "gapThreshold" is set to 0, the check is disabled.

Definition at line 31 of file qgsgeometrygapcheck.cpp.

Member Function Documentation

◆ availableResolutionMethods()

QList< QgsGeometryCheckResolutionMethod > QgsGeometryGapCheck::availableResolutionMethods ( ) const
overridevirtual

Returns a list of available resolution methods.

Since
QGIS 3.12

Reimplemented from QgsGeometryCheck.

Definition at line 437 of file qgsgeometrygapcheck.cpp.

◆ checkType()

QgsGeometryCheck::CheckType QgsGeometryGapCheck::checkType ( ) const
inlineoverridevirtual

Returns the check type.

Since
QGIS 3.4

Implements QgsGeometryCheck.

Definition at line 126 of file qgsgeometrygapcheck.h.

◆ collectErrors()

void QgsGeometryGapCheck::collectErrors ( const QMap< QString, QgsFeaturePool * > &  featurePools,
QList< QgsGeometryCheckError * > &  errors,
QStringList &  messages,
QgsFeedback feedback,
const LayerFeatureIds ids = LayerFeatureIds() 
) const
overridevirtual

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 56 of file qgsgeometrygapcheck.cpp.

◆ compatibleGeometryTypes()

QList<QgsWkbTypes::GeometryType> QgsGeometryGapCheck::compatibleGeometryTypes ( ) const
inlineoverridevirtual

A list of geometry types for which this check can be performed.

Since
QGIS 3.4

Implements QgsGeometryCheck.

Definition at line 116 of file qgsgeometrygapcheck.h.

◆ description()

QString QgsGeometryGapCheck::description ( ) const
overridevirtual

Returns a human readable description for this check.

Since
QGIS 3.4

Implements QgsGeometryCheck.

Definition at line 454 of file qgsgeometrygapcheck.cpp.

◆ fixError()

void QgsGeometryGapCheck::fixError ( const QMap< QString, QgsFeaturePool * > &  featurePools,
QgsGeometryCheckError error,
int  method,
const QMap< QString, int > &  mergeAttributeIndices,
Changes changes 
) const
overridevirtual

Fixes the error error with the specified method.

Is executed on the main thread.

See also
availableResolutionMethods()
Since
QGIS 3.4

Reimplemented from QgsGeometryCheck.

Definition at line 196 of file qgsgeometrygapcheck.cpp.

◆ flags()

QgsGeometryCheck::Flags QgsGeometryGapCheck::flags ( ) const
overridevirtual

Flags for this geometry check.

Reimplemented from QgsGeometryCheck.

Definition at line 464 of file qgsgeometrygapcheck.cpp.

◆ id()

QString QgsGeometryGapCheck::id ( ) const
overridevirtual

Returns an id for this check.

Since
QGIS 3.4

Implements QgsGeometryCheck.

Definition at line 459 of file qgsgeometrygapcheck.cpp.

◆ prepare()

void QgsGeometryGapCheck::prepare ( const QgsGeometryCheckContext context,
const QVariantMap &  configuration 
)
overridevirtual

Will be run in the main thread before collectErrors is called (which may be run from a background thread).

Since
QGIS 3.10

Reimplemented from QgsGeometryCheck.

Definition at line 37 of file qgsgeometrygapcheck.cpp.

◆ resolutionMethods()

QStringList QgsGeometryGapCheck::resolutionMethods ( ) const
overridevirtual

Returns a list of descriptions for available resolutions for errors.

The index will be passed as method to

See also
fixError().
Deprecated:
since QGIS 3.12, use availableResolutionMethods() instead
Since
QGIS 3.4

Reimplemented from QgsGeometryCheck.

Definition at line 426 of file qgsgeometrygapcheck.cpp.


The documentation for this class was generated from the following files: