QGIS API Documentation
3.14.0-Pi (9f7028fd23)
|
#include <qgsgeometryoverlapcheck.h>
Classes | |
struct | OverlappedFeature |
Public Member Functions | |
QgsGeometryOverlapCheckError (const QgsGeometryCheck *check, const QgsGeometryCheckerUtils::LayerFeature &layerFeature, const QgsGeometry &geometry, const QgsPointXY &errorLocation, const QVariant &value, const QgsGeometryCheckerUtils::LayerFeature &overlappedFeature) | |
Creates a new overlap check error for check and the layerFeature combination. More... | |
bool | closeMatch (QgsGeometryCheckError *other) const override |
Check if this error is almost equal to other. More... | |
QString | description () const override |
The error description. More... | |
bool | handleChanges (const QgsGeometryCheck::Changes &changes) override |
Apply a list of changes. More... | |
QIcon | icon () const override |
Returns an icon that should be shown for this kind of error. More... | |
QMap< QString, QgsFeatureIds > | involvedFeatures () const override |
Returns a list of involved features. More... | |
bool | isEqual (QgsGeometryCheckError *other) const override |
Check if this error is equal to other. More... | |
const OverlappedFeature & | overlappedFeature () const |
Returns the overlapped feature. More... | |
![]() | |
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 QgsGeometryCheck * | check () const |
The geometry check that created this error. More... | |
virtual QgsRectangle | contextBoundingBox () const |
The context of the error. 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... | |
const QString & | layerId () const |
The id of the layer on which this error has been detected. More... | |
const QgsPointXY & | location () const |
The location of the error in map units. More... | |
const QgsGeometryCheckError & | operator= (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 QgsVertexId & | vidx () const |
The id of the affected vertex. More... | |
An error of a QgsGeometryOverlapCheck.
Definition at line 30 of file qgsgeometryoverlapcheck.h.
private QgsGeometryOverlapCheckError::QgsGeometryOverlapCheckError | ( | const QgsGeometryCheck * | check, |
const QgsGeometryCheckerUtils::LayerFeature & | layerFeature, | ||
const QgsGeometry & | geometry, | ||
const QgsPointXY & | errorLocation, | ||
const QVariant & | value, | ||
const QgsGeometryCheckerUtils::LayerFeature & | overlappedFeature | ||
) |
Creates a new overlap check error for check and the layerFeature combination.
The geometry and errorLocation ned to be in map coordinates. The value is the area of the overlapping area in map units. The overlappedFeature provides more details about the overlap.
Definition at line 267 of file qgsgeometryoverlapcheck.cpp.
|
overridevirtual |
Check if this error is almost equal to other.
If this returns true
, it can be used to update existing errors after re-checking.
Reimplemented from QgsGeometryCheckError.
Definition at line 285 of file qgsgeometryoverlapcheck.cpp.
|
overridevirtual |
The error description.
By default the description of the parent check will be returned.
Reimplemented from QgsGeometryCheckError.
Definition at line 304 of file qgsgeometryoverlapcheck.cpp.
|
overridevirtual |
Apply a list of changes.
Reimplemented from QgsGeometryCheckError.
Definition at line 291 of file qgsgeometryoverlapcheck.cpp.
|
overridevirtual |
Returns an icon that should be shown for this kind of error.
Reimplemented from QgsGeometryCheckError.
Definition at line 317 of file qgsgeometryoverlapcheck.cpp.
|
overridevirtual |
Returns a list of involved features.
By default returns an empty map. The map keys are layer ids, the map value is a set of feature ids.
Reimplemented from QgsGeometryCheckError.
Definition at line 309 of file qgsgeometryoverlapcheck.cpp.
|
overridevirtual |
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 274 of file qgsgeometryoverlapcheck.cpp.
|
inline |
Returns the overlapped feature.
Definition at line 70 of file qgsgeometryoverlapcheck.h.