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
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
|
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/mesh/qgsmeshcalculator.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
class QgsMeshCalculator
{
%Docstring(signature="appended")
Performs mesh layer calculations.
Mesh calculator can do various mathematical operations between dataset
groups from a single mesh layer. Resulting dataset group is added to the
mesh layer. Result can be filtered by extent or a vector layer mask
spatially and by selection of times.
Resulting dataset is always scalar
.. versionadded:: 3.6
%End
%TypeHeaderCode
#include "qgsmeshcalculator.h"
%End
public:
enum Result /BaseType=IntEnum/
{
Success,
Canceled,
CreateOutputError,
InputLayerError,
ParserError,
InvalidDatasets,
EvaluateError,
MemoryError,
};
QgsMeshCalculator( const QString &formulaString,
const QString &outputFile,
const QgsRectangle &outputExtent,
double startTime,
double endTime,
QgsMeshLayer *layer ) /Deprecated/;
%Docstring
Creates calculator with bounding box (rectangular) mask
:param formulaString: formula/expression to evaluate. Consists of
dataset group names, operators and numbers
:param outputFile: file to store the resulting dataset group data
:param outputExtent: spatial filter defined by rectangle
:param startTime: time filter defining the starting dataset
:param endTime: time filter defining the ending dataset
:param layer: mesh layer with dataset groups references in formulaString
.. deprecated:: 3.12
%End
QgsMeshCalculator( const QString &formulaString,
const QString &outputFile,
const QgsGeometry &outputMask,
double startTime,
double endTime,
QgsMeshLayer *layer ) /Deprecated/;
%Docstring
Creates calculator with geometry mask
:param formulaString: formula/expression to evaluate. Consists of
dataset group names, operators and numbers
:param outputFile: file to store the resulting dataset group data
:param outputMask: spatial filter defined by geometry
:param startTime: time filter defining the starting dataset
:param endTime: time filter defining the ending dataset
:param layer: mesh layer with dataset groups references in formulaString
.. deprecated:: 3.12
%End
QgsMeshCalculator( const QString &formulaString,
const QString &outputDriver,
const QString &outputGroupName,
const QString &outputFile,
const QgsRectangle &outputExtent,
double startTime,
double endTime,
QgsMeshLayer *layer );
%Docstring
Creates calculator with bounding box (rectangular) mask
:param formulaString: formula/expression to evaluate. Consists of
dataset group names, operators and numbers
:param outputDriver: output driver name
:param outputGroupName: output group name
:param outputFile: file to store the resulting dataset group data
:param outputExtent: spatial filter defined by rectangle
:param startTime: time filter defining the starting dataset
:param endTime: time filter defining the ending dataset
:param layer: mesh layer with dataset groups references in formulaString
.. versionadded:: 3.12
%End
QgsMeshCalculator( const QString &formulaString,
const QString &outputDriver,
const QString &outputGroupName,
const QString &outputFile,
const QgsGeometry &outputMask,
double startTime,
double endTime,
QgsMeshLayer *layer );
%Docstring
Creates calculator with geometry mask
:param formulaString: formula/expression to evaluate. Consists of
dataset group names, operators and numbers
:param outputDriver: output driver name
:param outputGroupName: output group name
:param outputFile: file to store the resulting dataset group data
:param outputMask: spatial filter defined by geometry
:param startTime: time filter defining the starting dataset
:param endTime: time filter defining the ending dataset
:param layer: mesh layer with dataset groups references in formulaString
.. versionadded:: 3.12
%End
QgsMeshCalculator( const QString &formulaString,
const QString &outputGroupName,
const QgsRectangle &outputExtent,
const QgsMeshDatasetGroup::Type &destination,
QgsMeshLayer *layer,
double startTime,
double endTime );
%Docstring
Creates calculator with bounding box (rectangular) mask, store the
result in ``destination`` (must be on memory or virtual), see
QgsMeshCalculator.Destination
:param formulaString: formula/expression to evaluate. Consists of
dataset group names, operators and numbers
:param outputGroupName: output group name
:param outputExtent: spatial filter defined by rectangle
:param destination: destination of the calculation (memory or virtual)
:param startTime: time filter defining the starting dataset
:param endTime: time filter defining the ending dataset
:param layer: mesh layer with dataset groups references in formulaString
.. versionadded:: 3.16
%End
QgsMeshCalculator( const QString &formulaString,
const QString &outputGroupName,
const QgsGeometry &outputMask,
const QgsMeshDatasetGroup::Type &destination,
QgsMeshLayer *layer,
double startTime,
double endTime );
%Docstring
Creates calculator with with geometry mask, store the result in
``destination`` (must be on memory or virtual), see
QgsMeshCalculator.Destination
:param formulaString: formula/expression to evaluate. Consists of
dataset group names, operators and numbers
:param outputGroupName: output group name
:param outputMask: spatial filter defined by geometry
:param destination: destination of the calculation (memory or virtual)
:param startTime: time filter defining the starting dataset
:param endTime: time filter defining the ending dataset
:param layer: mesh layer with dataset groups references in formulaString
.. versionadded:: 3.16
%End
Result processCalculation( QgsFeedback *feedback = 0 );
%Docstring
Starts the calculation, creates new dataset group and adds it to the
mesh layer
:param feedback: The optional feedback argument for progress reporting
and cancellation support
:return: QgsMeshCalculator.Success in case of success
%End
static Result expression_valid( const QString &formulaString,
QgsMeshLayer *layer ) /Deprecated/;
%Docstring
Returns whether formula is valid for particular mesh layer
:param formulaString: formula/expression to evaluate. Consists of
dataset group names, operators and numbers
:param layer: mesh layer with dataset groups references in formulaString
:return: QgsMeshCalculator.Success in case of success
.. deprecated:: 3.12
Use expressionIsValid.
%End
static Result expressionIsValid( const QString &formulaString,
QgsMeshLayer *layer,
QgsMeshDriverMetadata::MeshDriverCapability &requiredCapability );
%Docstring
Returns whether formula is valid for particular mesh layer
:param formulaString: formula/expression to evaluate. Consists of
dataset group names, operators and numbers
:param layer: mesh layer with dataset groups references in formulaString
:param requiredCapability: returns required capability of driver to
store results of the calculation
:return: QgsMeshCalculator.Success in case of success
.. versionadded:: 3.12
%End
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/mesh/qgsmeshcalculator.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
|
