QGIS API Documentation  3.9.0-Master (d9ef585e47)
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 class QgsRasterBlock;
29 class QgsRasterMatrix;
30 
35 class ANALYSIS_EXPORT QgsRasterCalcNode
36 {
37  public:
39  enum Type
40  {
41  tOperator = 1,
44  tMatrix
45  };
46 
48  enum Operator
49  {
62  opEQ, // =
63  opNE,
64  opGT, // >
65  opLT, // <
66  opGE, // >=
67  opLE, // <=
70  opSIGN, // change sign
77  };
78 
82  QgsRasterCalcNode() = default;
83 
84  QgsRasterCalcNode( double number );
87  QgsRasterCalcNode( const QString &rasterName );
89 
91  QgsRasterCalcNode( const QgsRasterCalcNode &rh ) = delete;
93  QgsRasterCalcNode &operator=( const QgsRasterCalcNode &rh ) = delete;
94 
95  Type type() const { return mType; }
96 
97  //set left node
98  void setLeft( QgsRasterCalcNode *left ) { delete mLeft; mLeft = left; }
99  void setRight( QgsRasterCalcNode *right ) { delete mRight; mRight = right; }
100 
110  bool calculate( QMap<QString, QgsRasterBlock * > &rasterData, QgsRasterMatrix &result, int row = -1 ) const SIP_SKIP;
111 
117  QString toString( bool cStyle = false ) const;
118 
123  QList<const QgsRasterCalcNode *> findNodes( const QgsRasterCalcNode::Type type ) const;
124 
125  static QgsRasterCalcNode *parseRasterCalcString( const QString &str, QString &parserErrorMsg ) SIP_FACTORY;
126 
127  private:
128 #ifdef SIP_RUN
130 #endif
131 
132  Type mType = tNumber;
133  QgsRasterCalcNode *mLeft = nullptr;
134  QgsRasterCalcNode *mRight = nullptr;
135  double mNumber = 0;
136  QString mRasterName;
137  QgsRasterMatrix *mMatrix = nullptr;
138  Operator mOperator = opNONE;
139 
140 };
141 
142 
143 #endif // QGSRASTERCALCNODE_H
Raster data container.
#define SIP_SKIP
Definition: qgis_sip.h:126
Type
defines possible types of node
Operator
possible operators
#define SIP_FACTORY
Definition: qgis_sip.h:76
void setLeft(QgsRasterCalcNode *left)
void setRight(QgsRasterCalcNode *right)