QGIS API Documentation  3.14.0-Pi (9f7028fd23)
qgsprocessing.h
Go to the documentation of this file.
1 /***************************************************************************
2  qgsprocessing.h
3  ---------------
4  begin : July 2017
5  copyright : (C) 2017 by Nyall Dawson
6  email : nyall dot dawson at gmail dot com
7  ***************************************************************************/
8 
9 /***************************************************************************
10  * *
11  * This program is free software; you can redistribute it and/or modify *
12  * it under the terms of the GNU General Public License as published by *
13  * the Free Software Foundation; either version 2 of the License, or *
14  * (at your option) any later version. *
15  * *
16  ***************************************************************************/
17 
18 #ifndef QGSPROCESSING_H
19 #define QGSPROCESSING_H
20 
21 #include "qgis_core.h"
22 #include <QString>
23 
24 //
25 // Output definitions
26 //
27 
38 class CORE_EXPORT QgsProcessing
39 {
40 
41  public:
42 
45  {
46  TypeMapLayer = -2,
47  TypeVectorAnyGeometry = -1,
48  TypeVectorPoint = 0,
49  TypeVectorLine = 1,
50  TypeVectorPolygon = 2,
51  TypeRaster = 3,
52  TypeFile = 4,
53  TypeVector = 5,
54  TypeMesh = 6
55  };
56 
59  {
61  };
62 
68  static QString sourceTypeToString( SourceType type )
69  {
70  switch ( type )
71  {
73  return QStringLiteral( "TypeMapLayer" );
75  return QStringLiteral( "TypeVectorAnyGeometry" );
77  return QStringLiteral( "TypeVectorPoint" );
79  return QStringLiteral( "TypeVectorLine" );
81  return QStringLiteral( "TypeVectorPolygon" );
83  return QStringLiteral( "TypeRaster" );
85  return QStringLiteral( "TypeFile" );
87  return QStringLiteral( "TypeVector" );
89  return QStringLiteral( "TypeMesh" );
90  }
91  return QString();
92  }
93 
99  static const QString TEMPORARY_OUTPUT;
100 };
101 
102 #endif // QGSPROCESSING_H
QgsProcessing::TypeVectorPolygon
@ TypeVectorPolygon
Vector polygon layers.
Definition: qgsprocessing.h:50
QgsProcessing::TypeVectorLine
@ TypeVectorLine
Vector line layers.
Definition: qgsprocessing.h:49
QgsProcessing::sourceTypeToString
static QString sourceTypeToString(SourceType type)
Converts a source type to a string representation.
Definition: qgsprocessing.h:68
QgsProcessing::TypeVectorPoint
@ TypeVectorPoint
Vector point layers.
Definition: qgsprocessing.h:48
QgsProcessing::TypeMapLayer
@ TypeMapLayer
Any map layer type (raster or vector or mesh)
Definition: qgsprocessing.h:46
QgsProcessing::PythonQgsProcessingAlgorithmSubclass
@ PythonQgsProcessingAlgorithmSubclass
Full Python QgsProcessingAlgorithm subclass.
Definition: qgsprocessing.h:60
QgsProcessing::TypeVector
@ TypeVector
Tables (i.e. vector layers with or without geometry). When used for a sink this indicates the sink ha...
Definition: qgsprocessing.h:53
QgsProcessing::TypeMesh
@ TypeMesh
Mesh layers.
Definition: qgsprocessing.h:54
QgsProcessing::TypeRaster
@ TypeRaster
Raster layers.
Definition: qgsprocessing.h:51
QgsProcessing::TypeVectorAnyGeometry
@ TypeVectorAnyGeometry
Any vector layer with geometry.
Definition: qgsprocessing.h:47
QgsProcessing
Definition: qgsprocessing.h:38
QgsProcessing::TEMPORARY_OUTPUT
static const QString TEMPORARY_OUTPUT
Constant used to indicate that a Processing algorithm output should be a temporary layer/file.
Definition: qgsprocessing.h:99
QgsProcessing::TypeFile
@ TypeFile
Files (i.e. non map layer sources, such as text files)
Definition: qgsprocessing.h:52
QgsProcessing::PythonOutputType
PythonOutputType
Available Python output types.
Definition: qgsprocessing.h:58
QgsProcessing::SourceType
SourceType
Data source types enum.
Definition: qgsprocessing.h:44