qgsgeometrycheck.h

Go to the documentation of this file.

/***************************************************************************
    qgsgeometrycheck.h
    ---------------------
    begin                : September 2014
    copyright            : (C) 2014 by Sandro Mani / Sourcepole AG
    email                : smani at sourcepole dot ch
 ***************************************************************************
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/
 
#ifndef QGS_GEOMETRY_CHECK_H
#define QGS_GEOMETRY_CHECK_H
 
#include <limits>
 
#include "qgis_analysis.h"
#include "qgsfeature.h"
#include "qgsgeometry.h"
#include "qgsgeometrycheckerutils.h"
#include "qgsgeometrycheckresolutionmethod.h"
#include "qgssettings.h"
#include "qgsvectorlayer.h"
 
#include <QApplication>
#include <QPointer>
#include <QStringList>
 
class QgsGeometryCheckError;
class QgsFeaturePool;

class ANALYSIS_EXPORT QgsGeometryCheck
{
    Q_GADGET
 
  public:
    struct ANALYSIS_EXPORT LayerFeatureIds
    {
        LayerFeatureIds() = default;
        LayerFeatureIds( const QMap<QString, QgsFeatureIds> &idsIn ) SIP_SKIP;
 
        QMap<QString, QgsFeatureIds> ids SIP_SKIP;
 
#ifndef SIP_RUN
        QMap<QString, QgsFeatureIds> toMap() const
        {
          return ids;
        }
 
        bool isEmpty() const
        {
          return ids.isEmpty();
        }
#endif
    };

    enum ChangeWhat
    {
      ChangeFeature, 
      ChangePart,    
      ChangeRing,    
      ChangeNode     
    };

    enum ChangeType
    {
      ChangeAdded,   
      ChangeRemoved, 
      ChangeChanged  
    };

    enum CheckType
    {
      FeatureNodeCheck, 
      FeatureCheck,     
      LayerCheck        
    };

    enum class Result : int
    {
      Success = 0,               
      Canceled = 1,              
      DuplicatedUniqueId = 2,    
      InvalidReferenceLayer = 3, 
      GeometryOverlayError = 4   
    };

    enum Flag SIP_ENUM_BASETYPE( IntFlag )
    {
      AvailableInValidation = 1 << 1 
    };
    Q_DECLARE_FLAGS( Flags, Flag )
    Q_FLAG( Flags )
 
    
    struct Change
    {
        Change() = default;

        Change( QgsGeometryCheck::ChangeWhat _what, QgsGeometryCheck::ChangeType _type, QgsVertexId _vidx = QgsVertexId() )
          : what( _what )
          , type( _type )
          , vidx( _vidx )
        {}

        QgsGeometryCheck::ChangeWhat what = QgsGeometryCheck::ChangeWhat::ChangeFeature;

        QgsGeometryCheck::ChangeType type = QgsGeometryCheck::ChangeType::ChangeAdded;

        QgsVertexId vidx;
 
        // TODO c++20 - replace with = default
        bool operator==( const QgsGeometryCheck::Change &other ) const
        {
          return what == other.what && type == other.type && vidx == other.vidx;
        }
 
        bool operator!=( const QgsGeometryCheck::Change &other ) const
        {
          return !( *this == other );
        }
    };

    typedef QMap<QString, QMap<QgsFeatureId, QList<QgsGeometryCheck::Change>>> Changes;

    QgsGeometryCheck( const QgsGeometryCheckContext *context, const QVariantMap &configuration );
    virtual ~QgsGeometryCheck() = default;

    virtual void prepare( const QgsGeometryCheckContext *context, const QVariantMap &configuration );
 
#ifndef SIP_RUN

    template<class T>
    T configurationValue( const QString &name, const QVariant &defaultValue = QVariant() )
    {
      return mConfiguration.value( name, QgsSettings().value( "/geometry_checker/" + id() + "/" + name, defaultValue ) ).value<T>();
    }
#endif

    virtual bool isCompatible( QgsVectorLayer *layer ) const;

    virtual QList<Qgis::GeometryType> compatibleGeometryTypes() const = 0;

    virtual QgsGeometryCheck::Flags flags() const;

    virtual Result collectErrors( const QMap<QString, QgsFeaturePool *> &featurePools, QList<QgsGeometryCheckError *> &errors SIP_INOUT, QStringList &messages SIP_INOUT, QgsFeedback *feedback, const LayerFeatureIds &ids = QgsGeometryCheck::LayerFeatureIds() ) const;

    virtual void fixError( const QMap<QString, QgsFeaturePool *> &featurePools, QgsGeometryCheckError *error, int method, const QMap<QString, int> &mergeAttributeIndices, Changes &changes SIP_INOUT ) const SIP_SKIP;

    virtual QList<QgsGeometryCheckResolutionMethod> availableResolutionMethods() const;

    Q_DECL_DEPRECATED virtual QStringList resolutionMethods() const SIP_DEPRECATED;

    virtual QString description() const = 0;

    virtual QString id() const = 0;

    virtual CheckType checkType() const = 0;

    const QgsGeometryCheckContext *context() const { return mContext; }
 
  protected:
    QMap<QString, QgsFeatureIds> allLayerFeatureIds( const QMap<QString, QgsFeaturePool *> &featurePools ) const SIP_SKIP;

    void replaceFeatureGeometryPart( const QMap<QString, QgsFeaturePool *> &featurePools, const QString &layerId, QgsFeature &feature, int partIdx, QgsAbstractGeometry *newPartGeom, Changes &changes ) const SIP_SKIP;

    void deleteFeatureGeometryPart( const QMap<QString, QgsFeaturePool *> &featurePools, const QString &layerId, QgsFeature &feature, int partIdx, Changes &changes ) const SIP_SKIP;

    void deleteFeatureGeometryRing( const QMap<QString, QgsFeaturePool *> &featurePools, const QString &layerId, QgsFeature &feature, int partIdx, int ringIdx, Changes &changes ) const SIP_SKIP;
 
    const QgsGeometryCheckContext *mContext;
    QVariantMap mConfiguration;

    double scaleFactor( const QPointer<QgsVectorLayer> &layer ) const SIP_SKIP;

    Result checkUniqueId( const QgsGeometryCheckerUtils::LayerFeature layerFeature, QMap< QString, QSet<QVariant> > &uniqueIds ) const SIP_SKIP;
};
 
#endif // QGS_GEOMETRY_CHECK_H