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...
typedef QFlags< LayerOptionsFlag >	LayerOptionsFlags
enum class	PythonOutputType { PythonQgsProcessingAlgorithmSubclass }
	Available Python output types. More...

Static Public Member Functions
static QString	documentationFlagToString (Qgis::ProcessingAlgorithmDocumentationFlag flag)
	Converts a documentation flag to a translated string.
static QString	sourceTypeToString (Qgis::ProcessingSourceType type)
	Converts a source type to a string representation.

Static Public Attributes
static const QgsSettingsEntryString *	settingsDefaultOutputRasterLayerExt = new QgsSettingsEntryString( QStringLiteral( "default-output-raster-ext" ), sTreeConfiguration, QString(), QObject::tr( "Default output raster layer extension" ) )
	Settings entry default output raster layer ext.
static const QgsSettingsEntryString *	settingsDefaultOutputVectorLayerExt = new QgsSettingsEntryString( QStringLiteral( "default-output-vector-ext" ), sTreeConfiguration, QString(), 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.

Definition at line 40 of file qgsprocessing.h.

Member Typedef Documentation

LayerOptionsFlags

typedef QFlags< LayerOptionsFlag > QgsProcessing::LayerOptionsFlags

Definition at line 63 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 58 of file qgsprocessing.h.

PythonOutputType

enum class QgsProcessing::PythonOutputType

strong

Available Python output types.

Enumerator
PythonQgsProcessingAlgorithmSubclass	Full Python QgsProcessingAlgorithm subclass.

Definition at line 47 of file qgsprocessing.h.

Member Function Documentation

documentationFlagToString()

QString QgsProcessing::documentationFlagToString ( Qgis::ProcessingAlgorithmDocumentationFlag  flag )

static

Converts a documentation flag to a translated string.

Since

QGIS 3.40

Definition at line 31 of file qgsprocessing.cpp.

sourceTypeToString()

static QString QgsProcessing::sourceTypeToString ( Qgis::ProcessingSourceType  type )

inlinestatic

Converts a source type to a string representation.

Since

QGIS 3.6

Definition at line 71 of file qgsprocessing.h.

Member Data Documentation

settingsDefaultOutputRasterLayerExt

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

static

Settings entry default output raster layer ext.

Definition at line 129 of file qgsprocessing.h.

settingsDefaultOutputVectorLayerExt

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

static

Settings entry default output vector layer ext.

Definition at line 127 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 123 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 125 of file qgsprocessing.h.

sTreeConfiguration

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

inlinestatic

Definition at line 120 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 117 of file qgsprocessing.h.

---

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

• /build/qgis-3.41.0+git20241116+25ec5511245+99sid/src/core/processing/qgsprocessing.h
• /build/qgis-3.41.0+git20241116+25ec5511245+99sid/src/core/processing/qgsprocessing.cpp