QGIS API Documentation 3.27.0-Master (f261cc1f8b)
qgsrastercalcnode.h
Go to the documentation of this file.
1/***************************************************************************
2 qgsrastercalcnode.h
3 Node for raster calculator tree
4 --------------------
5 begin : 2010-10-23
6 copyright : (C) 20010 by Marco Hugentobler
7 email : marco dot hugentobler at sourcepole dot ch
8***************************************************************************/
9
10/***************************************************************************
11 * *
12 * This program is free software; you can redistribute it and/or modify *
13 * it under the terms of the GNU General Public License as published by *
14 * the Free Software Foundation; either version 2 of the License, or *
15 * (at your option) any later version. *
16 * *
17 ***************************************************************************/
18
19#ifndef QGSRASTERCALCNODE_H
20#define QGSRASTERCALCNODE_H
21
22#include <QMap>
23#include "qgis_sip.h"
24#include "qgis.h"
25#include <QString>
26#include "qgis_analysis.h"
27
28#include <QVector>
29
30class QgsRasterBlock;
31class QgsRasterMatrix;
32
38class ANALYSIS_EXPORT QgsRasterCalcNode
39{
40 public:
42 enum Type
43 {
44 tOperator = 1,
48 tFunction
49 };
50
53 {
66 opEQ, // =
68 opGT, // >
69 opLT, // <
70 opGE, // >=
71 opLE, // <=
74 opSIGN, // change sign
81 };
82
86 QgsRasterCalcNode() = default;
87
88 QgsRasterCalcNode( double number );
92 QgsRasterCalcNode( QString functionName, QVector <QgsRasterCalcNode *> functionArgs );
93 QgsRasterCalcNode( const QString &rasterName );
95
97 QgsRasterCalcNode( const QgsRasterCalcNode &rh ) = delete;
100
101 Type type() const { return mType; }
102
103 //set left node
104 void setLeft( QgsRasterCalcNode *left ) { delete mLeft; mLeft = left; }
105 void setRight( QgsRasterCalcNode *right ) { delete mRight; mRight = right; }
106
116 bool calculate( QMap<QString, QgsRasterBlock * > &rasterData, QgsRasterMatrix &result, int row = -1 ) const SIP_SKIP;
117
123 QString toString( bool cStyle = false ) const;
124
129 QList<const QgsRasterCalcNode *> findNodes( const QgsRasterCalcNode::Type type ) const;
130
131 static QgsRasterCalcNode *parseRasterCalcString( const QString &str, QString &parserErrorMsg ) SIP_FACTORY;
132
138 QStringList referencedLayerNames( );
139
144 QStringList cleanRasterReferences();
145
146 private:
147#ifdef SIP_RUN
149#endif
150
155 QgsRasterMatrix evaluateFunction( const QVector<QgsRasterMatrix *> &matrixVector, QgsRasterMatrix &result ) const;
156
157 Type mType = tNumber;
158 QgsRasterCalcNode *mLeft = nullptr;
159 QgsRasterCalcNode *mRight = nullptr;
160 double mNumber = 0;
161 QString mRasterName;
162 QgsRasterMatrix *mMatrix = nullptr;
163 Operator mOperator = opNONE;
164 //added for the conditional statement
165 QString mFunctionName;
166 QVector <QgsRasterCalcNode *> mFunctionArgs;
167};
168
169
170#endif // QGSRASTERCALCNODE_H
Raster data container.
Represents a node in a raster calculator.
void setLeft(QgsRasterCalcNode *left)
Operator
possible operators
QgsRasterCalcNode()=default
Constructor for QgsRasterCalcNode.
QgsRasterCalcNode(const QgsRasterCalcNode &rh)=delete
QgsRasterCalcNode cannot be copied.
QgsRasterCalcNode & operator=(const QgsRasterCalcNode &rh)=delete
QgsRasterCalcNode cannot be copied.
void setRight(QgsRasterCalcNode *right)
Type
defines possible types of node
Represents a matrix in a raster calculator operation.
#define str(x)
Definition: qgis.cpp:37
#define SIP_SKIP
Definition: qgis_sip.h:126
#define SIP_FACTORY
Definition: qgis_sip.h:76