QGIS API Documentation  3.2.0-Bonn (bc43194)
Public Member Functions | Public Attributes | List of all members
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())
 Constructor for LayerDetails. More...
 
 LayerDetails ()=default
 Default constructor. More...
 
QgsProcessingLayerPostProcessorInterfacepostProcessor () const
 Layer post-processor. More...
 
void setPostProcessor (QgsProcessingLayerPostProcessorInterface *processor)
 Sets the layer post-processor. More...
 

Public Attributes

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...
 
QgsProjectproject = nullptr
 Destination project. More...
 

Detailed Description

Details for layers to load into projects.

Since
QGIS 3.0

Definition at line 165 of file qgsprocessingcontext.h.

Constructor & Destructor Documentation

◆ LayerDetails() [1/2]

QgsProcessingContext::LayerDetails::LayerDetails ( const QString &  name,
QgsProject project,
const QString &  outputName = QString() 
)
inline

Constructor for LayerDetails.

Definition at line 172 of file qgsprocessingcontext.h.

◆ LayerDetails() [2/2]

QgsProcessingContext::LayerDetails::LayerDetails ( )
default

Default constructor.

Member Function Documentation

◆ postProcessor()

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.

◆ setPostProcessor()

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

◆ name

QString QgsProcessingContext::LayerDetails::name

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

Definition at line 182 of file qgsprocessingcontext.h.

◆ outputName

QString QgsProcessingContext::LayerDetails::outputName

Associated output name from algorithm which generated the layer.

Definition at line 185 of file qgsprocessingcontext.h.

◆ project

QgsProject* QgsProcessingContext::LayerDetails::project = nullptr

Destination project.

Definition at line 205 of file qgsprocessingcontext.h.


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