QgsProcessingModelInitialRunConfig Class Reference

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 37 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 51 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 69 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 87 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 25 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 104 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 60 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 78 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 96 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 35 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 112 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 30 of file qgsprocessingmodelconfig.cpp.

---

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

• /build/qgis-3.41.0+git20241116+25ec5511245+99sid/src/core/processing/models/qgsprocessingmodelconfig.h
• /build/qgis-3.41.0+git20241116+25ec5511245+99sid/src/core/processing/models/qgsprocessingmodelconfig.cpp