QGIS API Documentation 3.39.0-Master (bca3cdb6021)
Loading...
Searching...
No Matches
qgsalgorithmrastercalculator.h
Go to the documentation of this file.
1/***************************************************************************
2 qgsalgorithmrastercalculator.h
3 ---------------------
4 begin : July 2023
5 copyright : (C) 2023 by Alexander Bruy
6 email : alexander dot bruy 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 QGSALGORITHMRASTERCALCULATOR_H
19#define QGSALGORITHMRASTERCALCULATOR_H
20
21#define SIP_NO_FILE
22
23#include "qgis_sip.h"
25#include "qgsapplication.h"
26
28
32class QgsRasterCalculatorAlgorithm : public QgsProcessingAlgorithm
33{
34
35 public:
36
37 QgsRasterCalculatorAlgorithm() = default;
38 void initAlgorithm( const QVariantMap &configuration = QVariantMap() ) override;
39 QIcon icon() const override { return QgsApplication::getThemeIcon( QStringLiteral( "/algorithms/mAlgorithmRasterCalculator.svg" ) ); }
40 QString svgIconPath() const override { return QgsApplication::iconPath( QStringLiteral( "/algorithms/mAlgorithmRasterCalculator.svg" ) ); }
42 QString name() const override;
43 QString displayName() const override;
44 QStringList tags() const override;
45 QString group() const override;
46 QString groupId() const override;
47 QString shortHelpString() const override;
48 QgsRasterCalculatorAlgorithm *createInstance() const override SIP_FACTORY;
49
50 protected:
51
52 bool prepareAlgorithm( const QVariantMap &parameters,
53 QgsProcessingContext &context, QgsProcessingFeedback *feedback ) override;
54 QVariantMap processAlgorithm( const QVariantMap &parameters,
55 QgsProcessingContext &context, QgsProcessingFeedback *feedback ) override;
56
57 QList< QgsMapLayer * > mLayers;
58};
59
60class QgsRasterCalculatorModelerAlgorithm : public QgsRasterCalculatorAlgorithm
61{
62
63 public:
64
65 QgsRasterCalculatorModelerAlgorithm() = default;
66 Qgis::ProcessingAlgorithmFlags flags() const override;
67 QString name() const override;
68 QString displayName() const override;
69 QStringList tags() const override;
70 QString group() const override;
71 QString groupId() const override;
72 QgsRasterCalculatorModelerAlgorithm *createInstance() const override SIP_FACTORY;
73
74 protected:
75
76 QVariantMap processAlgorithm( const QVariantMap &parameters,
77 QgsProcessingContext &context, QgsProcessingFeedback *feedback ) override;
78
79 private:
80
85 QString indexToName( int index ) const;
86};
87
89
90#endif // QGSALGORITHMRASTERCALCULATOR_H
QFlags< ProcessingAlgorithmFlag > ProcessingAlgorithmFlags
Flags indicating how and when an algorithm operates and should be exposed to users.
Definition qgis.h:3319
static QIcon getThemeIcon(const QString &name, const QColor &fillColor=QColor(), const QColor &strokeColor=QColor())
Helper to get a theme icon.
static QString iconPath(const QString &iconFile)
Returns path to the desired icon file.
Abstract base class for processing algorithms.
virtual QgsProcessingAlgorithm * createInstance() const =0
Creates a new instance of the algorithm class.
virtual QString group() const
Returns the name of the group this algorithm belongs to.
virtual QString groupId() const
Returns the unique ID of the group this algorithm belongs to.
virtual QIcon icon() const
Returns an icon for the algorithm.
virtual QString shortHelpString() const
Returns a localised short helper string for the algorithm.
virtual Qgis::ProcessingAlgorithmFlags flags() const
Returns the flags indicating how and when the algorithm operates and should be exposed to users.
virtual QString displayName() const =0
Returns the translated algorithm name, which should be used for any user-visible display of the algor...
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 svgIconPath() const
Returns a path to an SVG version of the algorithm's icon.
virtual void initAlgorithm(const QVariantMap &configuration=QVariantMap())=0
Initializes the algorithm using the specified configuration.
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