Merge pull request #7822 from m-kuhn/constCorrectQgsGeometryError

Const correctness for QgsGeometry::Error
qgis · Sep 7, 2018 · 7f63d41 · 7f63d41
2 parents e611756 + e637fd5
commit 7f63d41
Show file tree

Hide file tree

Showing 3 changed files with 55 additions and 16 deletions.
diff --git a/python/core/auto_generated/geometry/qgsgeometry.sip.in b/python/core/auto_generated/geometry/qgsgeometry.sip.in
@@ -1481,9 +1481,21 @@ by calling `error()` on the returned geometry.
         explicit Error( const QString &m );
 
         Error( const QString &m, const QgsPointXY &p );
-        QString what();
-        QgsPointXY where();
-        bool hasWhere();
+        QString what() const;
+%Docstring
+A human readable error message containing details about the error.
+%End
+
+        QgsPointXY where() const;
+%Docstring
+The coordinates at which the error is located and should be visualized.
+%End
+
+        bool hasWhere() const;
+%Docstring
+True if the location available from :py:func:`where` is valid.
+%End
+
     };
 
     enum ValidationMethod

diff --git a/src/core/geometry/qgsgeometry.cpp b/src/core/geometry/qgsgeometry.cpp
@@ -3288,3 +3288,18 @@ QDataStream &operator>>( QDataStream &in, QgsGeometry &geometry )
   return in;
 }
 
+
+QString QgsGeometry::Error::what() const
+{
+  return mMessage;
+}
+
+QgsPointXY QgsGeometry::Error::where() const
+{
+  return mLocation;
+}
+
+bool QgsGeometry::Error::hasWhere() const
+{
+  return mHasLocation;
+}
diff --git a/src/core/geometry/qgsgeometry.h b/src/core/geometry/qgsgeometry.h
@@ -1418,27 +1418,39 @@ class CORE_EXPORT QgsGeometry
      */
     class CORE_EXPORT Error
     {
-        QString message;
-        QgsPointXY location;
-        bool hasLocation = false;
-
       public:
         Error()
-          : message( QStringLiteral( "none" ) )
+          : mMessage( QStringLiteral( "none" ) )
         {}
 
         explicit Error( const QString &m )
-          : message( m )
+          : mMessage( m )
         {}
 
         Error( const QString &m, const QgsPointXY &p )
-          : message( m )
-          , location( p )
-          , hasLocation( true ) {}
-
-        QString what() { return message; }
-        QgsPointXY where() { return location; }
-        bool hasWhere() { return hasLocation; }
+          : mMessage( m )
+          , mLocation( p )
+          , mHasLocation( true ) {}
+
+        /**
+         * A human readable error message containing details about the error.
+         */
+        QString what() const;
+
+        /**
+         * The coordinates at which the error is located and should be visualized.
+         */
+        QgsPointXY where() const;
+
+        /**
+         * True if the location available from \see where is valid.
+         */
+        bool hasWhere() const;
+
+      private:
+        QString mMessage;
+        QgsPointXY mLocation;
+        bool mHasLocation = false;
     };
 
     /**