QGIS API Documentation  3.21.0-Master (5b68dc587e)
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  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
}
 Data source types enum. More...
 

Static Public Member Functions

static QString sourceTypeToString (SourceType type)
 Converts a source type to a string representation. More...
 

Static Public Attributes

static const QgsSettingsEntryInteger settingsDefaultOutputRasterLayerExt = QgsSettingsEntryInteger( QStringLiteral( "Processing/Configuration/DefaultOutputRasterLayerExt" ), QgsSettings::NoSection, -1 )
 Settings entry default output raster layer ext. More...
 
static const QgsSettingsEntryInteger settingsDefaultOutputVectorLayerExt = QgsSettingsEntryInteger( QStringLiteral( "Processing/Configuration/DefaultOutputVectorLayerExt" ), QgsSettings::NoSection, -1 )
 Settings entry default output vector layer ext. More...
 
static const QgsSettingsEntryBool settingsPreferFilenameAsLayerName = QgsSettingsEntryBool( QStringLiteral( "Processing/Configuration/PREFER_FILENAME_AS_LAYER_NAME" ), QgsSettings::NoSection, true, QObject::tr( "Prefer filename as layer name" ) )
 Settings entry prefer filename as layer name. More...
 
static const QgsSettingsEntryString settingsTempPath = QgsSettingsEntryString( QStringLiteral( "Processing/Configuration/TEMP_PATH2" ), QgsSettings::NoSection, QString() )
 Settings entry temp path. More...
 
static const QString TEMPORARY_OUTPUT = QStringLiteral( "TEMPORARY_OUTPUT" )
 Constant used to indicate that a Processing algorithm output should be a temporary layer/file. More...
 

Detailed Description

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

Since
QGIS 3.0

Definition at line 39 of file qgsprocessing.h.

Member Enumeration Documentation

◆ PythonOutputType

Available Python output types.

Enumerator
PythonQgsProcessingAlgorithmSubclass 

Full Python QgsProcessingAlgorithm subclass.

Definition at line 62 of file qgsprocessing.h.

◆ 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

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

Member Data Documentation

◆ settingsDefaultOutputRasterLayerExt

const QgsSettingsEntryInteger QgsProcessing::settingsDefaultOutputRasterLayerExt = QgsSettingsEntryInteger( QStringLiteral( "Processing/Configuration/DefaultOutputRasterLayerExt" ), QgsSettings::NoSection, -1 )
inlinestatic

Settings entry default output raster layer ext.

Definition at line 119 of file qgsprocessing.h.

◆ settingsDefaultOutputVectorLayerExt

const QgsSettingsEntryInteger QgsProcessing::settingsDefaultOutputVectorLayerExt = QgsSettingsEntryInteger( QStringLiteral( "Processing/Configuration/DefaultOutputVectorLayerExt" ), QgsSettings::NoSection, -1 )
inlinestatic

Settings entry default output vector layer ext.

Definition at line 117 of file qgsprocessing.h.

◆ settingsPreferFilenameAsLayerName

const QgsSettingsEntryBool QgsProcessing::settingsPreferFilenameAsLayerName = QgsSettingsEntryBool( QStringLiteral( "Processing/Configuration/PREFER_FILENAME_AS_LAYER_NAME" ), QgsSettings::NoSection, true, QObject::tr( "Prefer filename as layer name" ) )
inlinestatic

Settings entry prefer filename as layer name.

Definition at line 113 of file qgsprocessing.h.

◆ settingsTempPath

const QgsSettingsEntryString QgsProcessing::settingsTempPath = QgsSettingsEntryString( QStringLiteral( "Processing/Configuration/TEMP_PATH2" ), QgsSettings::NoSection, QString() )
inlinestatic

Settings entry temp path.

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


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