Wraps a QgsSingleGeometryError into a standard QgsGeometryCheckError. More...

#include <qgssinglegeometrycheck.h>

Inheritance diagram for QgsGeometryCheckErrorSingle:

Public Member Functions
	QgsGeometryCheckErrorSingle (QgsSingleGeometryCheckError *singleError, const QgsGeometryCheckerUtils::LayerFeature &layerFeature)
	Creates a new error for a QgsSingleGeometryCheck.

bool	handleChanges (const QgsGeometryCheck::Changes &changes) override
	Apply a list of changes.

QgsSingleGeometryCheckError *	singleError () const
	The underlying single error.

Public Member Functions inherited from QgsGeometryCheckError
	QgsGeometryCheckError (const QgsGeometryCheck *check, const QgsGeometryCheckerUtils::LayerFeature &layerFeature, const QgsPointXY &errorLocation, QgsVertexId vidx=QgsVertexId(), const QVariant &value=QVariant(), ValueType valueType=ValueOther)
	Create a new geometry check error with the parent check and for the layerFeature pair at the errorLocation.

virtual	~QgsGeometryCheckError ()=default

virtual QgsRectangle	affectedAreaBBox () const
	The bounding box of the affected area of the error.

const QgsGeometryCheck *	check () const
	The geometry check that created this error.

virtual bool	closeMatch (QgsGeometryCheckError *) const
	Check if this error is almost equal to other.

virtual QgsRectangle	contextBoundingBox () const
	The context of the error.

virtual QString	description () const
	The error description.

QgsFeatureId	featureId () const
	The id of the feature on which this error has been detected.

QgsGeometry	geometry () const
	The geometry of the error in map units.

virtual QIcon	icon () const
	Returns an icon that should be shown for this kind of error.

virtual QMap< QString, QgsFeatureIds >	involvedFeatures () const
	Returns a list of involved features.

virtual bool	isEqual (QgsGeometryCheckError *other) const
	Check if this error is equal to other.

const QString &	layerId () const
	The id of the layer on which this error has been detected.

const QgsPointXY &	location () const
	The location of the error in map units.

const QgsGeometryCheckError &	operator= (const QgsGeometryCheckError &)=delete

QString	resolutionMessage () const
	A message with details, how the error has been resolved.

void	setFixed (int method)
	Set the status to fixed and specify the method that has been used to fix the error.

void	setFixFailed (const QString &reason)
	Set the error status to failed and specify the reason for failure.

void	setObsolete ()
	Set the error status to obsolete.

Status	status () const
	The status of the error.

virtual void	update (const QgsGeometryCheckError *other)
	Update this error with the information from other.

QVariant	value () const
	An additional value for the error.

ValueType	valueType () const
	The type of the value.

const QgsVertexId &	vidx () const
	The id of the affected vertex.

Additional Inherited Members
Public Types inherited from QgsGeometryCheckError
enum	Status { StatusPending , StatusFixFailed , StatusFixed , StatusObsolete }
	The status of an error. More...

enum	ValueType { ValueLength , ValueArea , ValueOther }
	Describes the type of an error value. More...

Protected Member Functions inherited from QgsGeometryCheckError
	QgsGeometryCheckError (const QgsGeometryCheck *check, const QString &layerId, QgsFeatureId featureId, const QgsGeometry &geometry, const QgsPointXY &errorLocation, QgsVertexId vidx=QgsVertexId(), const QVariant &value=QVariant(), ValueType valueType=ValueOther)
	Create a new geometry check error with the parent check and for the layer with layerId and featureId.

Protected Attributes inherited from QgsGeometryCheckError
const QgsGeometryCheck *	mCheck = nullptr

QgsPointXY	mErrorLocation

QgsFeatureId	mFeatureId

QgsGeometry	mGeometry

QString	mLayerId

QString	mResolutionMessage

Status	mStatus

QVariant	mValue

ValueType	mValueType

QgsVertexId	mVidx

Detailed Description

Wraps a QgsSingleGeometryError into a standard QgsGeometryCheckError.

The single error can be obtained via singleError.

Note: This class is a technology preview and unstable API.

Since: QGIS 3.4

Definition at line 115 of file qgssinglegeometrycheck.h.

Constructor & Destructor Documentation

◆ QgsGeometryCheckErrorSingle()

QgsGeometryCheckErrorSingle::QgsGeometryCheckErrorSingle	(	QgsSingleGeometryCheckError *	singleError,
		const QgsGeometryCheckerUtils::LayerFeature &	layerFeature
	)

Creates a new error for a QgsSingleGeometryCheck.

Definition at line 84 of file qgssinglegeometrycheck.cpp.

Member Function Documentation

◆ handleChanges()

bool QgsGeometryCheckErrorSingle::handleChanges ( const QgsGeometryCheck::Changes & changes )

overridevirtual

Apply a list of changes.

Reimplemented from QgsGeometryCheckError.

Definition at line 96 of file qgssinglegeometrycheck.cpp.

◆ singleError()

QgsSingleGeometryCheckError * QgsGeometryCheckErrorSingle::singleError ( ) const

The underlying single error.

Definition at line 91 of file qgssinglegeometrycheck.cpp.

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

/build/qgis-3.41.0+git20241122+3440c17df1d+99sid/src/analysis/vector/geometry_checker/qgssinglegeometrycheck.h
/build/qgis-3.41.0+git20241122+3440c17df1d+99sid/src/analysis/vector/geometry_checker/qgssinglegeometrycheck.cpp