QGIS API Documentation 3.41.0-Master (af5edcb665c)
Loading...
Searching...
No Matches
qgsprocessingmodelconfig.h
Go to the documentation of this file.
1/***************************************************************************
2 qgsprocessingmodelconfig.h
3 ----------------------
4 begin : April 2024
5 copyright : (C) 2024 by Nyall Dawson
6 email : nyall dot dawson at gmail dot com
7 ***************************************************************************/
8
9/***************************************************************************
10 * *
11 * This program is free software; you can redistribute it and/or modify *
12 * it under the terms of the GNU General Public License as published by *
13 * the Free Software Foundation; either version 2 of the License, or *
14 * (at your option) any later version. *
15 * *
16 ***************************************************************************/
17
18#ifndef QGSPROCESSINGMODELCONFIG_H
19#define QGSPROCESSINGMODELCONFIG_H
20
21#include "qgis_core.h"
22#include "qgis.h"
23#include <QSet>
24
25#define SIP_NO_FILE
26
28
38{
39 public:
40
43
51 QSet<QString> childAlgorithmSubset() const { return mChildAlgorithmSubset; }
52
60 void setChildAlgorithmSubset( const QSet<QString> &subset ) { mChildAlgorithmSubset = subset; }
61
69 QVariantMap initialChildInputs() const { return mInitialChildInputs; }
70
78 void setInitialChildInputs( const QVariantMap &inputs ) { mInitialChildInputs = inputs; }
79
87 QVariantMap initialChildOutputs() const { return mInitialChildOutputs; }
88
96 void setInitialChildOutputs( const QVariantMap &outputs ) { mInitialChildOutputs = outputs; }
97
104 QSet< QString > previouslyExecutedChildAlgorithms() const { return mPreviouslyExecutedChildren; }
105
112 void setPreviouslyExecutedChildAlgorithms( const QSet< QString > &children ) { mPreviouslyExecutedChildren = children; }
113
123 QgsMapLayerStore *previousLayerStore();
124
134 std::unique_ptr< QgsMapLayerStore > takePreviousLayerStore();
135
146 void setPreviousLayerStore( std::unique_ptr< QgsMapLayerStore > store );
147
148 private:
149
150 QSet<QString> mChildAlgorithmSubset;
151 QVariantMap mInitialChildInputs;
152 QVariantMap mInitialChildOutputs;
153 QSet< QString > mPreviouslyExecutedChildren;
154
155 std::unique_ptr< QgsMapLayerStore > mModelInitialLayerStore;
156
157
158};
159
160#endif // QGSPROCESSINGMODELCONFIG_H
A storage object for map layers, in which the layers are owned by the store and have their lifetime b...
Configuration settings which control how a Processing model is executed.
void setChildAlgorithmSubset(const QSet< QString > &subset)
Sets the subset of child algorithms to run (by child ID).
QSet< QString > previouslyExecutedChildAlgorithms() const
Returns the set of previously executed child algorithm IDs to use as the initial state when running t...
QSet< QString > childAlgorithmSubset() const
Returns 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.
QVariantMap initialChildOutputs() const
Returns the map of child algorithm outputs to use as the initial state when running the model.
QVariantMap initialChildInputs() const
Returns the map of child algorithm inputs to use as the initial state when running the model.
void setPreviouslyExecutedChildAlgorithms(const QSet< QString > &children)
Sets the previously executed child algorithm IDs to use as the initial state when running the model.