qgsprocessing.h

Go to the documentation of this file.

/***************************************************************************
                         qgsprocessing.h
                         ---------------
    begin                : July 2017
    copyright            : (C) 2017 by Nyall Dawson
    email                : nyall dot dawson at gmail dot com
 ***************************************************************************/
 
/***************************************************************************
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/
 
#ifndef QGSPROCESSING_H
#define QGSPROCESSING_H
 
#include "qgis_core.h"
#include "qgssettingsentryimpl.h"
#include "qgssettingstree.h"
#include <QString>
 
//
// Output definitions
//
 
class CORE_EXPORT QgsProcessing
{
 
  public:
 
    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, 
      TypeVectorTile = 10 
    };
 
    enum PythonOutputType
    {
      PythonQgsProcessingAlgorithmSubclass, 
    };
 
    enum class LayerOptionsFlag : int
    {
      SkipIndexGeneration = 1 << 0, 
    };
    Q_DECLARE_FLAGS( LayerOptionsFlags, LayerOptionsFlag )
 
    
    static QString sourceTypeToString( SourceType type )
    {
      switch ( type )
      {
        case QgsProcessing::TypeMapLayer:
          return QStringLiteral( "TypeMapLayer" );
        case QgsProcessing::TypeVectorAnyGeometry:
          return QStringLiteral( "TypeVectorAnyGeometry" );
        case QgsProcessing::TypeVectorPoint:
          return QStringLiteral( "TypeVectorPoint" );
        case QgsProcessing::TypeVectorLine:
          return QStringLiteral( "TypeVectorLine" );
        case QgsProcessing::TypeVectorPolygon:
          return QStringLiteral( "TypeVectorPolygon" );
        case QgsProcessing::TypeRaster:
          return QStringLiteral( "TypeRaster" );
        case QgsProcessing::TypeFile:
          return QStringLiteral( "TypeFile" );
        case QgsProcessing::TypeVector:
          return QStringLiteral( "TypeVector" );
        case QgsProcessing::TypeMesh:
          return QStringLiteral( "TypeMesh" );
        case QgsProcessing::TypePlugin:
          return QStringLiteral( "TypePlugin" );
        case QgsProcessing::TypePointCloud:
          return QStringLiteral( "TypePointCloud" );
        case QgsProcessing::TypeAnnotation:
          return QStringLiteral( "TypeAnnotation" );
        case QgsProcessing::TypeVectorTile:
          return QStringLiteral( "TypeVectorTile" );
      }
      return QString();
    }
 
    static const QString TEMPORARY_OUTPUT;
 
#ifndef SIP_RUN
    static inline QgsSettingsTreeNode *sTreeConfiguration = QgsSettingsTree::sTreeQgis->createChildNode( QStringLiteral( "configuration" ) );
 
    static const QgsSettingsEntryBool *settingsPreferFilenameAsLayerName;
    static const QgsSettingsEntryString *settingsTempPath;
    static const QgsSettingsEntryInteger *settingsDefaultOutputVectorLayerExt;
    static const QgsSettingsEntryInteger *settingsDefaultOutputRasterLayerExt;
#endif
};
 
#endif // QGSPROCESSING_H