QGIS API Documentation  3.26.3-Buenos Aires (65e4edfdad)
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 
34 
35 class QgsRasterizeAlgorithm : public QgsProcessingAlgorithm
36 {
37  public:
38  QgsRasterizeAlgorithm() = default;
39 
40  void initAlgorithm( const QVariantMap &configuration = QVariantMap() ) override;
41  QString name() const override;
42  QString displayName() const override;
43  QStringList tags() const override;
44  Flags flags() const override;
45  QString group() const override;
46  QString groupId() const override;
47  QString shortHelpString() const override;
48  QString shortDescription() const override;
49  QgsRasterizeAlgorithm *createInstance() const override SIP_FACTORY;
50 
51  protected:
52 
53  QVariantMap processAlgorithm( const QVariantMap &parameters,
54  QgsProcessingContext &context, QgsProcessingFeedback *feedback ) override;
55 
56  bool prepareAlgorithm( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback ) override;
57 
58  private:
59 
60  QMap<QString, QString> mMapThemeStyleOverrides;
61  std::vector<std::unique_ptr<QgsMapLayer>> mMapLayers;
62 
63 };
64 
66 
67 #endif // QGSRASTERIZEALGORITHM_H
QgsProcessingAlgorithm::shortDescription
virtual QString shortDescription() const
Returns an optional translated short description of the algorithm.
Definition: qgsprocessingalgorithm.cpp:60
QgsProcessingAlgorithm::displayName
virtual QString displayName() const =0
Returns the translated algorithm name, which should be used for any user-visible display of the algor...
QgsProcessingFeedback
Base class for providing feedback from a processing algorithm.
Definition: qgsprocessingfeedback.h:37
QgsProcessingAlgorithm::groupId
virtual QString groupId() const
Returns the unique ID of the group this algorithm belongs to.
Definition: qgsprocessingalgorithm.h:234
QgsProcessingAlgorithm::createInstance
virtual QgsProcessingAlgorithm * createInstance() const =0
Creates a new instance of the algorithm class.
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
SIP_FACTORY
#define SIP_FACTORY
Definition: qgis_sip.h:76
QgsProcessingAlgorithm::name
virtual QString name() const =0
Returns the algorithm name, used for identifying the algorithm.
QgsProcessingAlgorithm::processAlgorithm
virtual QVariantMap processAlgorithm(const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback) SIP_THROW(QgsProcessingException)=0
Runs the algorithm using the specified parameters.
QgsProcessingContext
Contains information about the context in which a processing algorithm is executed.
Definition: qgsprocessingcontext.h:46
qgsprocessingalgorithm.h
qgis_sip.h
QgsProcessingAlgorithm::shortHelpString
virtual QString shortHelpString() const
Returns a localised short helper string for the algorithm.
Definition: qgsprocessingalgorithm.cpp:65
QgsProcessingAlgorithm
Abstract base class for processing algorithms.
Definition: qgsprocessingalgorithm.h:52
QgsProcessingAlgorithm::group
virtual QString group() const
Returns the name of the group this algorithm belongs to.
Definition: qgsprocessingalgorithm.h:225
QgsProcessingAlgorithm::flags
virtual Flags flags() const
Returns the flags indicating how and when the algorithm operates and should be exposed to users.
Definition: qgsprocessingalgorithm.cpp:90
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
QgsProcessingAlgorithm::initAlgorithm
virtual void initAlgorithm(const QVariantMap &configuration=QVariantMap())=0
Initializes the algorithm using the specified configuration.