QGIS API Documentation  3.21.0-Master (909859188c)
qgsalgorithmbatchnominatimgeocode.h
Go to the documentation of this file.
1 /***************************************************************************
2  qgsalgorithmbatchnominatimgeocode.h
3  ------------------
4  begin : December 2020
5  copyright : (C) 2020 by Mathieu Pellerin
6  email : nirvn dot asia at gmail dot com
7  ***************************************************************************/
8 
9 /***************************************************************************
10  * *
11  * This program is free software; you can redistribute it and/or modify *
12  * it under the terms of the GNU General Public License as published by *
13  * the Free Software Foundation; either version 2 of the License, or *
14  * (at your option) any later version. *
15  * *
16  ***************************************************************************/
17 
18 #ifndef QGSALGORITHMBATCHNOMINATIMGEOCODE_H
19 #define QGSALGORITHMBATCHNOMINATIMGEOCODE_H
20 
21 #define SIP_NO_FILE
22 
23 #include "qgis_sip.h"
24 #include "qgis_analysis.h"
25 #include "qgsprocessingalgorithm.h"
27 #include "qgsnominatimgeocoder.h"
28 
30 
34 class QgsBatchNominatimGeocodeAlgorithm : public QgsBatchGeocodeAlgorithm
35 {
36 
37  public:
38 
42  QgsBatchNominatimGeocodeAlgorithm();
43 
44  QString name() const override;
45  QString displayName() const override;
46  QStringList tags() const override;
47  QString shortHelpString() const override;
48  QgsBatchNominatimGeocodeAlgorithm *createInstance() const override SIP_FACTORY;
49 
50  protected:
51  bool prepareAlgorithm( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback ) override;
52 
53  private:
54 
55  QgsNominatimGeocoder mNominatimGeocoder;
56 
57 };
58 
60 
61 #endif // QGSALGORITHMBATCHNOMINATIMGEOCODE_H
62 
63 
A base class for batch geocoder algorithms, which takes a QgsGeocoderInterface object and exposes it ...
QStringList tags() const override
Returns a list of tags which relate to the algorithm, and are used to assist users in searching for s...
A geocoder which uses the Nominatim geocoding API to retrieve results.
virtual QString shortHelpString() const
Returns a localised short helper string for the algorithm.
virtual QString displayName() const =0
Returns the translated algorithm name, which should be used for any user-visible display of the algor...
virtual QgsProcessingAlgorithm * createInstance() const =0
Creates a new instance of the algorithm class.
virtual QString name() const =0
Returns the algorithm name, used for identifying the algorithm.
Contains information about the context in which a processing algorithm is executed.
Base class for providing feedback from a processing algorithm.
#define SIP_FACTORY
Definition: qgis_sip.h:76