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
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
|
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/processing/models/qgsprocessingmodelchildparametersource.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
class QgsProcessingModelChildParameterSource
{
%Docstring(signature="appended")
Source for the value of a parameter for a child algorithm within a
model.
%End
%TypeHeaderCode
#include "qgsprocessingmodelchildparametersource.h"
%End
public:
QgsProcessingModelChildParameterSource();
%Docstring
Constructor for QgsProcessingModelChildParameterSource. It is
recommended that the static methods
:py:func:`~QgsProcessingModelChildParameterSource.fromStaticValue`,
:py:func:`~QgsProcessingModelChildParameterSource.fromModelParameter`,
:py:func:`~QgsProcessingModelChildParameterSource.fromChildOutput` and
:py:func:`~QgsProcessingModelChildParameterSource.fromExpression` are
used instead.
%End
bool operator==( const QgsProcessingModelChildParameterSource &other ) const;
bool operator!=( const QgsProcessingModelChildParameterSource &other ) const;
static QgsProcessingModelChildParameterSource fromStaticValue( const QVariant &value );
%Docstring
Returns a new QgsProcessingModelChildParameterSource which takes its
value from a static ``value``.
.. seealso:: :py:func:`fromModelParameter`
.. seealso:: :py:func:`fromChildOutput`
.. seealso:: :py:func:`fromExpression`
.. seealso:: :py:func:`fromExpressionText`
%End
static QgsProcessingModelChildParameterSource fromModelParameter( const QString ¶meterName );
%Docstring
Returns a new QgsProcessingModelChildParameterSource which takes its
value from a parent model parameter.
.. seealso:: :py:func:`fromStaticValue`
.. seealso:: :py:func:`fromChildOutput`
.. seealso:: :py:func:`fromExpression`
.. seealso:: :py:func:`fromExpressionText`
%End
static QgsProcessingModelChildParameterSource fromChildOutput( const QString &childId, const QString &outputName );
%Docstring
Returns a new QgsProcessingModelChildParameterSource which takes its
value from an output generated by a child algorithm.
.. seealso:: :py:func:`fromStaticValue`
.. seealso:: :py:func:`fromModelParameter`
.. seealso:: :py:func:`fromExpression`
.. seealso:: :py:func:`fromExpressionText`
%End
static QgsProcessingModelChildParameterSource fromExpression( const QString &expression );
%Docstring
Returns a new QgsProcessingModelChildParameterSource which takes its
value from an expression. The expression is evaluated just before the
child algorithm executes, and can use functions available in its
expression context to include results calculated from the child
algorithms already executed by the model.
.. seealso:: :py:func:`fromStaticValue`
.. seealso:: :py:func:`fromChildOutput`
.. seealso:: :py:func:`fromModelParameter`
.. seealso:: :py:func:`fromExpressionText`
.. versionadded:: 3.2
%End
static QgsProcessingModelChildParameterSource fromExpressionText( const QString &text );
%Docstring
Returns a new QgsProcessingModelChildParameterSource which takes its
value from a text with expressions. Expressions are evaluated just
before the child algorithm executes, and can use functions available in
its expression context to include results calculated from the child
algorithms already executed by the model.
.. seealso:: :py:func:`fromStaticValue`
.. seealso:: :py:func:`fromChildOutput`
.. seealso:: :py:func:`fromModelParameter`
.. seealso:: :py:func:`fromExpression`
.. versionadded:: 3.2
%End
Qgis::ProcessingModelChildParameterSource source() const;
%Docstring
Returns the parameter value's source.
%End
void setSource( Qgis::ProcessingModelChildParameterSource source );
%Docstring
Sets the parameter's source.
.. versionadded:: 3.14
%End
QVariant staticValue() const;
%Docstring
Returns the source's static value. This is only used when the
:py:func:`~QgsProcessingModelChildParameterSource.source` is
StaticValue.
.. seealso:: :py:func:`setStaticValue`
%End
void setStaticValue( const QVariant &value );
%Docstring
Sets the source's static value. Calling this will also change the
:py:func:`~QgsProcessingModelChildParameterSource.source` to
StaticValue.
.. seealso:: :py:func:`staticValue`
%End
QString parameterName() const;
%Docstring
Returns the source's model parameter name. This is only used when the
:py:func:`~QgsProcessingModelChildParameterSource.source` is
ModelParameter.
.. seealso:: :py:func:`setParameterName`
%End
void setParameterName( const QString &name );
%Docstring
Sets the source's model parameter ``name``. Calling this will also
change the :py:func:`~QgsProcessingModelChildParameterSource.source` to
ModelParameter.
.. seealso:: :py:func:`parameterName`
%End
QString outputChildId() const;
%Docstring
Returns the source's child algorithm ID from which the output value will
be taken. This is only used when the
:py:func:`~QgsProcessingModelChildParameterSource.source` is
ChildOutput.
.. seealso:: :py:func:`setOutputChildId`
.. seealso:: :py:func:`outputName`
%End
void setOutputChildId( const QString &id );
%Docstring
Sets the source's child algorithm ``id`` from which the output value
will be taken. Calling this will also change the
:py:func:`~QgsProcessingModelChildParameterSource.source` to
ChildOutput.
.. seealso:: :py:func:`parameterName`
.. seealso:: :py:func:`setOutputName`
%End
QString outputName() const;
%Docstring
Returns the source's child algorithm output name from which the output
value will be taken. This is only used when the
:py:func:`~QgsProcessingModelChildParameterSource.source` is
ChildOutput.
.. seealso:: :py:func:`setOutputName`
.. seealso:: :py:func:`outputChildId`
%End
void setOutputName( const QString &name );
%Docstring
Sets the source's child algorithm output ``name`` from which the output
value will be taken. Calling this will also change the
:py:func:`~QgsProcessingModelChildParameterSource.source` to
ChildOutput.
.. seealso:: :py:func:`outputName`
.. seealso:: :py:func:`setOutputChildId`
%End
QString expression() const;
%Docstring
Returns the source's expression. This is only used when the
:py:func:`~QgsProcessingModelChildParameterSource.source` is Expression.
.. seealso:: :py:func:`setExpression`
%End
void setExpression( const QString &expression );
%Docstring
Sets the source's expression. Calling this will also change the
:py:func:`~QgsProcessingModelChildParameterSource.source` to Expression.
The expression is evaluated just before the child algorithm executes,
and can use functions available in its expression context to include
results calculated from the child algorithms already executed by the
model.
.. seealso:: :py:func:`expression`
%End
QString expressionText() const;
%Docstring
Returns the source's text with expressions. This is only used when the
:py:func:`~QgsProcessingModelChildParameterSource.source` is
ExpressionText.
.. seealso:: :py:func:`setExpressionText`
.. versionadded:: 3.2
%End
void setExpressionText( const QString &text );
%Docstring
Sets the source's text containing expressions. Calling this will also
change the :py:func:`~QgsProcessingModelChildParameterSource.source` to
ExpressionText. Expressions are evaluated just before the child
algorithm executes, and can use functions available in its expression
context to include results calculated from the child algorithms already
executed by the model.
.. seealso:: :py:func:`expressionText`
.. versionadded:: 3.2
%End
QVariant toVariant() const;
%Docstring
Saves this source to a QVariant.
.. seealso:: :py:func:`loadVariant`
%End
bool loadVariant( const QVariantMap &map );
%Docstring
Loads this source from a QVariantMap.
.. seealso:: :py:func:`toVariant`
%End
QString asPythonCode( QgsProcessing::PythonOutputType outputType, const QgsProcessingParameterDefinition *definition, const QMap< QString, QString > &friendlyChildNames ) const;
%Docstring
Attempts to convert the source to executable Python code.
The ``friendlyChildNames`` argument gives a map of child id to a
friendly algorithm name, to be used in the code to identify that
algorithm instead of the raw child id.
%End
QString asPythonComment( const QgsProcessingParameterDefinition *definition ) const;
%Docstring
Returns an explanatory Python comment for the source, or an empty string
if no comment is available.
.. versionadded:: 3.20
%End
QString friendlyIdentifier( QgsProcessingModelAlgorithm *model ) const;
%Docstring
Returns a user-friendly identifier for this source, given the context of
the specified ``model``.
.. versionadded:: 3.14
%End
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/processing/models/qgsprocessingmodelchildparametersource.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
|
