QgsProcessing Class Reference

Contains enumerations and other constants for use in processing algorithms and parameters. More...

#include <qgsprocessing.h>

Public Types
enum class	LayerOptionsFlag : int { SkipIndexGeneration = 1 << 0 }
	Layer options flags. More...
enum	PythonOutputType { PythonQgsProcessingAlgorithmSubclass }
	Available Python output types. More...
enum	SourceType {   TypeMapLayer = -2 , TypeVectorAnyGeometry = -1 , TypeVectorPoint = 0 , TypeVectorLine = 1 ,   TypeVectorPolygon = 2 , TypeRaster = 3 , TypeFile = 4 , TypeVector = 5 ,   TypeMesh = 6 , TypePlugin = 7 , TypePointCloud = 8 , TypeAnnotation = 9 ,   TypeVectorTile = 10 }
	Data source types enum. More...

Static Public Member Functions
static QString	sourceTypeToString (SourceType type)
	Converts a source type to a string representation.

Static Public Attributes
static const QgsSettingsEntryInteger *	settingsDefaultOutputRasterLayerExt = new QgsSettingsEntryInteger( QStringLiteral( "default-output-raster-layer-ext" ), sTreeConfiguration, -1, QObject::tr( "Default output raster layer extension" ) )
	Settings entry default output raster layer ext.
static const QgsSettingsEntryInteger *	settingsDefaultOutputVectorLayerExt = new QgsSettingsEntryInteger( QStringLiteral( "default-output-vector-layer-ext" ), sTreeConfiguration, -1, QObject::tr( "Default output vector layer extension" ) )
	Settings entry default output vector layer ext.
static const QgsSettingsEntryBool *	settingsPreferFilenameAsLayerName = new QgsSettingsEntryBool( QStringLiteral( "prefer-filename-as-layer-name" ), sTreeConfiguration, true, QObject::tr( "Prefer filename as layer name" ) )
	Settings entry prefer filename as layer name.
static const QgsSettingsEntryString *	settingsTempPath = new QgsSettingsEntryString( QStringLiteral( "temp-path" ), sTreeConfiguration, QString(), QObject::tr( "Override temporary output folder path" ) )
	Settings entry temp path.
static QgsSettingsTreeNode *	sTreeConfiguration = QgsSettingsTree::sTreeQgis->createChildNode( QStringLiteral( "configuration" ) )
static const QString	TEMPORARY_OUTPUT = QStringLiteral( "TEMPORARY_OUTPUT" )
	Constant used to indicate that a Processing algorithm output should be a temporary layer/file.

Detailed Description

Contains enumerations and other constants for use in processing algorithms and parameters.

Since

QGIS 3.0

Definition at line 40 of file qgsprocessing.h.

Member Enumeration Documentation

LayerOptionsFlag

enum class QgsProcessing::LayerOptionsFlag : int

strong

Layer options flags.

Since

QGIS 3.32

Enumerator
SkipIndexGeneration	Do not generate index when creating a layer. Makes sense only for point cloud layers.

Definition at line 74 of file qgsprocessing.h.

PythonOutputType

enum QgsProcessing::PythonOutputType

Available Python output types.

Enumerator
PythonQgsProcessingAlgorithmSubclass	Full Python QgsProcessingAlgorithm subclass.

Definition at line 64 of file qgsprocessing.h.

SourceType

enum QgsProcessing::SourceType

Data source types enum.

Enumerator
TypeMapLayer	Any map layer type (raster, vector, mesh, point cloud, annotation or plugin layer)
TypeVectorAnyGeometry	Any vector layer with geometry.
TypeVectorPoint	Vector point layers.
TypeVectorLine	Vector line layers.
TypeVectorPolygon	Vector polygon layers.
TypeRaster	Raster layers.
TypeFile	Files (i.e. non map layer sources, such as text files)
TypeVector	Tables (i.e. vector layers with or without geometry). When used for a sink this indicates the sink has no geometry.
TypeMesh	Mesh layers. Since QGIS 3.6
TypePlugin	Plugin layers. Since QGIS 3.22
TypePointCloud	Point cloud layers. Since QGIS 3.22
TypeAnnotation	Annotation layers. Since QGIS 3.22
TypeVectorTile	Vector tile layers. Since QGIS 3.32

Definition at line 46 of file qgsprocessing.h.

Member Function Documentation

sourceTypeToString()

static QString QgsProcessing::sourceTypeToString ( SourceType  type )

inlinestatic

Converts a source type to a string representation.

Since

QGIS 3.6

Definition at line 85 of file qgsprocessing.h.

Member Data Documentation

settingsDefaultOutputRasterLayerExt

const QgsSettingsEntryInteger * QgsProcessing::settingsDefaultOutputRasterLayerExt = new QgsSettingsEntryInteger( QStringLiteral( "default-output-raster-layer-ext" ), sTreeConfiguration, -1, QObject::tr( "Default output raster layer extension" ) )

static

Settings entry default output raster layer ext.

Definition at line 136 of file qgsprocessing.h.

settingsDefaultOutputVectorLayerExt

const QgsSettingsEntryInteger * QgsProcessing::settingsDefaultOutputVectorLayerExt = new QgsSettingsEntryInteger( QStringLiteral( "default-output-vector-layer-ext" ), sTreeConfiguration, -1, QObject::tr( "Default output vector layer extension" ) )

static

Settings entry default output vector layer ext.

Definition at line 134 of file qgsprocessing.h.

settingsPreferFilenameAsLayerName

const QgsSettingsEntryBool * QgsProcessing::settingsPreferFilenameAsLayerName = new QgsSettingsEntryBool( QStringLiteral( "prefer-filename-as-layer-name" ), sTreeConfiguration, true, QObject::tr( "Prefer filename as layer name" ) )

static

Settings entry prefer filename as layer name.

Definition at line 130 of file qgsprocessing.h.

settingsTempPath

const QgsSettingsEntryString * QgsProcessing::settingsTempPath = new QgsSettingsEntryString( QStringLiteral( "temp-path" ), sTreeConfiguration, QString(), QObject::tr( "Override temporary output folder path" ) )

static

Settings entry temp path.

Definition at line 132 of file qgsprocessing.h.

sTreeConfiguration

QgsSettingsTreeNode* QgsProcessing::sTreeConfiguration = QgsSettingsTree::sTreeQgis->createChildNode( QStringLiteral( "configuration" ) )

inlinestatic

Definition at line 127 of file qgsprocessing.h.

TEMPORARY_OUTPUT

const QString QgsProcessing::TEMPORARY_OUTPUT = QStringLiteral( "TEMPORARY_OUTPUT" )

static

Constant used to indicate that a Processing algorithm output should be a temporary layer/file.

Since

QGIS 3.6

Definition at line 124 of file qgsprocessing.h.

---

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

• /build/qgis-3.34.0+99sid/src/core/processing/qgsprocessing.h
• /build/qgis-3.34.0+99sid/src/core/processing/qgsprocessing.cpp