sipify osmdownloader and small improvments to the overpass server

qgis · May 2, 2017 · 8792265 · 8792265
1 parent 6e38c1d
commit 8792265
Show file tree

Hide file tree

Showing 4 changed files with 117 additions and 35 deletions.
diff --git a/python/analysis/openstreetmap/qgsosmdownload.sip b/python/analysis/openstreetmap/qgsosmdownload.sip
@@ -1,65 +1,128 @@
-/**
- * @brief OSMDownload is a utility class for downloading OpenStreetMap via Overpass API.
- *
- * To use this class, it is necessary to set query, output file name and start the request.
- * The interface is asynchronous, the caller has to wait for finished() signal that is
- * emitted whe the request has finished (successfully or with an error).
- *
- * To check whether the the request has been successful, check hasError() and use errorString()
- * to retrieve error message. An error may happen either directly in start() method
- * or during the network communication.
- *
- * By default OSMDownload uses remote service at location returned by defaultServiceUrl() method.
- */
+/************************************************************************
+ * This file has been generated automatically from                      *
+ *                                                                      *
+ * src/analysis/openstreetmap/qgsosmdownload.h                          *
+ *                                                                      *
+ * Do not edit manually ! Edit header and run scripts/sipify.pl again   *
+ ************************************************************************/
+
+
+
+
+
 class QgsOSMDownload : QObject
 {
+%Docstring
+ OSMDownload is a utility class for downloading OpenStreetMap via Overpass API.
+
+ To use this class, it is necessary to set query, output file name and start the request.
+ The interface is asynchronous, the caller has to wait for finished() signal that is
+ emitted whe the request has finished (successfully or with an error).
+
+ To check whether the the request has been successful, check hasError() and use errorString()
+ to retrieve error message. An error may happen either directly in start() method
+ or during the network communication.
+
+ By default OSMDownload uses remote service at location returned by defaultServiceUrl() method.
+%End
+
 %TypeHeaderCode
-#include <qgsosmdownload.h>
+#include "qgsosmdownload.h"
 %End
   public:
 
-    //! Return URL of the service that is used by default
     static QString defaultServiceUrl();
+%Docstring
+Return URL of the service that is used by default
+ :rtype: str
+%End
 
-    //! Create query (in Overpass Query Language) that fetches everything in given rectangle
     static QString queryFromRect( const QgsRectangle &rect );
+%Docstring
+Create query (in Overpass Query Language) that fetches everything in given rectangle
+ :rtype: str
+%End
 
     QgsOSMDownload();
+
+    QgsOSMDownload( const QString &query );
+%Docstring
+ Constructor for QgsOSMDownload
+ \param query The query to execute in the Overpass API.
+
+.. versionadded:: 3.0
+%End
+
     ~QgsOSMDownload();
 
     void setServiceUrl( const QString &serviceUrl );
     QString serviceUrl() const;
+%Docstring
+ :rtype: str
+%End
 
     void setQuery( const QString &query );
     QString query() const;
+%Docstring
+ :rtype: str
+%End
 
     void setOutputFileName( const QString &outputFileName );
     QString outputFileName() const;
+%Docstring
+ :rtype: str
+%End
 
     bool hasError() const;
+%Docstring
+ :rtype: bool
+%End
     QString errorString() const;
+%Docstring
+ :rtype: str
+%End
 
-    /**
-     * @brief Starts network request for data. The prerequisite is that the query string and output
-     * file name have been set.
-     *
-     * Only one request may be pending at one point - if you need more requests at once, use several instances.
-     *
-     * @return true if the network request has been issued, false otherwise (and sets error string)
-     */
     bool start();
+%Docstring
+ Starts network request for data. The prerequisite is that the query string and output
+ file name have been set.
+
+ Only one request may be pending at one point - if you need more requests at once, use several instances.
+
+ :return: true if the network request has been issued, false otherwise (and sets error string)
+ :rtype: bool
+%End
 
-    /**
-     * @brief Aborts current pending request
-     * @return true if there is a pending request and has been aborted, false otherwise
-     */
     bool abort();
+%Docstring
+ Aborts current pending request
+ :return: true if there is a pending request and has been aborted, false otherwise
+ :rtype: bool
+%End
 
-    //! Returns true if the request has already finished
     bool isFinished() const;
+%Docstring
+Returns true if the request has already finished
+ :rtype: bool
+%End
 
   signals:
-    void finished(); //!< emitted when the network reply has finished (with success or with an error)
-    void downloadProgress( qint64, qint64 ); //!< normally the total length is not known (until we reach end)
+    void finished();
+%Docstring
+Emitted when the network reply has finished (with success or with an error)
+%End
+
+    void downloadProgress( qint64, qint64 );
+%Docstring
+Normally the total length is not known (until we reach end)
+%End
 
 };
