QGIS API Documentation 3.37.0-Master (c2d15952569)
Loading...
Searching...
No Matches
Public Types | Static Public Member Functions | Static Public Attributes | List of all members
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 class  PythonOutputType { PythonQgsProcessingAlgorithmSubclass }
 Available Python output types. More...
 

Static Public Member Functions

static QString sourceTypeToString (Qgis::ProcessingSourceType type)
 Converts a source type to a string representation.
 

Static Public Attributes

static const QgsSettingsEntryIntegersettingsDefaultOutputRasterLayerExt = 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 QgsSettingsEntryIntegersettingsDefaultOutputVectorLayerExt = 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 QgsSettingsEntryBoolsettingsPreferFilenameAsLayerName = 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 QgsSettingsEntryStringsettingsTempPath = new QgsSettingsEntryString( QStringLiteral( "temp-path" ), sTreeConfiguration, QString(), QObject::tr( "Override temporary output folder path" ) )
 Settings entry temp path.
 
static QgsSettingsTreeNodesTreeConfiguration = 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 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

Available Python output types.

Enumerator
PythonQgsProcessingAlgorithmSubclass 

Full Python QgsProcessingAlgorithm subclass.

Definition at line 47 of file qgsprocessing.h.

Member Function Documentation

◆ 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 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 122 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 120 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 116 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 118 of file qgsprocessing.h.

◆ sTreeConfiguration

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

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


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