QgsProcessingModelResult Class Reference

Encapsulates the results of running a Processing model. More...

#include <qgsprocessingmodelresult.h>

Public Member Functions
	QgsProcessingModelResult ()
QMap< QString, QgsProcessingModelChildAlgorithmResult > &	childResults ()
	Returns a reference to the map of child algorithm results.
QMap< QString, QgsProcessingModelChildAlgorithmResult >	childResults () const
	Returns the map of child algorithm results.
void	clear ()
	Clears any existing results.
QSet< QString > &	executedChildIds ()
	Returns a reference to the set of child algorithm IDs which were executed during the model execution.
QSet< QString >	executedChildIds () const
	Returns the set of child algorithm IDs which were executed during the model execution.
void	mergeWith (const QgsProcessingModelResult &other)
	Merges this set of results with an other set of results.
QVariantMap &	rawChildInputs ()
	Returns a reference to the map of raw child algorithm inputs.
QVariantMap &	rawChildOutputs ()
	Returns a reference to the map of raw child algorithm outputs.

Detailed Description

Encapsulates the results of running a Processing model.

Since

QGIS 3.38

Definition at line 120 of file qgsprocessingmodelresult.h.

Constructor & Destructor Documentation

QgsProcessingModelResult()

QgsProcessingModelResult::QgsProcessingModelResult ( )

default

Member Function Documentation

childResults() [1/2]

QMap< QString, QgsProcessingModelChildAlgorithmResult > & QgsProcessingModelResult::childResults ( )

inline

Returns a reference to the map of child algorithm results.

Map keys refer to the child algorithm IDs.

Note

Not available in Python bindings

Definition at line 152 of file qgsprocessingmodelresult.h.

childResults() [2/2]

QMap< QString, QgsProcessingModelChildAlgorithmResult > QgsProcessingModelResult::childResults ( ) const

inline

Returns the map of child algorithm results.

Map keys refer to the child algorithm IDs.

Definition at line 143 of file qgsprocessingmodelresult.h.

clear()

void QgsProcessingModelResult::clear

(

)

Clears any existing results.

Definition at line 33 of file qgsprocessingmodelresult.cpp.

executedChildIds() [1/2]

QSet< QString > & QgsProcessingModelResult::executedChildIds ( )

inline

Returns a reference to the set of child algorithm IDs which were executed during the model execution.

Note

Not available in Python bindings

Definition at line 180 of file qgsprocessingmodelresult.h.

executedChildIds() [2/2]

QSet< QString > QgsProcessingModelResult::executedChildIds ( ) const

inline

Returns the set of child algorithm IDs which were executed during the model execution.

Definition at line 185 of file qgsprocessingmodelresult.h.

mergeWith()

void QgsProcessingModelResult::mergeWith

(

const QgsProcessingModelResult &

other

)

Merges this set of results with an other set of results.

Conflicting results from other will replace results in this object.

Definition at line 41 of file qgsprocessingmodelresult.cpp.

rawChildInputs()

QVariantMap & QgsProcessingModelResult::rawChildInputs ( )

inline

Returns a reference to the map of raw child algorithm inputs.

Map keys refer to the child algorithm IDs. Map values may take any form, including values which are not safe to access from Python.

Note

Not available in Python bindings

Definition at line 162 of file qgsprocessingmodelresult.h.

rawChildOutputs()

QVariantMap & QgsProcessingModelResult::rawChildOutputs ( )

inline

Returns a reference to the map of raw child algorithm outputs.

Map keys refer to the child algorithm IDs. Map values may take any form, including values which are not safe to access from Python.

Note

Not available in Python bindings

Definition at line 172 of file qgsprocessingmodelresult.h.

---

The documentation for this class was generated from the following files:

• /build/qgis-3.39.0+git20240703+47f7b3a4989+99sid/src/core/processing/models/qgsprocessingmodelresult.h
• /build/qgis-3.39.0+git20240703+47f7b3a4989+99sid/src/core/processing/models/qgsprocessingmodelresult.cpp