QGIS API Documentation 3.39.0-Master (9ea1ddbe645)
|
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. | |
Configuration settings which control how a Processing model is executed.
Definition at line 37 of file qgsprocessingmodelconfig.h.
|
default |
|
default |
|
inline |
Returns the subset of child algorithms to run (by child ID).
An empty set indicates the entire model should be run.
Definition at line 51 of file qgsprocessingmodelconfig.h.
|
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.
Definition at line 69 of file qgsprocessingmodelconfig.h.
|
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.
Definition at line 87 of file qgsprocessingmodelconfig.h.
QgsMapLayerStore * QgsProcessingModelInitialRunConfig::previousLayerStore | ( | ) |
Returns a reference to a map store containing copies of temporary layers generated during previous model executions.
This may be nullptr
.
Definition at line 25 of file qgsprocessingmodelconfig.cpp.
|
inline |
Returns the set of previously executed child algorithm IDs to use as the initial state when running the model.
Definition at line 104 of file qgsprocessingmodelconfig.h.
|
inline |
Sets the subset of child algorithms to run (by child ID).
An empty set indicates the entire model should be run.
Definition at line 60 of file qgsprocessingmodelconfig.h.
|
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.
Definition at line 78 of file qgsprocessingmodelconfig.h.
|
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.
Definition at line 96 of file qgsprocessingmodelconfig.h.
void QgsProcessingModelInitialRunConfig::setPreviousLayerStore | ( | std::unique_ptr< QgsMapLayerStore > | store | ) |
Sets the map store containing copies of temporary layers generated during previous model executions.
nullptr
thread via a call to QObject::moveToThread. An assert will be triggered if this condition is not met.Definition at line 35 of file qgsprocessingmodelconfig.cpp.
|
inline |
Sets the previously executed child algorithm IDs to use as the initial state when running the model.
Definition at line 112 of file qgsprocessingmodelconfig.h.
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.
Definition at line 30 of file qgsprocessingmodelconfig.cpp.