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
|
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/processing/models/qgsprocessingmodeloutput.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
class QgsProcessingModelOutput : QgsProcessingModelComponent
{
%Docstring(signature="appended")
Represents a final output created by the model.
%End
%TypeHeaderCode
#include "qgsprocessingmodeloutput.h"
%End
public:
QgsProcessingModelOutput( const QString &name = QString(), const QString &description = QString() );
%Docstring
Constructor for QgsProcessingModelOutput with the specified ``name`` and
``description``.
%End
virtual QgsProcessingModelOutput *clone() const /Factory/;
QString name() const;
%Docstring
Returns the model output name.
.. seealso:: :py:func:`setName`
%End
void setName( const QString &name );
%Docstring
Sets the model output ``name``.
.. seealso:: :py:func:`name`
%End
QVariant defaultValue() const;
%Docstring
Returns the default value for the model output parameter.
.. seealso:: :py:func:`setDefaultValue`
.. versionadded:: 3.2
%End
void setDefaultValue( const QVariant &value );
%Docstring
Sets the default value for the model output.
.. seealso:: :py:func:`defaultValue`
.. versionadded:: 3.2
%End
bool isMandatory() const;
%Docstring
Returns ``True`` if the output is mandatory. This may override the
associated child algorithm's parameter optional status - e.g. allowing
an optional output from an algorithm to be mandatory within a model.
.. seealso:: :py:func:`setMandatory`
.. versionadded:: 3.2
%End
void setMandatory( bool mandatory );
%Docstring
Sets whether the output is ``mandatory``. This may override the
associated child algorithm's parameter optional status - e.g. allowing
an optional output from an algorithm to be mandatory within a model.
.. seealso:: :py:func:`isMandatory`
.. versionadded:: 3.2
%End
QString childId() const;
%Docstring
Returns the child algorithm ID from which this output is generated.
.. seealso:: :py:func:`setChildId`
%End
void setChildId( const QString &id );
%Docstring
Sets the child algorithm ``id`` from which this output is generated.
.. seealso:: :py:func:`childId`
%End
QString childOutputName() const;
%Docstring
Returns the child algorithm output name from which this output is
generated.
.. seealso:: :py:func:`setOutputName`
%End
void setChildOutputName( const QString &name );
%Docstring
Sets the child algorithm output ``name`` from which this output is
generated.
.. seealso:: :py:func:`outputName`
%End
QVariant toVariant() const;
%Docstring
Saves this output to a QVariant.
.. seealso:: :py:func:`loadVariant`
%End
bool loadVariant( const QVariantMap &map );
%Docstring
Loads this output from a QVariantMap.
.. seealso:: :py:func:`toVariant`
%End
virtual QgsProcessingModelComment *comment();
virtual void setComment( const QgsProcessingModelComment &comment );
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/processing/models/qgsprocessingmodeloutput.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
|
