File: qgsprocessingmodelresult.sip.in

package info (click to toggle)
qgis 3.40.11%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 1,183,800 kB
  • sloc: cpp: 1,595,841; python: 372,637; 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: 154
file content (147 lines) | stat: -rw-r--r-- 3,718 bytes parent folder | download | duplicates (14)
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
/************************************************************************
 * This file has been generated automatically from                      *
 *                                                                      *
 * src/core/processing/models/qgsprocessingmodelresult.h                *
 *                                                                      *
 * Do not edit manually ! Edit header and run scripts/sipify.py again   *
 ************************************************************************/




class QgsProcessingModelChildAlgorithmResult
{
%Docstring(signature="appended")
Encapsulates the results of running a child algorithm within a model

.. versionadded:: 3.38
%End

%TypeHeaderCode
#include "qgsprocessingmodelresult.h"
%End
  public:

    QgsProcessingModelChildAlgorithmResult();

    Qgis::ProcessingModelChildAlgorithmExecutionStatus executionStatus() const;
%Docstring
Returns the status of executing the child algorithm.

.. seealso:: :py:func:`setExecutionStatus`
%End

    void setExecutionStatus( Qgis::ProcessingModelChildAlgorithmExecutionStatus status );
%Docstring
Sets the ``status`` of executing the child algorithm.

.. seealso:: :py:func:`executionStatus`
%End

    QVariantMap inputs() const;
%Docstring
Returns the inputs used for the child algorithm.

.. seealso:: :py:func:`setInputs`
%End

    void setInputs( const QVariantMap &inputs );
%Docstring
Sets the ``inputs`` used for the child algorithm.

.. seealso:: :py:func:`inputs`
%End

    QVariantMap outputs() const;
%Docstring
Returns the outputs generated by the child algorithm.

.. seealso:: :py:func:`setOutputs`
%End

    void setOutputs( const QVariantMap &outputs );
%Docstring
Sets the ``outputs`` generated by child algorithm.

.. seealso:: :py:func:`outputs`
%End

    QString htmlLog() const;
%Docstring
Returns the HTML formatted contents of logged messages which occurred
while running the child.

.. seealso:: :py:func:`setHtmlLog`
%End

    void setHtmlLog( const QString &log );
%Docstring
Sets the HTML formatted contents of logged messages which occurred while
running the child.

.. seealso:: :py:func:`htmlLog`
%End

    bool operator==( const QgsProcessingModelChildAlgorithmResult &other ) const;
    bool operator!=( const QgsProcessingModelChildAlgorithmResult &other ) const;

};

class QgsProcessingModelResult
{
%Docstring(signature="appended")
Encapsulates the results of running a Processing model

.. versionadded:: 3.38
%End

%TypeHeaderCode
#include "qgsprocessingmodelresult.h"
%End
  public:

    QgsProcessingModelResult();

    void clear();
%Docstring
Clears any existing results.
%End

    void mergeWith( const QgsProcessingModelResult &other );
%Docstring
Merges this set of results with an ``other`` set of results.

Conflicting results from ``other`` will replace results in this object.
%End

    QMap< QString, QgsProcessingModelChildAlgorithmResult > childResults() const;
%Docstring
Returns the map of child algorithm results.

Map keys refer to the child algorithm IDs.
%End





    QSet< QString > executedChildIds() const;
%Docstring
Returns the set of child algorithm IDs which were executed during the
model execution.
%End

};






/************************************************************************
 * This file has been generated automatically from                      *
 *                                                                      *
 * src/core/processing/models/qgsprocessingmodelresult.h                *
 *                                                                      *
 * Do not edit manually ! Edit header and run scripts/sipify.py again   *
 ************************************************************************/