qgsnominatimgeocoder.h

Go to the documentation of this file.

/***************************************************************************
  qgsnominatimgeocoder.h
  ---------------
  Date                 : December 2020
  Copyright            : (C) 2020 by Mathieu Pellerin
  Email                : nirvn dot asia at gmail dot com
 ***************************************************************************
 *                                                                         *
 *   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 QGSNOMINATIMGEOCODER_H
#define QGSNOMINATIMGEOCODER_H
 
#include "qgis_core.h"
#include "qgsgeocoder.h"
 
#include <QMutex>

class CORE_EXPORT QgsNominatimGeocoder : public QgsGeocoderInterface
{
  public:
    QgsNominatimGeocoder( const QString &countryCodes = QString(), const QString &endpoint = QString() );
 
    Flags flags() const override;
    QgsFields appendedFields() const override;
    Qgis::WkbType wkbType() const override;
    QList< QgsGeocoderResult > geocodeString( const QString &string, const QgsGeocoderContext &context, QgsFeedback *feedback = nullptr ) const override;

    QUrl requestUrl( const QString &address, const QgsRectangle &bounds = QgsRectangle() ) const;

    QgsGeocoderResult jsonToResult( const QVariantMap &json ) const;

    QString endpoint() const;

    void setEndpoint( const QString &endpoint );

    double requestsPerSecond() const { return mRequestsPerSecond; }

    void setRequestsPerSecond( double number ) { mRequestsPerSecond = number; }

    QString countryCodes() const;

    void setCountryCodes( const QString &countryCodes );
 
  private:
    QString mCountryCodes;
    QString mEndpoint;
    double mRequestsPerSecond = 1;
 
    static QMutex sMutex;
 
    static qint64 sLastRequestTimestamp;
};
 
#endif // QGSNOMINATIMGEOCODER_H