QGIS API Documentation  3.10.0-A Coruña (6c816b4204)
Public Member Functions | Public Attributes | List of all members
QgsProcessingOutputLayerDefinition Class Reference

Encapsulates settings relating to a feature sink or output raster layer for a processing algorithm. More...

#include <qgsprocessingparameters.h>

Public Member Functions

 QgsProcessingOutputLayerDefinition (const QString &sink=QString(), QgsProject *destinationProject=nullptr)
 Constructor for QgsProcessingOutputLayerDefinition, accepting a static sink/layer string. More...
 
 QgsProcessingOutputLayerDefinition (const QgsProperty &sink, QgsProject *destinationProject=nullptr)
 Constructor for QgsProcessingOutputLayerDefinition, accepting a QgsProperty sink/layer. More...
 
bool loadVariant (const QVariantMap &map)
 Loads this output layer definition from a QVariantMap, wrapped in a QVariant. More...
 
 operator QVariant () const
 Allows direct construction of QVariants. More...
 
QVariant toVariant () const
 Saves this output layer definition to a QVariantMap, wrapped in a QVariant. More...
 

Public Attributes

QVariantMap createOptions
 Map of optional sink/layer creation options, which are passed to the underlying provider when creating new layers. More...
 
QString destinationName
 Name to use for sink if it's to be loaded into a destination project. More...
 
QgsProjectdestinationProject = nullptr
 Destination project. More...
 
QgsProperty sink
 Sink/layer definition. More...
 

Detailed Description

Encapsulates settings relating to a feature sink or output raster layer for a processing algorithm.

Since
QGIS 3.0

Definition at line 112 of file qgsprocessingparameters.h.

Constructor & Destructor Documentation

◆ QgsProcessingOutputLayerDefinition() [1/2]

QgsProcessingOutputLayerDefinition::QgsProcessingOutputLayerDefinition ( const QString &  sink = QString(),
QgsProject destinationProject = nullptr 
)
inline

Constructor for QgsProcessingOutputLayerDefinition, accepting a static sink/layer string.

The destinationProject parameter can be set to a QgsProject instance in which to automatically load the resulting sink/layer after completing processing.

Definition at line 121 of file qgsprocessingparameters.h.

◆ QgsProcessingOutputLayerDefinition() [2/2]

QgsProcessingOutputLayerDefinition::QgsProcessingOutputLayerDefinition ( const QgsProperty sink,
QgsProject destinationProject = nullptr 
)
inline

Constructor for QgsProcessingOutputLayerDefinition, accepting a QgsProperty sink/layer.

The destinationProject parameter can be set to a QgsProject instance in which to automatically load the resulting sink/layer after completing processing.

Definition at line 131 of file qgsprocessingparameters.h.

Member Function Documentation

◆ loadVariant()

bool QgsProcessingOutputLayerDefinition::loadVariant ( const QVariantMap &  map)

Loads this output layer definition from a QVariantMap, wrapped in a QVariant.

You can use QgsXmlUtils::readVariant to load it from an XML document.

See also
toVariant()
Since
QGIS 3.2

Definition at line 49 of file qgsprocessingparameters.cpp.

◆ operator QVariant()

QgsProcessingOutputLayerDefinition::operator QVariant ( ) const
inline

Allows direct construction of QVariants.

Definition at line 178 of file qgsprocessingparameters.h.

◆ toVariant()

QVariant QgsProcessingOutputLayerDefinition::toVariant ( ) const

Saves this output layer definition to a QVariantMap, wrapped in a QVariant.

You can use QgsXmlUtils::writeVariant to save it to an XML document.

See also
loadVariant()
Since
QGIS 3.2

Definition at line 41 of file qgsprocessingparameters.cpp.

Member Data Documentation

◆ createOptions

QVariantMap QgsProcessingOutputLayerDefinition::createOptions

Map of optional sink/layer creation options, which are passed to the underlying provider when creating new layers.

Known options also include 'fileEncoding', which is used to specify a file encoding to use for created files.

Definition at line 159 of file qgsprocessingparameters.h.

◆ destinationName

QString QgsProcessingOutputLayerDefinition::destinationName

Name to use for sink if it's to be loaded into a destination project.

Definition at line 151 of file qgsprocessingparameters.h.

◆ destinationProject

QgsProject* QgsProcessingOutputLayerDefinition::destinationProject = nullptr

Destination project.

Can be set to a QgsProject instance in which to automatically load the resulting sink/layer after completing processing. The default behavior is not to load the result into any project (nullptr).

Definition at line 146 of file qgsprocessingparameters.h.

◆ sink

QgsProperty QgsProcessingOutputLayerDefinition::sink

Sink/layer definition.

Usually a static property set to the destination file name for the sink's layer.

Definition at line 139 of file qgsprocessingparameters.h.


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