QGIS API Documentation  3.8.0-Zanzibar (11aff65)
Public Member Functions | List of all members
QgsGeometryDuplicateCheckError Class Reference

#include <qgsgeometryduplicatecheck.h>

Inheritance diagram for QgsGeometryDuplicateCheckError:
Inheritance graph
[legend]

Public Member Functions

 QgsGeometryDuplicateCheckError (const QgsGeometryCheck *check, const QgsGeometryCheckerUtils::LayerFeature &layerFeature, const QgsPointXY &errorLocation, const QMap< QString, QgsFeaturePool *> &featurePools, const QMap< QString, QList< QgsFeatureId >> &duplicates)
 
QMap< QString, QList< QgsFeatureId > > duplicates () const
 
bool isEqual (QgsGeometryCheckError *other) const override
 Check if this error is equal to other. More...
 
- 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. More...
 
virtual ~QgsGeometryCheckError ()=default
 
virtual QgsRectangle affectedAreaBBox () const
 The bounding box of the affected area of the error. More...
 
const QgsGeometryCheckcheck () const
 The geometry check that created this error. More...
 
virtual bool closeMatch (QgsGeometryCheckError *) const
 Check if this error is almost equal to other. More...
 
virtual QString description () const
 The error description. More...
 
QgsFeatureId featureId () const
 The id of the feature on which this error has been detected. More...
 
QgsGeometry geometry () const
 The geometry of the error in map units. More...
 
virtual bool handleChanges (const QgsGeometryCheck::Changes &changes)
 Apply a list of changes. More...
 
virtual QIcon icon () const
 Returns an icon that should be shown for this kind of error. More...
 
virtual QMap< QString, QgsFeatureIdsinvolvedFeatures () const
 Returns a list of involved features. More...
 
const QString & layerId () const
 The id of the layer on which this error has been detected. More...
 
const QgsPointXYlocation () const
 The location of the error in map units. More...
 
const QgsGeometryCheckErroroperator= (const QgsGeometryCheckError &)=delete
 
QString resolutionMessage () const
 A message with details, how the error has been resolved. More...
 
void setFixed (int method)
 Set the status to fixed and specify the method that has been used to fix the error. More...
 
void setFixFailed (const QString &reason)
 Set the error status to failed and specify the reason for failure. More...
 
void setObsolete ()
 Set the error status to obsolete. More...
 
Status status () const
 The status of the error. More...
 
virtual void update (const QgsGeometryCheckError *other)
 Update this error with the information from other. More...
 
QVariant value () const
 An additional value for the error. More...
 
ValueType valueType () const
 The type of the value. More...
 
const QgsVertexIdvidx () const
 The id of the affected vertex. More...
 

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. More...
 
- Protected Attributes inherited from QgsGeometryCheckError
const QgsGeometryCheckmCheck = nullptr
 
QgsPointXY mErrorLocation
 
QgsFeatureId mFeatureId
 
QgsGeometry mGeometry
 
QString mLayerId
 
QString mResolutionMessage
 
Status mStatus
 
QVariant mValue
 
ValueType mValueType
 
QgsVertexId mVidx
 

Detailed Description

Definition at line 28 of file qgsgeometryduplicatecheck.h.

Constructor & Destructor Documentation

◆ QgsGeometryDuplicateCheckError()

QgsGeometryDuplicateCheckError::QgsGeometryDuplicateCheckError ( const QgsGeometryCheck check,
const QgsGeometryCheckerUtils::LayerFeature layerFeature,
const QgsPointXY errorLocation,
const QMap< QString, QgsFeaturePool *> &  featurePools,
const QMap< QString, QList< QgsFeatureId >> &  duplicates 
)
inline

Definition at line 31 of file qgsgeometryduplicatecheck.h.

Member Function Documentation

◆ duplicates()

QMap<QString, QList<QgsFeatureId> > QgsGeometryDuplicateCheckError::duplicates ( ) const
inline

Definition at line 39 of file qgsgeometryduplicatecheck.h.

◆ isEqual()

bool QgsGeometryDuplicateCheckError::isEqual ( QgsGeometryCheckError other) const
inlineoverridevirtual

Check if this error is equal to other.

Is reimplemented by subclasses with additional information, comparison of base information is done in parent class.

Reimplemented from QgsGeometryCheckError.

Definition at line 41 of file qgsgeometryduplicatecheck.h.


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