QGIS API Documentation  3.26.3-Buenos Aires (65e4edfdad)
qgsalgorithmbatchgeocode.h
Go to the documentation of this file.
1 /***************************************************************************
2  qgsalgorithmbatchgeocode.h
3  ------------------
4  begin : August 2020
5  copyright : (C) 2020 by Nyall Dawson
6  email : nyall dot dawson 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 QGSALGORITHMBATCHGEOCODE_H
19 #define QGSALGORITHMBATCHGEOCODE_H
20 
21 #include "qgis_sip.h"
22 #include "qgis_analysis.h"
23 #include "qgsprocessingalgorithm.h"
24 
26 
69 {
70 
71  public:
72 
81 
82  void initParameters( const QVariantMap &configuration = QVariantMap() ) override;
83  QStringList tags() const override;
84  QString group() const override;
85  QString groupId() const override;
86  QList<int> inputLayerTypes() const override;
87  bool supportInPlaceEdit( const QgsMapLayer *layer ) const override;
88 
89  protected:
90  QString outputName() const override;
91  bool prepareAlgorithm( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback ) override;
94  QgsFields outputFields( const QgsFields &inputFields ) const override;
95  QgsWkbTypes::Type outputWkbType( QgsWkbTypes::Type inputWkbType ) const override;
96 
97  private:
98  bool mIsInPlace = false;
99  QString mAddressField;
100  QgsGeocoderInterface *mGeocoder = nullptr;
101  QgsStringMap mInPlaceFieldMap;
102  mutable QgsCoordinateReferenceSystem mOutputCrs;
103  mutable QStringList mAdditionalFields;
104 
105 };
106 
108 
109 #endif // QGSALGORITHMBATCHGEOCODE_H
110 
111 
QgsProcessingFeedback
Base class for providing feedback from a processing algorithm.
Definition: qgsprocessingfeedback.h:37
QgsProcessingFeatureBasedAlgorithm::outputWkbType
virtual QgsWkbTypes::Type outputWkbType(QgsWkbTypes::Type inputWkbType) const
Maps the input WKB geometry type (inputWkbType) to the corresponding output WKB type generated by the...
Definition: qgsprocessingalgorithm.cpp:1055
QgsFields
Container of fields for a vector layer.
Definition: qgsfields.h:44
QgsProcessingFeatureBasedAlgorithm::initParameters
virtual void initParameters(const QVariantMap &configuration=QVariantMap())
Initializes any extra parameters added by the algorithm subclass.
Definition: qgsprocessingalgorithm.cpp:1070
QgsProcessingAlgorithm::groupId
virtual QString groupId() const
Returns the unique ID of the group this algorithm belongs to.
Definition: qgsprocessingalgorithm.h:234
QgsWkbTypes::Type
Type
The WKB type describes the number of dimensions a geometry has.
Definition: qgswkbtypes.h:69
QgsBatchGeocodeAlgorithm
A base class for batch geocoder algorithms, which takes a QgsGeocoderInterface object and exposes it ...
Definition: qgsalgorithmbatchgeocode.h:68
QgsProcessingFeatureBasedAlgorithm::supportInPlaceEdit
bool supportInPlaceEdit(const QgsMapLayer *layer) const override
Checks whether this algorithm supports in-place editing on the given layer Default implementation for...
Definition: qgsprocessingalgorithm.cpp:1139
QgsProcessingAlgorithm::prepareAlgorithm
virtual bool prepareAlgorithm(const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback) SIP_THROW(QgsProcessingException)
Prepares the algorithm to run using the specified parameters.
Definition: qgsprocessingalgorithm.cpp:451
QgsProcessingFeatureBasedAlgorithm
An abstract QgsProcessingAlgorithm base class for processing algorithms which operate "feature-by-fea...
Definition: qgsprocessingalgorithm.h:1143
QgsProcessingFeatureBasedAlgorithm::processFeature
virtual QgsFeatureList processFeature(const QgsFeature &feature, QgsProcessingContext &context, QgsProcessingFeedback *feedback) SIP_THROW(QgsProcessingException)=0
Processes an individual input feature from the source.
QgsProcessingContext
Contains information about the context in which a processing algorithm is executed.
Definition: qgsprocessingcontext.h:46
qgsprocessingalgorithm.h
qgis_sip.h
QgsProcessingFeatureBasedAlgorithm::outputCrs
virtual QgsCoordinateReferenceSystem outputCrs(const QgsCoordinateReferenceSystem &inputCrs) const
Maps the input source coordinate reference system (inputCrs) to a corresponding output CRS generated ...
Definition: qgsprocessingalgorithm.cpp:1065
QgsFeatureList
QList< QgsFeature > QgsFeatureList
Definition: qgsfeature.h:882
QgsCoordinateReferenceSystem
This class represents a coordinate reference system (CRS).
Definition: qgscoordinatereferencesystem.h:211
QgsProcessingFeatureBasedAlgorithm::outputName
virtual QString outputName() const =0
Returns the translated, user visible name for any layers created by this algorithm.
QgsProcessingFeatureBasedAlgorithm::outputFields
virtual QgsFields outputFields(const QgsFields &inputFields) const
Maps the input source fields (inputFields) to corresponding output fields generated by the algorithm.
Definition: qgsprocessingalgorithm.cpp:1060
QgsStringMap
QMap< QString, QString > QgsStringMap
Definition: qgis.h:2781
QgsMapLayer
Base class for all map layer types. This is the base class for all map layer types (vector,...
Definition: qgsmaplayer.h:72
QgsProcessingAlgorithm::group
virtual QString group() const
Returns the name of the group this algorithm belongs to.
Definition: qgsprocessingalgorithm.h:225
QgsFeature
The feature class encapsulates a single feature including its unique ID, geometry and a list of field...
Definition: qgsfeature.h:55
QgsProcessingFeatureBasedAlgorithm::inputLayerTypes
virtual QList< int > inputLayerTypes() const
Returns the valid input layer types for the source layer for this algorithm.
Definition: qgsprocessingalgorithm.cpp:1035
QgsGeocoderInterface
Interface for geocoders.
Definition: qgsgeocoder.h:36
QgsProcessingAlgorithm::tags
virtual QStringList tags() const
Returns a list of tags which relate to the algorithm, and are used to assist users in searching for s...
Definition: qgsprocessingalgorithm.h:181