|
QGIS API Documentation
3.18.1-Zürich (202f1bf7e5)
|
Encapsulates settings relating to a feature sink or output raster layer for a processing algorithm. More...
#include <qgsprocessingparameters.h>
Public Member Functions | |
| QgsProcessingOutputLayerDefinition (const QgsProperty &sink, QgsProject *destinationProject=nullptr) | |
| Constructor for QgsProcessingOutputLayerDefinition, accepting a QgsProperty sink/layer. More... | |
| QgsProcessingOutputLayerDefinition (const QString &sink=QString(), QgsProject *destinationProject=nullptr) | |
| Constructor for QgsProcessingOutputLayerDefinition, accepting a static sink/layer string. 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... | |
| bool | operator!= (const QgsProcessingOutputLayerDefinition &other) const |
| bool | operator== (const QgsProcessingOutputLayerDefinition &other) const |
| QgsRemappingSinkDefinition | remappingDefinition () const |
Returns the output remapping definition, if useRemapping() is true. More... | |
| void | setRemappingDefinition (const QgsRemappingSinkDefinition &definition) |
| Sets the remapping definition to use when adding features to the output layer. More... | |
| QVariant | toVariant () const |
| Saves this output layer definition to a QVariantMap, wrapped in a QVariant. More... | |
| bool | useRemapping () const |
Returns true if the output uses a remapping definition. 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 199 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 208 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 218 of file qgsprocessingparameters.h.
| 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.
Definition at line 85 of file qgsprocessingparameters.cpp.
|
inline |
Allows direct construction of QVariants.
Definition at line 294 of file qgsprocessingparameters.h.
| bool QgsProcessingOutputLayerDefinition::operator!= | ( | const QgsProcessingOutputLayerDefinition & | other | ) | const |
Definition at line 107 of file qgsprocessingparameters.cpp.
| bool QgsProcessingOutputLayerDefinition::operator== | ( | const QgsProcessingOutputLayerDefinition & | other | ) | const |
Definition at line 101 of file qgsprocessingparameters.cpp.
|
inline |
Returns the output remapping definition, if useRemapping() is true.
Definition at line 263 of file qgsprocessingparameters.h.
| void QgsProcessingOutputLayerDefinition::setRemappingDefinition | ( | const QgsRemappingSinkDefinition & | definition | ) |
Sets the remapping definition to use when adding features to the output layer.
Calling this method will set useRemapping() to true.
Definition at line 69 of file qgsprocessingparameters.cpp.
| 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.
Definition at line 75 of file qgsprocessingparameters.cpp.
|
inline |
Returns true if the output uses a remapping definition.
Definition at line 254 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 246 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 238 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 233 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 226 of file qgsprocessingparameters.h.
1.9.1