QGIS API Documentation  3.17.0-Master (a035f434f4)
qgsalgorithmrasterize.h
Go to the documentation of this file.
1 /***************************************************************************
2  qgsalgorithmrasterize.h - QgsRasterizeAlgorithm
3 
4  ---------------------
5 
6  Original implementation in Python:
7 
8  begin : 2016-10-05
9  copyright : (C) 2016 by OPENGIS.ch
10  email : [email protected]
11 
12  C++ port:
13 
14  begin : 20.11.2019
15  copyright : (C) 2019 by Alessandro Pasotti
16  email : elpaso at itopen dot it
17  ***************************************************************************
18  * *
19  * This program is free software; you can redistribute it and/or modify *
20  * it under the terms of the GNU General Public License as published by *
21  * the Free Software Foundation; either version 2 of the License, or *
22  * (at your option) any later version. *
23  * *
24  ***************************************************************************/
25 #ifndef QGSRASTERIZEALGORITHM_H
26 #define QGSRASTERIZEALGORITHM_H
27 
28 #define SIP_NO_FILE
29 
30 #include "qgis_sip.h"
31 #include "qgsprocessingalgorithm.h"
32 #include "qgsrasterprojector.h"
33 #include "qgsmapsettings.h"
34 
36 
37 class QgsRasterizeAlgorithm : public QgsProcessingAlgorithm
38 {
39  public:
40  QgsRasterizeAlgorithm() = default;
41 
42  void initAlgorithm( const QVariantMap &configuration = QVariantMap() ) override;
43  QString name() const override;
44  QString displayName() const override;
45  QStringList tags() const override;
46  Flags flags() const override;
47  QString group() const override;
48  QString groupId() const override;
49  QString shortHelpString() const override;
50  QString shortDescription() const override;
51  QgsRasterizeAlgorithm *createInstance() const override SIP_FACTORY;
52 
53  protected:
54 
55  QVariantMap processAlgorithm( const QVariantMap &parameters,
56  QgsProcessingContext &context, QgsProcessingFeedback *feedback ) override;
57 
58  bool prepareAlgorithm( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback ) override;
59 
60  private:
61 
62  QMap<QString, QString> mMapThemeStyleOverrides;
63  std::vector<std::unique_ptr<QgsMapLayer>> mMapLayers;
64 
65 };
66 
68 
69 #endif // QGSRASTERIZEALGORITHM_H
virtual bool prepareAlgorithm(const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback) SIP_THROW(QgsProcessingException)
Prepares the algorithm to run using the specified parameters.
Base class for providing feedback from a processing algorithm.
virtual QString name() const =0
Returns the algorithm name, used for identifying the algorithm.
virtual QString group() const
Returns the name of the group this algorithm belongs to.
virtual Flags flags() const
Returns the flags indicating how and when the algorithm operates and should be exposed to users...
virtual QStringList tags() const
Returns a list of tags which relate to the algorithm, and are used to assist users in searching for s...
virtual QString shortHelpString() const
Returns a localised short helper string for the algorithm.
Abstract base class for processing algorithms.
virtual void initAlgorithm(const QVariantMap &configuration=QVariantMap())=0
Initializes the algorithm using the specified configuration.
#define SIP_FACTORY
Definition: qgis_sip.h:76
virtual QgsProcessingAlgorithm * createInstance() const =0
Creates a new instance of the algorithm class.
virtual QVariantMap processAlgorithm(const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback) SIP_THROW(QgsProcessingException)=0
Runs the algorithm using the specified parameters.
virtual QString displayName() const =0
Returns the translated algorithm name, which should be used for any user-visible display of the algor...
virtual QString shortDescription() const
Returns an optional translated short description of the algorithm.
virtual QString groupId() const
Returns the unique ID of the group this algorithm belongs to.
Contains information about the context in which a processing algorithm is executed.