Branch data     Line data    Source code

       1                 :            : /***************************************************************************
       2                 :            :     qgsgeometrycheckresolutionmethod.h
       3                 :            :      --------------------------------------
       4                 :            :     Date                 : January 2020
       5                 :            :     Copyright            : (C) 2020 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 QGSGEOMETRYCHECKRESOLUTIONMETHOD_H
      17                 :            : #define QGSGEOMETRYCHECKRESOLUTIONMETHOD_H
      18                 :            : 
      19                 :            : #include <QString>
      20                 :            : #include "qgis_analysis.h"
      21                 :            : 
      22                 :            : /**
      23                 :            :  * \ingroup analysis
      24                 :            :  * \brief This class implements a resolution for problems detected in geometry checks.
      25                 :            :  *
      26                 :            :  * \since QGIS 3.12
      27                 :            :  */
      28                 :        198 : class ANALYSIS_EXPORT QgsGeometryCheckResolutionMethod
      29                 :            : {
      30                 :            :   public:
      31                 :            : 
      32                 :            :     /**
      33                 :            :      * Creates a new method with the specified parameters.
      34                 :            :      */
      35                 :            :     QgsGeometryCheckResolutionMethod( int id, const QString &name, const QString &description, bool isStable = true );
      36                 :            : 
      37                 :            :     /**
      38                 :            :      * An id that is unique per check. This will be used to trigger resolutions.
      39                 :            :      */
      40                 :            :     int id() const;
      41                 :            : 
      42                 :            :     /**
      43                 :            :      * If this fix is stable enough to be listed by default.
      44                 :            :      */
      45                 :            :     bool isStable() const;
      46                 :            : 
      47                 :            :     /**
      48                 :            :      * A human readable and translated name for this fix.
      49                 :            :      */
      50                 :            :     QString name() const;
      51                 :            : 
      52                 :            :     /**
      53                 :            :      * A human readable and translated description for this fix.
      54                 :            :      */
      55                 :            :     QString description() const;
      56                 :            : 
      57                 :            :   private:
      58                 :            :     int mId = -1;
      59                 :            :     bool mIsStable = false;
      60                 :            :     QString mName;
      61                 :            :     QString mDescription;
      62                 :            : };
      63                 :            : 
      64                 :            : #endif // QGSGEOMETRYCHECKRESOLUTIONMETHOD_H