File: qgsrastercalcnode.sip.in

package info (click to toggle)
qgis 3.40.10%2Bdfsg-1~bpo13%2B1
  • links: PTS, VCS
  • area: main
  • in suites: trixie-backports
  • size: 1,183,672 kB
  • sloc: cpp: 1,595,771; python: 372,544; xml: 23,474; sh: 3,761; perl: 3,664; ansic: 2,257; sql: 2,137; yacc: 1,068; lex: 577; javascript: 540; lisp: 411; makefile: 161
file content (133 lines) | stat: -rw-r--r-- 3,291 bytes parent folder | download | duplicates (6)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
/************************************************************************
 * This file has been generated automatically from                      *
 *                                                                      *
 * src/analysis/raster/qgsrastercalcnode.h                              *
 *                                                                      *
 * Do not edit manually ! Edit header and run scripts/sipify.py again   *
 ************************************************************************/






class QgsRasterCalcNode
{
%Docstring(signature="appended")
Represents a node in a raster calculator.
%End

%TypeHeaderCode
#include "qgsrastercalcnode.h"
%End
  public:
    enum Type /BaseType=IntEnum/
    {
      tOperator,
      tNumber,
      tRasterRef,
      tMatrix,
      tFunction
    };

    enum Operator /BaseType=IntEnum/
    {
      opPLUS,
      opMINUS,
      opMUL,
      opDIV,
      opPOW,
      opSQRT,
      opSIN,
      opCOS,
      opTAN,
      opASIN,
      opACOS,
      opATAN,
      opEQ,
      opNE,
      opGT,
      opLT,
      opGE,
      opLE,
      opAND,
      opOR,
      opSIGN,
      opLOG,
      opLOG10,
      opABS,
      opMAX,
      opMIN,
      opNONE,
    };

    QgsRasterCalcNode();

    QgsRasterCalcNode( double number );
    QgsRasterCalcNode( QgsRasterMatrix *matrix );
    QgsRasterCalcNode( Operator op, QgsRasterCalcNode *left, QgsRasterCalcNode *right );
    QgsRasterCalcNode( QString functionName, QVector<QgsRasterCalcNode *> functionArgs );
%Docstring
Constructor for the tFunction type
%End
    QgsRasterCalcNode( const QString &rasterName );
    ~QgsRasterCalcNode();


    Type type() const;

    void setLeft( QgsRasterCalcNode *left );
    void setRight( QgsRasterCalcNode *right );


    QString toString( bool cStyle = false ) const;
%Docstring
Returns a string representation of the expression

:param cStyle: if ``True`` operators will follow C syntax

.. versionadded:: 3.6
%End

    QList<const QgsRasterCalcNode *> findNodes( const QgsRasterCalcNode::Type type ) const;
%Docstring
Returns a list of nodes of a specific ``type``

.. versionadded:: 3.6
%End

    static QgsRasterCalcNode *parseRasterCalcString( const QString &str, QString &parserErrorMsg ) /Factory/;

    QStringList referencedLayerNames() const;
%Docstring
Returns a list of raster layer names that are referenced in the formula
without the quotation marks. It uses
QgsRasterCalcNode.cleanRasterReferences

.. note::

   since QGIS 3.22
%End

    QStringList cleanRasterReferences() const;
%Docstring
Returns a list of raster layer references that are addressed in the
formula, without quotation marks.

.. note::

   since QGIS 3.22
%End

  private:
    QgsRasterCalcNode( const QgsRasterCalcNode &rh );
};


/************************************************************************
 * This file has been generated automatically from                      *
 *                                                                      *
 * src/analysis/raster/qgsrastercalcnode.h                              *
 *                                                                      *
 * Do not edit manually ! Edit header and run scripts/sipify.py again   *
 ************************************************************************/