A contained check. More...

#include <qgsgeometrycontainedcheck.h>

Inheritance diagram for QgsGeometryContainedCheck:

Public Types
enum	ResolutionMethod { Delete , NoChange }

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

typedef QFlags< Flag >	Flags

Public Member Functions
	QgsGeometryContainedCheck (QgsGeometryCheckContext *context, const QVariantMap &configuration)

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.

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

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

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

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 QgsGeometryCheck::Flags	flags () const
	Flags for this geometry check.

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

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

Static Public Member Functions
static QgsGeometryCheck::CheckType	factoryCheckType ()

static QList< Qgis::GeometryType >	factoryCompatibleGeometryTypes ()

static QString	factoryDescription ()

static QString	factoryId ()

static bool	factoryIsCompatible (QgsVectorLayer *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

A contained check.

Definition at line 51 of file qgsgeometrycontainedcheck.h.

Member Enumeration Documentation

◆ ResolutionMethod

enum QgsGeometryContainedCheck::ResolutionMethod

Enumerator
Delete
NoChange

Definition at line 55 of file qgsgeometrycontainedcheck.h.

Constructor & Destructor Documentation

◆ QgsGeometryContainedCheck()

QgsGeometryContainedCheck::QgsGeometryContainedCheck	(	QgsGeometryCheckContext *	context,
		const QVariantMap &	configuration
	)

inlineexplicit

Definition at line 61 of file qgsgeometrycontainedcheck.h.

Member Function Documentation

◆ checkType()

QgsGeometryCheck::CheckType QgsGeometryContainedCheck::checkType ( ) const

inlineoverridevirtual

Returns the check type.

Since: QGIS 3.4

Implements QgsGeometryCheck.

Definition at line 69 of file qgsgeometrycontainedcheck.h.

◆ collectErrors()

void QgsGeometryContainedCheck::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 23 of file qgsgeometrycontainedcheck.cpp.

◆ compatibleGeometryTypes()

QList< Qgis::GeometryType > QgsGeometryContainedCheck::compatibleGeometryTypes ( ) const

inlineoverridevirtual

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

Since: QGIS 3.4

Implements QgsGeometryCheck.

Definition at line 63 of file qgsgeometrycontainedcheck.h.

◆ description()

QString QgsGeometryContainedCheck::description ( ) const

inlineoverridevirtual

Returns a human readable description for this check.

Since: QGIS 3.4

Implements QgsGeometryCheck.

Definition at line 68 of file qgsgeometrycontainedcheck.h.

◆ factoryCheckType()

static QgsGeometryCheck::CheckType QgsGeometryContainedCheck::factoryCheckType ( )

inlinestatic

Definition at line 75 of file qgsgeometrycontainedcheck.h.

◆ factoryCompatibleGeometryTypes()

static QList< Qgis::GeometryType > QgsGeometryContainedCheck::factoryCompatibleGeometryTypes ( )

inlinestatic

Definition at line 71 of file qgsgeometrycontainedcheck.h.

◆ factoryDescription()

static QString QgsGeometryContainedCheck::factoryDescription ( )

inlinestatic

Definition at line 73 of file qgsgeometrycontainedcheck.h.

◆ factoryId()

static QString QgsGeometryContainedCheck::factoryId ( )

inlinestatic

Definition at line 74 of file qgsgeometrycontainedcheck.h.

◆ factoryIsCompatible()

static bool QgsGeometryContainedCheck::factoryIsCompatible ( QgsVectorLayer * layer )

inlinestatic

Definition at line 72 of file qgsgeometrycontainedcheck.h.

◆ fixError()

void QgsGeometryContainedCheck::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 63 of file qgsgeometrycontainedcheck.cpp.

◆ id()

QString QgsGeometryContainedCheck::id ( ) const

inlineoverridevirtual

Returns an id for this check.

Since: QGIS 3.4

Implements QgsGeometryCheck.

Definition at line 67 of file qgsgeometrycontainedcheck.h.

◆ resolutionMethods()

QStringList QgsGeometryContainedCheck::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:: QGIS 3.12. Use availableResolutionMethods() instead.

Since: QGIS 3.4

Reimplemented from QgsGeometryCheck.

Definition at line 107 of file qgsgeometrycontainedcheck.cpp.

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

/build/qgis-3.41.0+git20241214+cea29feecf2+99sid/src/analysis/vector/geometry_checker/qgsgeometrycontainedcheck.h
/build/qgis-3.41.0+git20241214+cea29feecf2+99sid/src/analysis/vector/geometry_checker/qgsgeometrycontainedcheck.cpp

Public Types

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ ResolutionMethod

Constructor & Destructor Documentation

◆ QgsGeometryContainedCheck()

Member Function Documentation

◆ checkType()

◆ collectErrors()

◆ compatibleGeometryTypes()

◆ description()

◆ factoryCheckType()

◆ factoryCompatibleGeometryTypes()

◆ factoryDescription()

◆ factoryId()

◆ factoryIsCompatible()

◆ fixError()

◆ id()

◆ resolutionMethods()