18#ifndef QGSPROCESSINGCONTEXT_H
19#define QGSPROCESSINGCONTEXT_H
69 mFlags = other.mFlags;
70 mProject = other.mProject;
71 mTransformContext = other.mTransformContext;
72 mExpressionContext = other.mExpressionContext;
74 mInvalidGeometryCallback = other.mInvalidGeometryCallback;
75 mUseDefaultInvalidGeometryCallback = other.mUseDefaultInvalidGeometryCallback;
76 mInvalidGeometryCheck = other.mInvalidGeometryCheck;
77 mTransformErrorCallback = other.mTransformErrorCallback;
78 mDefaultEncoding = other.mDefaultEncoding;
79 mFeedback = other.mFeedback;
80 mPreferredVectorFormat = other.mPreferredVectorFormat;
81 mPreferredRasterFormat = other.mPreferredRasterFormat;
82 mEllipsoid = other.mEllipsoid;
83 mDistanceUnit = other.mDistanceUnit;
84 mAreaUnit = other.mAreaUnit;
85 mLogLevel = other.mLogLevel;
86 mTemporaryFolderOverride = other.mTemporaryFolderOverride;
87 mMaximumThreads = other.mMaximumThreads;
88 mModelResult = other.mModelResult;
122 mTransformContext = mProject->transformContext();
123 if ( mEllipsoid.isEmpty() )
124 mEllipsoid = mProject->ellipsoid();
126 mDistanceUnit = mProject->distanceUnits();
128 mAreaUnit = mProject->areaUnits();
179 void setEllipsoid( const QString &ellipsoid )
SIP_HOLDGIL;
256 , outputName( outputName )
257 , layerTypeHint( layerTypeHint )
276 bool forceName =
false;
297 int layerSortKey = 0;
328 void setOutputLayerName(
QgsMapLayer *layer )
const;
349 return mLayersToLoadOnCompletion;
363 return mLayersToLoadOnCompletion.contains( layer );
373 void setLayersToLoadOnCompletion(
const QMap< QString, QgsProcessingContext::LayerDetails > &layers )
SIP_HOLDGIL;
400 return mLayersToLoadOnCompletion[ layer ];
426 void setInvalidGeometryCallback( SIP_PYCALLABLE / AllowNone / );
428 Py_BEGIN_ALLOW_THREADS
430 sipCpp->setInvalidGeometryCallback( [a0](
const QgsFeature &arg )
433 Py_XDECREF( sipCallMethod( NULL, a0,
"D", &arg, sipType_QgsFeature, NULL ) );
465 void setTransformErrorCallback( SIP_PYCALLABLE / AllowNone / );
467 Py_BEGIN_ALLOW_THREADS
469 sipCpp->setTransformErrorCallback( [a0](
const QgsFeature &arg )
472 Py_XDECREF( sipCallMethod( NULL, a0,
"D", &arg, sipType_QgsFeature, NULL ) );
531 Q_ASSERT_X( QThread::currentThread() ==
QgsProcessingContext::thread(),
"QgsProcessingContext::pushToThread",
"Cannot push context to another thread unless the current thread matches the existing context thread affinity" );
532 tempLayerStore.moveToThread( thread );
554 QgsMapLayer *getMapLayer(
const QString &identifier );
676 void setTemporaryFolder( const QString &folder )
SIP_HOLDGIL;
722 IncludeProjectPath = 1 << 0,
800 QPointer< QgsProject > mProject;
814 bool mUseDefaultInvalidGeometryCallback =
true;
815 std::function< void(
const QgsFeature & ) > mInvalidGeometryCallback;
817 std::function< void(
const QgsFeature & ) > mTransformErrorCallback;
818 QString mDefaultEncoding;
819 QMap< QString, LayerDetails > mLayersToLoadOnCompletion;
821 QPointer< QgsProcessingFeedback > mFeedback;
823 QString mPreferredVectorFormat;
824 QString mPreferredRasterFormat;
828 QString mTemporaryFolderOverride;
829 int mMaximumThreads = QThread::idealThreadCount();
831 std::unique_ptr< QgsProcessingModelInitialRunConfig > mModelConfig;
The Qgis class provides global constants for use throughout the application.
DistanceUnit
Units of distance.
@ Unknown
Unknown distance unit.
@ Unknown
Unknown areal unit.
InvalidGeometryCheck
Methods for handling of features with invalid geometries.
@ NoCheck
No invalid geometry checking.
ProcessingLogLevel
Logging level for algorithms to use when pushing feedback messages.
@ DefaultLevel
Default logging level.
Contains information about the context in which a coordinate transform is executed.
Expression contexts are used to encapsulate the parameters around which a QgsExpression should be eva...
void setLoadedLayerStore(QgsMapLayerStore *store)
Sets the destination layer store for any layers loaded during expression evaluation.
An interface for objects which provide features via a getFeatures method.
The feature class encapsulates a single feature including its unique ID, geometry and a list of field...
A storage object for map layers, in which the layers are owned by the store and have their lifetime b...
Base class for all map layer types.
Details for layers to load into projects.
QString groupName
Optional name for a layer tree group under which to place the layer when loading it into a project.
QString name
Friendly name for layer, possibly for use when loading layer into project.
LayerDetails(const QString &name, QgsProject *project, const QString &outputName=QString(), QgsProcessingUtils::LayerHint layerTypeHint=QgsProcessingUtils::LayerHint::UnknownType)
Constructor for LayerDetails.
QString outputName
Associated output name from algorithm which generated the layer.
Contains information about the context in which a processing algorithm is executed.
QString defaultEncoding() const
Returns the default encoding to use for newly created files.
QThread * thread()
Returns the thread in which the context lives.
QgsProcessingContext::LayerDetails & layerToLoadOnCompletionDetails(const QString &layer)
Returns a reference to the details for a given layer which is loaded on completion of the algorithm o...
QgsProcessingModelResult & modelResult()
Returns a reference to the model results, populated when the context is used to run a model algorithm...
QgsProcessingFeedback * feedback()
Returns the associated feedback object.
QString preferredRasterFormat() const
Returns the preferred raster format to use for vector outputs.
QgsProcessingContext::Flags flags() const
Returns any flags set in the context.
ProcessArgumentFlag
Flags controlling the results given by asQgisProcessArguments().
QFlags< ProcessArgumentFlag > ProcessArgumentFlags
QgsExpressionContext & expressionContext()
Returns the expression context.
QgsCoordinateTransformContext transformContext() const
Returns the coordinate transform context.
const QgsExpressionContext & expressionContext() const
Returns the expression context.
QgsProcessingContext(const QgsProcessingContext &other)=delete
void setDefaultEncoding(const QString &encoding)
Sets the default encoding to use for newly created files.
void setFeedback(QgsProcessingFeedback *feedback)
Sets an associated feedback object.
void setFlags(QgsProcessingContext::Flags flags)
Sets flags for the context.
void setProject(QgsProject *project)
Sets the project in which the algorithm will be executed.
QgsProject * project() const
Returns the project in which the algorithm is being executed.
QMap< QString, QgsProcessingContext::LayerDetails > layersToLoadOnCompletion() const
Returns a map of layers (by ID or datasource) to LayerDetails, to load into the canvas upon completio...
void pushToThread(QThread *thread)
Pushes the thread affinity for the context (including all layers contained in the temporaryLayerStore...
Flag
Flags that affect how processing algorithms are run.
Qgis::InvalidGeometryCheck invalidGeometryCheck() const
Returns the behavior used for checking invalid geometries in input layers.
bool willLoadLayerOnCompletion(const QString &layer) const
Returns true if the given layer (by ID or datasource) will be loaded into the current project upon co...
void copyThreadSafeSettings(const QgsProcessingContext &other)
Copies all settings which are safe for use across different threads from other to this context.
void setInvalidGeometryCallback(const std::function< void(const QgsFeature &) > &callback)
Sets a callback function to use when encountering an invalid geometry and invalidGeometryCheck() is s...
void setPreferredVectorFormat(const QString &format)
Sets the preferred vector format to use for vector outputs.
void setTransformContext(const QgsCoordinateTransformContext &context)
Sets the coordinate transform context.
QgsProcessingContext & operator=(const QgsProcessingContext &other)=delete
void setTransformErrorCallback(const std::function< void(const QgsFeature &) > &callback)
Sets a callback function to use when encountering a transform error when iterating features.
QString preferredVectorFormat() const
Returns the preferred vector format to use for vector outputs.
std::function< void(const QgsFeature &) > transformErrorCallback() const
Returns the callback function to use when encountering a transform error when iterating features.
void setPreferredRasterFormat(const QString &format)
Sets the preferred raster format to use for vector outputs.
Base class for providing feedback from a processing algorithm.
An interface for layer post-processing handlers for execution following a processing algorithm operat...
virtual ~QgsProcessingLayerPostProcessorInterface()=default
virtual void postProcessLayer(QgsMapLayer *layer, QgsProcessingContext &context, QgsProcessingFeedback *feedback)=0
Post-processes the specified layer, following successful execution of a processing algorithm.
Configuration settings which control how a Processing model is executed.
Encapsulates the results of running a Processing model.
LayerHint
Layer type hints.
@ UnknownType
Unknown layer type.
Encapsulates a QGIS project, including sets of map layers and their styles, layouts,...
#define SIP_ENUM_BASETYPE(type)
Q_DECLARE_OPERATORS_FOR_FLAGS(QgsTextRendererUtils::CurvedTextFlags)