QGIS API Documentation 3.99.0-Master (c22de0620c0)
Loading...
Searching...
No Matches
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
22#include "qgis_analysis.h"
23#include "qgis_sip.h"
27
28#define SIP_NO_FILE
29
31
35class QgsBatchNominatimGeocodeAlgorithm : public QgsBatchGeocodeAlgorithm
36{
37 public:
41 QgsBatchNominatimGeocodeAlgorithm();
42
43 QString name() const override;
44 QString displayName() const override;
45 QStringList tags() const override;
46 QString shortHelpString() const override;
47 QString shortDescription() const override;
48 QgsBatchNominatimGeocodeAlgorithm *createInstance() const override SIP_FACTORY;
49
50 protected:
51 QgsCoordinateReferenceSystem outputCrs( const QgsCoordinateReferenceSystem &inputCrs ) const override;
52 bool prepareAlgorithm( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback ) override;
53
54 private:
55 QgsNominatimGeocoder mNominatimGeocoder;
56 mutable QgsCoordinateReferenceSystem mOutputCrs;
57};
58
60
61#endif // QGSALGORITHMBATCHNOMINATIMGEOCODE_H
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...
Represents a coordinate reference system (CRS).
A geocoder which uses the Nominatim geocoding API to retrieve results.
virtual QgsProcessingAlgorithm * createInstance() const =0
Creates a new instance of the algorithm class.
virtual QString shortHelpString() const
Returns a localised short helper string for the algorithm.
virtual QString shortDescription() const
Returns an optional translated short description of 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 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:83