+
+/************************************************************************
+ * This file has been generated automatically from                      *
+ *                                                                      *
+ * src/analysis/openstreetmap/qgsosmdownload.h                          *
+ *                                                                      *
+ * Do not edit manually ! Edit header and run scripts/sipify.pl again   *
+ ************************************************************************/
diff --git a/python/auto_sip.blacklist b/python/auto_sip.blacklist
@@ -507,7 +507,6 @@ analysis/interpolation/qgsidwinterpolator.sip
 analysis/interpolation/qgstininterpolator.sip
 analysis/openstreetmap/qgsosmbase.sip
 analysis/openstreetmap/qgsosmdatabase.sip
-analysis/openstreetmap/qgsosmdownload.sip
 analysis/openstreetmap/qgsosmimport.sip
 analysis/raster/qgsalignraster.sip
 analysis/raster/qgsderivativefilter.sip

diff --git a/src/analysis/openstreetmap/qgsosmdownload.cpp b/src/analysis/openstreetmap/qgsosmdownload.cpp
@@ -20,11 +20,13 @@
 
 #include "qgsnetworkaccessmanager.h"
 #include "qgsrectangle.h"
+#include "qgssettings.h"
 
 
 QString QgsOSMDownload::defaultServiceUrl()
 {
-  return QStringLiteral( "http://overpass-api.de/api/interpreter" );
+  QgsSettings settings;
+  return settings.value( "overpass_url", "http://overpass-api.de/api/interpreter" ).toString();
 }
 
 
@@ -41,6 +43,13 @@ QgsOSMDownload::QgsOSMDownload()
 {
 }
 
+QgsOSMDownload::QgsOSMDownload( const QString &query )
+  : mServiceUrl( defaultServiceUrl() )
+  , mQuery( query )
+  , mReply( nullptr )
+{
+}
+
 QgsOSMDownload::~QgsOSMDownload()
 {
   if ( mReply )

diff --git a/src/analysis/openstreetmap/qgsosmdownload.h b/src/analysis/openstreetmap/qgsosmdownload.h
@@ -49,6 +49,14 @@ class ANALYSIS_EXPORT QgsOSMDownload : public QObject
     static QString queryFromRect( const QgsRectangle &rect );
 
     QgsOSMDownload();
+
+    /** Constructor for QgsOSMDownload
+     * \param query The query to execute in the Overpass API.
+     *
+     * \since QGIS 3.0
+     */
+    QgsOSMDownload( const QString &query );
+
     ~QgsOSMDownload();
 
     void setServiceUrl( const QString &serviceUrl ) { mServiceUrl = serviceUrl; }
@@ -83,8 +91,11 @@ class ANALYSIS_EXPORT QgsOSMDownload : public QObject
     bool isFinished() const;
 
   signals:
-    void finished(); //!< Emitted when the network reply has finished (with success or with an error)
-    void downloadProgress( qint64, qint64 ); //!< Normally the total length is not known (until we reach end)
+    //! Emitted when the network reply has finished (with success or with an error)
+    void finished();
+
+    //! Normally the total length is not known (until we reach end)
+    void downloadProgress( qint64, qint64 );
 
   private slots:
     void onReadyRead();