QGIS API Documentation  3.18.1-Zürich (202f1bf7e5)
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
}
 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 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 38 of file qgsprocessing.h.

Member Enumeration Documentation

◆ PythonOutputType

Available Python output types.

Enumerator
PythonQgsProcessingAlgorithmSubclass 

Full Python QgsProcessingAlgorithm subclass.

Definition at line 58 of file qgsprocessing.h.

◆ SourceType

Data source types enum.

Enumerator
TypeMapLayer 

Any map layer type (raster or vector or mesh)

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

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

Member Data Documentation

◆ 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 99 of file qgsprocessing.h.


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