An interface for layer post-processing handlers for execution following a processing algorithm operation. More...

#include <qgsprocessingcontext.h>

Public Member Functions
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.

Detailed Description

An interface for layer post-processing handlers for execution following a processing algorithm operation.

Note that post-processing of a layer will ONLY occur if that layer is set to be loaded into a QGIS project on algorithm completion. See QgsProcessingContext::layersToLoadOnCompletion().

Algorithms that wish to set post-processing steps for generated layers should implement this interface in a separate class (NOT the algorithm class itself!).

Since: QGIS 3.2

Definition at line 855 of file qgsprocessingcontext.h.

Constructor & Destructor Documentation

◆ ~QgsProcessingLayerPostProcessorInterface()

virtual QgsProcessingLayerPostProcessorInterface::~QgsProcessingLayerPostProcessorInterface ( )

virtualdefault

Member Function Documentation

◆ postProcessLayer()

virtual void QgsProcessingLayerPostProcessorInterface::postProcessLayer	(	QgsMapLayer *	layer,
		QgsProcessingContext &	context,
		QgsProcessingFeedback *	feedback
	)

pure virtual

Post-processes the specified layer, following successful execution of a processing algorithm.

This method always runs in the main thread and can be used to setup renderers, editor widgets, metadata, etc for the given layer.

Post-processing classes can utilize settings from the algorithm's context and report logging messages or errors via the given feedback object.

In the case of an algorithm run as part of a larger model, the post-processing occurs following the completed execution of the entire model.