QGIS API Documentation 3.39.0-Master (47f7b3a4989)
Loading...
Searching...
No Matches
Public Member Functions | List of all members
QgsProcessingModelChildAlgorithmResult Class Reference

Encapsulates the results of running a child algorithm within a model. More...

#include <qgsprocessingmodelresult.h>

Public Member Functions

 QgsProcessingModelChildAlgorithmResult ()
 
Qgis::ProcessingModelChildAlgorithmExecutionStatus executionStatus () const
 Returns the status of executing the child algorithm.
 
QString htmlLog () const
 Returns the HTML formatted contents of logged messages which occurred while running the child.
 
QVariantMap inputs () const
 Returns the inputs used for the child algorithm.
 
bool operator!= (const QgsProcessingModelChildAlgorithmResult &other) const
 
bool operator== (const QgsProcessingModelChildAlgorithmResult &other) const
 
QVariantMap outputs () const
 Returns the outputs generated by the child algorithm.
 
void setExecutionStatus (Qgis::ProcessingModelChildAlgorithmExecutionStatus status)
 Sets the status of executing the child algorithm.
 
void setHtmlLog (const QString &log)
 Sets the HTML formatted contents of logged messages which occurred while running the child.
 
void setInputs (const QVariantMap &inputs)
 Sets the inputs used for the child algorithm.
 
void setOutputs (const QVariantMap &outputs)
 Sets the outputs generated by child algorithm.
 

Detailed Description

Encapsulates the results of running a child algorithm within a model.

Since
QGIS 3.38

Definition at line 31 of file qgsprocessingmodelresult.h.

Constructor & Destructor Documentation

◆ QgsProcessingModelChildAlgorithmResult()

QgsProcessingModelChildAlgorithmResult::QgsProcessingModelChildAlgorithmResult ( )
default

Member Function Documentation

◆ executionStatus()

Qgis::ProcessingModelChildAlgorithmExecutionStatus QgsProcessingModelChildAlgorithmResult::executionStatus ( ) const
inline

Returns the status of executing the child algorithm.

See also
setExecutionStatus()

Definition at line 42 of file qgsprocessingmodelresult.h.

◆ htmlLog()

QString QgsProcessingModelChildAlgorithmResult::htmlLog ( ) const
inline

Returns the HTML formatted contents of logged messages which occurred while running the child.

See also
setHtmlLog()

Definition at line 84 of file qgsprocessingmodelresult.h.

◆ inputs()

QVariantMap QgsProcessingModelChildAlgorithmResult::inputs ( ) const
inline

Returns the inputs used for the child algorithm.

See also
setInputs()

Definition at line 56 of file qgsprocessingmodelresult.h.

◆ operator!=()

bool QgsProcessingModelChildAlgorithmResult::operator!= ( const QgsProcessingModelChildAlgorithmResult other) const
inline

Definition at line 100 of file qgsprocessingmodelresult.h.

◆ operator==()

bool QgsProcessingModelChildAlgorithmResult::operator== ( const QgsProcessingModelChildAlgorithmResult other) const
inline

Definition at line 93 of file qgsprocessingmodelresult.h.

◆ outputs()

QVariantMap QgsProcessingModelChildAlgorithmResult::outputs ( ) const
inline

Returns the outputs generated by the child algorithm.

See also
setOutputs()

Definition at line 70 of file qgsprocessingmodelresult.h.

◆ setExecutionStatus()

void QgsProcessingModelChildAlgorithmResult::setExecutionStatus ( Qgis::ProcessingModelChildAlgorithmExecutionStatus  status)
inline

Sets the status of executing the child algorithm.

See also
executionStatus()

Definition at line 49 of file qgsprocessingmodelresult.h.

◆ setHtmlLog()

void QgsProcessingModelChildAlgorithmResult::setHtmlLog ( const QString &  log)
inline

Sets the HTML formatted contents of logged messages which occurred while running the child.

See also
htmlLog()

Definition at line 91 of file qgsprocessingmodelresult.h.

◆ setInputs()

void QgsProcessingModelChildAlgorithmResult::setInputs ( const QVariantMap &  inputs)
inline

Sets the inputs used for the child algorithm.

See also
inputs()

Definition at line 63 of file qgsprocessingmodelresult.h.

◆ setOutputs()

void QgsProcessingModelChildAlgorithmResult::setOutputs ( const QVariantMap &  outputs)
inline

Sets the outputs generated by child algorithm.

See also
outputs()

Definition at line 77 of file qgsprocessingmodelresult.h.


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