Checks for gaps between neighbouring polygons. More...

#include <qgsgeometrygapcheck.h>

Inheritance diagram for QgsGeometryGapCheck:

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.

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.

QList< QgsGeometryCheckResolutionMethod >	availableResolutionMethods () const override
	Returns a list of available resolution methods.

QgsGeometryCheck::CheckType	checkType () const override
	Returns the check type.

void	collectErrors (const QMap< QString, QgsFeaturePool * > &featurePools, QList< QgsGeometryCheckError * > &errors, QStringList &messages, QgsFeedback *feedback, const LayerFeatureIds &ids=LayerFeatureIds()) const override
	The main worker method.

QList< Qgis::GeometryType >	compatibleGeometryTypes () const override
	A list of geometry types for which this check can be performed.

QString	description () const override
	Returns a human readable description for this check.

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.

QgsGeometryCheck::Flags	flags () const override
	Flags for this geometry check.

QString	id () const override
	Returns an id for this check.

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).

Q_DECL_DEPRECATED QStringList	resolutionMethods () const override
	Returns a list of descriptions for available resolutions for errors.

Public Member Functions inherited from QgsGeometryCheck
	QgsGeometryCheck (const QgsGeometryCheckContext *context, const QVariantMap &configuration)
	Create a new geometry check.

virtual	~QgsGeometryCheck ()=default

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.

const QgsGeometryCheckContext *	context () const
	Returns the context.

virtual bool	isCompatible (QgsVectorLayer *layer) const
	Returns if this geometry check is compatible with layer.

Additional Inherited Members
Protected Member Functions inherited from QgsGeometryCheck
QMap< QString, QgsFeatureIds >	allLayerFeatureIds (const QMap< QString, QgsFeaturePool * > &featurePools) const
	Returns all layers and feature ids.

void	deleteFeatureGeometryPart (const QMap< QString, QgsFeaturePool * > &featurePools, const QString &layerId, QgsFeature &feature, int partIdx, Changes &changes) const
	Deletes a part of a feature geometry.

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.

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.

double	scaleFactor (const QPointer< QgsVectorLayer > &layer) const
	Determines the scale factor of a layer to the map coordinate reference system.

Protected Attributes inherited from QgsGeometryCheck
QVariantMap	mConfiguration

const QgsGeometryCheckContext *	mContext

Detailed Description

Checks for gaps between neighbouring polygons.

Since: QGIS 3.4

Definition at line 89 of file qgsgeometrygapcheck.h.

Member Enumeration Documentation

◆ ResolutionMethod

enum QgsGeometryGapCheck::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 29 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 435 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 54 of file qgsgeometrygapcheck.cpp.

◆ compatibleGeometryTypes()

QList< Qgis::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 452 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 194 of file qgsgeometrygapcheck.cpp.

◆ flags()

QgsGeometryCheck::Flags QgsGeometryGapCheck::flags ( ) const

overridevirtual

Flags for this geometry check.

Reimplemented from QgsGeometryCheck.

Definition at line 462 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 457 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 35 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 424 of file qgsgeometrygapcheck.cpp.

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

/build/qgis-3.34.0+99sid/src/analysis/vector/geometry_checker/qgsgeometrygapcheck.h
/build/qgis-3.34.0+99sid/src/analysis/vector/geometry_checker/qgsgeometrygapcheck.cpp

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ ResolutionMethod

Constructor & Destructor Documentation

◆ QgsGeometryGapCheck()

Member Function Documentation

◆ availableResolutionMethods()

◆ checkType()

◆ collectErrors()

◆ compatibleGeometryTypes()

◆ description()

◆ fixError()

◆ flags()

◆ id()

◆ prepare()

◆ resolutionMethods()