18 #ifndef QGSPROCESSINGCONTEXT_H
19 #define QGSPROCESSINGCONTEXT_H
21 #include "qgis_core.h"
56 Q_DECLARE_FLAGS( Flags, Flag )
87 mFlags = other.mFlags;
88 mProject = other.mProject;
89 mTransformContext = other.mTransformContext;
90 mExpressionContext = other.mExpressionContext;
91 mInvalidGeometryCallback = other.mInvalidGeometryCallback;
92 mUseDefaultInvalidGeometryCallback = other.mUseDefaultInvalidGeometryCallback;
93 mInvalidGeometryCheck = other.mInvalidGeometryCheck;
94 mTransformErrorCallback = other.mTransformErrorCallback;
95 mDefaultEncoding = other.mDefaultEncoding;
96 mFeedback = other.mFeedback;
97 mPreferredVectorFormat = other.mPreferredVectorFormat;
98 mPreferredRasterFormat = other.mPreferredRasterFormat;
99 mEllipsoid = other.mEllipsoid;
100 mDistanceUnit = other.mDistanceUnit;
101 mAreaUnit = other.mAreaUnit;
102 mLogLevel = other.mLogLevel;
109 QgsProcessingContext::Flags
flags()
const {
return mFlags; }
115 void setFlags( QgsProcessingContext::Flags flags ) { mFlags = flags; }
137 if ( mEllipsoid.isEmpty() )
138 mEllipsoid = mProject->ellipsoid();
140 mDistanceUnit = mProject->distanceUnits();
142 mAreaUnit = mProject->areaUnits();
183 QString ellipsoid()
const;
193 void setEllipsoid(
const QString &ellipsoid );
241 QgsDateTimeRange currentTimeRange()
const;
249 void setCurrentTimeRange(
const QgsDateTimeRange ¤tTimeRange );
271 , outputName( outputName )
272 , layerTypeHint( layerTypeHint )
292 bool forceName =
false;
328 void setOutputLayerName(
QgsMapLayer *layer )
const;
349 return mLayersToLoadOnCompletion;
363 return mLayersToLoadOnCompletion.contains( layer );
373 void setLayersToLoadOnCompletion(
const QMap< QString, QgsProcessingContext::LayerDetails > &layers );
400 return mLayersToLoadOnCompletion[ layer ];
427 void setInvalidGeometryCallback( SIP_PYCALLABLE / AllowNone / );
429 Py_BEGIN_ALLOW_THREADS
431 sipCpp->setInvalidGeometryCallback( [a0](
const QgsFeature &arg )
434 Py_XDECREF( sipCallMethod( NULL, a0,
"D", &arg, sipType_QgsFeature, NULL ) );
468 void setTransformErrorCallback( SIP_PYCALLABLE / AllowNone / );
470 Py_BEGIN_ALLOW_THREADS
472 sipCpp->setTransformErrorCallback( [a0](
const QgsFeature &arg )
475 Py_XDECREF( sipCallMethod( NULL, a0,
"D", &arg, sipType_QgsFeature, NULL ) );
524 QThread *
thread() {
return tempLayerStore.thread(); }
535 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" );
536 tempLayerStore.moveToThread( thread );
558 QgsMapLayer *getMapLayer(
const QString &identifier );
650 LogLevel logLevel()
const;
658 void setLogLevel( LogLevel level );
662 QgsProcessingContext::Flags mFlags = QgsProcessingContext::Flags();
663 QPointer< QgsProject > mProject;
670 QgsDateTimeRange mCurrentTimeRange;
677 bool mUseDefaultInvalidGeometryCallback =
true;
678 std::function< void(
const QgsFeature & ) > mInvalidGeometryCallback;
680 std::function< void(
const QgsFeature & ) > mTransformErrorCallback;
681 QString mDefaultEncoding;
682 QMap< QString, LayerDetails > mLayersToLoadOnCompletion;
684 QPointer< QgsProcessingFeedback > mFeedback;
686 QString mPreferredVectorFormat;
687 QString mPreferredRasterFormat;
689 LogLevel mLogLevel = DefaultLevel;
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...
InvalidGeometryCheck
Handling of features with invalid geometries.
@ GeometryNoCheck
No invalid geometry checking.
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.
LayerDetails()=default
Default constructor.
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.
QgsMapLayerStore * temporaryLayerStore()
Returns a reference to the layer store used for storing temporary layers during algorithm execution.
QString preferredRasterFormat() const
Returns the preferred raster format to use for vector outputs.
QgsProcessingContext::Flags flags() const
Returns any flags set in the context.
LogLevel
Logging level for algorithms to use when pushing feedback messages.
@ Verbose
Verbose logging.
std::function< void(const QgsFeature &) > transformErrorCallback() const
Returns the callback function to use when encountering a transform error when iterating features.
QgsCoordinateTransformContext transformContext() const
Returns the coordinate transform context.
QgsExpressionContext & expressionContext()
Returns the expression context.
QgsProcessingContext(const QgsProcessingContext &other)=delete
QgsProcessingContext cannot be copied.
void setDefaultEncoding(const QString &encoding)
Sets the default encoding to use for newly created files.
QThread * thread()
Returns the thread in which the context lives.
void setFeedback(QgsProcessingFeedback *feedback)
Sets an associated feedback object.
void setExpressionContext(const QgsExpressionContext &context)
Sets the expression context.
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.
QgsProcessingFeedback * feedback()
Returns the associated feedback object.
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...
const QgsExpressionContext & expressionContext() const
Returns the expression context.
QgsFeatureRequest::InvalidGeometryCheck invalidGeometryCheck() const
Returns the behavior used for checking invalid geometries in input layers.
void copyThreadSafeSettings(const QgsProcessingContext &other)
Copies all settings which are safe for use across different threads from other to this context.
QgsProcessingContext & operator=(const QgsProcessingContext &other)=delete
QgsProcessingContext cannot be copied.
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.
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.
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...
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.
LayerHint
Layer type hints.
@ UnknownType
Unknown layer type.
Encapsulates a QGIS project, including sets of map layers and their styles, layouts,...
QgsCoordinateTransformContext transformContext
DistanceUnit
Units of distance.
@ DistanceUnknownUnit
Unknown distance unit.
@ AreaUnknownUnit
Unknown areal unit.
Q_DECLARE_OPERATORS_FOR_FLAGS(QgsField::ConfigurationFlags) CORE_EXPORT QDataStream &operator<<(QDataStream &out
Writes the field to stream out. QGIS version compatibility is not guaranteed.