QgsProcessingContext::LayerDetails Class Reference

Details for layers to load into projects. More...

#include <qgsprocessingcontext.h>

Public Member Functions
	LayerDetails (const QString &name, QgsProject *project, const QString &outputName=QString(), QgsProcessingUtils::LayerHint layerTypeHint=QgsProcessingUtils::UnknownType)
	Constructor for LayerDetails. More...
	LayerDetails ()=default
	Default constructor. More...
QgsProcessingLayerPostProcessorInterface *	postProcessor () const
	Layer post-processor. More...
void	setPostProcessor (QgsProcessingLayerPostProcessorInterface *processor)
	Sets the layer post-processor. More...

Public Attributes
QgsProcessingUtils::LayerHint	layerTypeHint = QgsProcessingUtils::UnknownType
	Layer type hint. More...
QString	name
	Friendly name for layer, to use when loading layer into project. More...
QString	outputName
	Associated output name from algorithm which generated the layer. More...
QgsProject *	project = nullptr
	Destination project. More...

Detailed Description

Details for layers to load into projects.

Since

QGIS 3.0

Definition at line 166 of file qgsprocessingcontext.h.

Constructor & Destructor Documentation

QgsProcessingContext::LayerDetails::LayerDetails ( const QString &  name, QgsProject *  project, const QString &  outputName = QString(), QgsProcessingUtils::LayerHint  layerTypeHint = QgsProcessingUtils::UnknownType  )

inline

Constructor for LayerDetails.

Definition at line 173 of file qgsprocessingcontext.h.

QgsProcessingContext::LayerDetails::LayerDetails ( )

default

Default constructor.

Member Function Documentation

QgsProcessingLayerPostProcessorInterface * QgsProcessingContext::LayerDetails::postProcessor

(

)

const

Layer post-processor.

May be nullptr if no post-processing is required.

See also

setPostProcessor()

Since

QGIS 3.2

Definition at line 98 of file qgsprocessingcontext.cpp.

void QgsProcessingContext::LayerDetails::setPostProcessor

(

QgsProcessingLayerPostProcessorInterface *

processor

)

Sets the layer post-processor.

May be nullptr if no post-processing is required.

Ownership of processor is transferred.

See also

postProcessor()

Since

QGIS 3.2

Definition at line 103 of file qgsprocessingcontext.cpp.

Member Data Documentation

QgsProcessingUtils::LayerHint QgsProcessingContext::LayerDetails::layerTypeHint = QgsProcessingUtils::UnknownType

Layer type hint.

Since

QGIS 3.4

Definition at line 194 of file qgsprocessingcontext.h.

QString QgsProcessingContext::LayerDetails::name

Friendly name for layer, to use when loading layer into project.

Definition at line 184 of file qgsprocessingcontext.h.

QString QgsProcessingContext::LayerDetails::outputName

Associated output name from algorithm which generated the layer.

Definition at line 187 of file qgsprocessingcontext.h.

QgsProject* QgsProcessingContext::LayerDetails::project = nullptr

Destination project.

Definition at line 214 of file qgsprocessingcontext.h.

---

The documentation for this class was generated from the following files:

• /build/qgis-3.4.15+24xenial/src/core/processing/qgsprocessingcontext.h
• /build/qgis-3.4.15+24xenial/src/core/processing/qgsprocessingcontext.cpp