QGIS API Documentation 3.99.0-Master (2fe06baccd8)
Loading...
Searching...
No Matches
Public Member Functions | List of all members
QgsProcessingModelInitialRunConfig Class Reference
core library

Configuration settings which control how a Processing model is executed. More...

#include <qgsprocessingmodelconfig.h>

Public Member Functions

 QgsProcessingModelInitialRunConfig ()
 ~QgsProcessingModelInitialRunConfig ()
QSet< QString > childAlgorithmSubset () const
 Returns the subset of child algorithms to run (by child ID).
QVariantMap initialChildInputs () const
 Returns the map of child algorithm inputs to use as the initial state when running the model.
QVariantMap initialChildOutputs () const
 Returns the map of child algorithm outputs to use as the initial state when running the model.
QgsMapLayerStore * previousLayerStore ()
 Returns a reference to a map store containing copies of temporary layers generated during previous model executions.
QSet< QString > previouslyExecutedChildAlgorithms () const
 Returns the set of previously executed child algorithm IDs to use as the initial state when running the model.
void setChildAlgorithmSubset (const QSet< QString > &subset)
 Sets the subset of child algorithms to run (by child ID).
void setInitialChildInputs (const QVariantMap &inputs)
 Sets the map of child algorithm inputs to use as the initial state when running the model.
void setInitialChildOutputs (const QVariantMap &outputs)
 Sets the map of child algorithm outputs to use as the initial state when running the model.
void setPreviousLayerStore (std::unique_ptr< QgsMapLayerStore > store)
 Sets the map store containing copies of temporary layers generated during previous model executions.
void setPreviouslyExecutedChildAlgorithms (const QSet< QString > &children)
 Sets the previously executed child algorithm IDs to use as the initial state when running the model.
std::unique_ptr< QgsMapLayerStore > takePreviousLayerStore ()
 Takes the map store containing copies of temporary layers generated during previous model executions.

Detailed Description

Configuration settings which control how a Processing model is executed.

Note
Not available in Python bindings.
Since
QGIS 3.38

Definition at line 38 of file qgsprocessingmodelconfig.h.

Constructor & Destructor Documentation

◆ QgsProcessingModelInitialRunConfig()

QgsProcessingModelInitialRunConfig::QgsProcessingModelInitialRunConfig ( )
default

◆ ~QgsProcessingModelInitialRunConfig()

QgsProcessingModelInitialRunConfig::~QgsProcessingModelInitialRunConfig ( )
default

Member Function Documentation

◆ childAlgorithmSubset()

QSet< QString > QgsProcessingModelInitialRunConfig::childAlgorithmSubset ( ) const
inline

Returns the subset of child algorithms to run (by child ID).

An empty set indicates the entire model should be run.

See also
setChildAlgorithmSubset()

Definition at line 52 of file qgsprocessingmodelconfig.h.

◆ initialChildInputs()

QVariantMap QgsProcessingModelInitialRunConfig::initialChildInputs ( ) const
inline

Returns the map of child algorithm inputs to use as the initial state when running the model.

Map keys refer to the child algorithm IDs.

See also
setInitialChildInputs()

Definition at line 70 of file qgsprocessingmodelconfig.h.

◆ initialChildOutputs()

QVariantMap QgsProcessingModelInitialRunConfig::initialChildOutputs ( ) const
inline

Returns the map of child algorithm outputs to use as the initial state when running the model.

Map keys refer to the child algorithm IDs.

See also
setInitialChildOutputs()

Definition at line 88 of file qgsprocessingmodelconfig.h.

◆ previousLayerStore()

QgsMapLayerStore * QgsProcessingModelInitialRunConfig::previousLayerStore ( )

Returns a reference to a map store containing copies of temporary layers generated during previous model executions.

This may be nullptr.

See also
setPreviousLayerStore()
takePreviousLayerStore()

Definition at line 26 of file qgsprocessingmodelconfig.cpp.

◆ previouslyExecutedChildAlgorithms()

QSet< QString > QgsProcessingModelInitialRunConfig::previouslyExecutedChildAlgorithms ( ) const
inline

Returns the set of previously executed child algorithm IDs to use as the initial state when running the model.

See also
setPreviouslyExecutedChildAlgorithms()

Definition at line 105 of file qgsprocessingmodelconfig.h.

◆ setChildAlgorithmSubset()

void QgsProcessingModelInitialRunConfig::setChildAlgorithmSubset ( const QSet< QString > & subset)
inline

Sets the subset of child algorithms to run (by child ID).

An empty set indicates the entire model should be run.

See also
childAlgorithmSubset()

Definition at line 61 of file qgsprocessingmodelconfig.h.

◆ setInitialChildInputs()

void QgsProcessingModelInitialRunConfig::setInitialChildInputs ( const QVariantMap & inputs)
inline

Sets the map of child algorithm inputs to use as the initial state when running the model.

Map keys refer to the child algorithm IDs.

See also
initialChildInputs()

Definition at line 79 of file qgsprocessingmodelconfig.h.

◆ setInitialChildOutputs()

void QgsProcessingModelInitialRunConfig::setInitialChildOutputs ( const QVariantMap & outputs)
inline

Sets the map of child algorithm outputs to use as the initial state when running the model.

Map keys refer to the child algorithm IDs.

See also
initialChildOutputs()

Definition at line 97 of file qgsprocessingmodelconfig.h.

◆ setPreviousLayerStore()

void QgsProcessingModelInitialRunConfig::setPreviousLayerStore ( std::unique_ptr< QgsMapLayerStore > store)

Sets the map store containing copies of temporary layers generated during previous model executions.

Warning
store must have previous been moved to a nullptr thread via a call to QObject::moveToThread. An assert will be triggered if this condition is not met.
See also
previousLayerStore()
takePreviousLayerStore()

Definition at line 36 of file qgsprocessingmodelconfig.cpp.

◆ setPreviouslyExecutedChildAlgorithms()

void QgsProcessingModelInitialRunConfig::setPreviouslyExecutedChildAlgorithms ( const QSet< QString > & children)
inline

Sets the previously executed child algorithm IDs to use as the initial state when running the model.

See also
previouslyExecutedChildAlgorithms()

Definition at line 113 of file qgsprocessingmodelconfig.h.

◆ takePreviousLayerStore()

std::unique_ptr< QgsMapLayerStore > QgsProcessingModelInitialRunConfig::takePreviousLayerStore ( )

Takes the map store containing copies of temporary layers generated during previous model executions.

May return nullptr if this is not available.

See also
previousLayerStore()
setPreviousLayerStore()

Definition at line 31 of file qgsprocessingmodelconfig.cpp.

The documentation for this class was generated from the following files:
Generated on for QGIS API Documentation by doxygen 1.15.0