QGIS API Documentation
3.0.2-Girona (307d082)
|
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... | |
operator QVariant () const | |
Allows direct construction of QVariants. 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... | |
QgsProject * | destinationProject = nullptr |
Destination project. More... | |
QgsProperty | sink |
Sink/layer definition. More... | |
Encapsulates settings relating to a feature sink or output raster layer for a processing algorithm.
Definition at line 107 of file qgsprocessingparameters.h.
|
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 116 of file qgsprocessingparameters.h.
|
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 126 of file qgsprocessingparameters.h.
|
inline |
Allows direct construction of QVariants.
Definition at line 158 of file qgsprocessingparameters.h.
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 154 of file qgsprocessingparameters.h.
QString QgsProcessingOutputLayerDefinition::destinationName |
Name to use for sink if it's to be loaded into a destination project.
Definition at line 146 of file qgsprocessingparameters.h.
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 141 of file qgsprocessingparameters.h.
QgsProperty QgsProcessingOutputLayerDefinition::sink |
Sink/layer definition.
Usually a static property set to the destination file name for the sink's layer.
Definition at line 134 of file qgsprocessingparameters.h.