Branch data     Line data    Source code

       1                 :            : /***************************************************************************
       2                 :            :                       qgsgeometryisvalidcheck.h
       3                 :            :                      --------------------------------------
       4                 :            : Date                 : 7.9.2018
       5                 :            : Copyright            : (C) 2018 by Matthias Kuhn
       6                 :            : email                : matthias@opengis.ch
       7                 :            :  ***************************************************************************
       8                 :            :  *                                                                         *
       9                 :            :  *   This program is free software; you can redistribute it and/or modify  *
      10                 :            :  *   it under the terms of the GNU General Public License as published by  *
      11                 :            :  *   the Free Software Foundation; either version 2 of the License, or     *
      12                 :            :  *   (at your option) any later version.                                   *
      13                 :            :  *                                                                         *
      14                 :            :  ***************************************************************************/
      15                 :            : 
      16                 :            : #ifndef QGSGEOMETRYISVALIDCHECK_H
      17                 :            : #define QGSGEOMETRYISVALIDCHECK_H
      18                 :            : 
      19                 :            : #define SIP_NO_FILE
      20                 :            : 
      21                 :            : #include "qgssinglegeometrycheck.h"
      22                 :            : 
      23                 :            : /**
      24                 :            :  * \ingroup analysis
      25                 :            :  *
      26                 :            :  * \brief An error for a QgsGeometryIsValid check.
      27                 :            :  *
      28                 :            :  * The description is delivered by the underlying check engine, either GEOS or QGIS internal.
      29                 :            :  *
      30                 :            :  * \since QGIS 3.4
      31                 :            :  */
      32                 :          0 : class ANALYSIS_EXPORT QgsGeometryIsValidCheckError : public QgsSingleGeometryCheckError
      33                 :            : {
      34                 :            :   public:
      35                 :            : 
      36                 :            :     /**
      37                 :            :      * Creates a new is valid check error.
      38                 :            :      */
      39                 :            :     QgsGeometryIsValidCheckError( const QgsSingleGeometryCheck *check, const QgsGeometry &geometry, const QgsGeometry &errorLocation, const QString &errorDescription );
      40                 :            : 
      41                 :            :     QString description() const override;
      42                 :            : 
      43                 :            :   private:
      44                 :            :     QString mDescription;
      45                 :            : };
      46                 :            : 
      47                 :            : /**
      48                 :            :  * \ingroup analysis
      49                 :            :  *
      50                 :            :  * \brief Checks if geometries are valid using the backend configured in the QGIS settings.
      51                 :            :  * This does not offer any fixes but makes sure that all geometries are valid.
      52                 :            :  *
      53                 :            :  * \since QGIS 3.4
      54                 :            :  */
      55                 :          0 : class ANALYSIS_EXPORT QgsGeometryIsValidCheck : public QgsSingleGeometryCheck
      56                 :            : {
      57                 :          0 :     Q_DECLARE_TR_FUNCTIONS( QgsGeometryIsValidCheck )
      58                 :            :   public:
      59                 :            : 
      60                 :            :     /**
      61                 :            :      * Creates a new is valid check with the provided \a context. No options are supported in \a configuration.
      62                 :            :      */
      63                 :            :     explicit QgsGeometryIsValidCheck( const QgsGeometryCheckContext *context, const QVariantMap &configuration );
      64                 :            : 
      65                 :            :     QList<QgsWkbTypes::GeometryType> compatibleGeometryTypes() const override;
      66                 :            :     QList<QgsSingleGeometryCheckError *> processGeometry( const QgsGeometry &geometry ) const override;
      67                 :            :     Q_DECL_DEPRECATED QStringList resolutionMethods() const override;
      68                 :          0 :     QString description() const override { return factoryDescription(); }
      69                 :          0 :     QString id() const override { return factoryId(); }
      70                 :          0 :     QgsGeometryCheck::CheckType checkType() const override { return factoryCheckType(); }
      71                 :            : 
      72                 :            : ///@cond private
      73                 :            :     static QList<QgsWkbTypes::GeometryType> factoryCompatibleGeometryTypes() SIP_SKIP;
      74                 :            :     static bool factoryIsCompatible( QgsVectorLayer *layer ) SIP_SKIP;
      75                 :            :     static QString factoryDescription() SIP_SKIP;
      76                 :            :     static QString factoryId() SIP_SKIP;
      77                 :            :     static QgsGeometryCheck::Flags factoryFlags() SIP_SKIP;
      78                 :            :     static QgsGeometryCheck::CheckType factoryCheckType() SIP_SKIP;
      79                 :            : ///@endcond
      80                 :            : };
      81                 :            : 
      82                 :            : #endif // QGSGEOMETRYISVALIDCHECK_H