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.h"
#include "qgis_core.h"
#include "qgssettingsentryimpl.h"
#include "qgssettingstree.h"
 
#include <QString>
 
using namespace Qt::StringLiterals;
 
//
// Output definitions
//

 
class CORE_EXPORT QgsProcessing
{
    Q_GADGET
 
  public:
    enum class PythonOutputType SIP_MONKEYPATCH_SCOPEENUM
    {
      PythonQgsProcessingAlgorithmSubclass, 
    };
    Q_ENUM( PythonOutputType )
 
    
    enum class LayerOptionsFlag : int SIP_ENUM_BASETYPE( IntFlag )
    {
      SkipIndexGeneration = 1 << 0, 
    };
    Q_ENUM( LayerOptionsFlag )
    Q_DECLARE_FLAGS( LayerOptionsFlags, LayerOptionsFlag )
    Q_FLAG( LayerOptionsFlags )

    static QString sourceTypeToString( Qgis::ProcessingSourceType type )
    {
      switch ( type )
      {
        case Qgis::ProcessingSourceType::MapLayer:
          return u"TypeMapLayer"_s;
        case Qgis::ProcessingSourceType::VectorAnyGeometry:
          return u"TypeVectorAnyGeometry"_s;
        case Qgis::ProcessingSourceType::VectorPoint:
          return u"TypeVectorPoint"_s;
        case Qgis::ProcessingSourceType::VectorLine:
          return u"TypeVectorLine"_s;
        case Qgis::ProcessingSourceType::VectorPolygon:
          return u"TypeVectorPolygon"_s;
        case Qgis::ProcessingSourceType::Raster:
          return u"TypeRaster"_s;
        case Qgis::ProcessingSourceType::File:
          return u"TypeFile"_s;
        case Qgis::ProcessingSourceType::Vector:
          return u"TypeVector"_s;
        case Qgis::ProcessingSourceType::Mesh:
          return u"TypeMesh"_s;
        case Qgis::ProcessingSourceType::Plugin:
          return u"TypePlugin"_s;
        case Qgis::ProcessingSourceType::PointCloud:
          return u"TypePointCloud"_s;
        case Qgis::ProcessingSourceType::Annotation:
          return u"TypeAnnotation"_s;
        case Qgis::ProcessingSourceType::VectorTile:
          return u"TypeVectorTile"_s;
        case Qgis::ProcessingSourceType::TiledScene:
          return u"TiledScene"_s;
      }
      return QString();
    }

    static QString documentationFlagToString( Qgis::ProcessingAlgorithmDocumentationFlag flag );

    static const QString TEMPORARY_OUTPUT;

    static const QString MODEL_PROVIDER_ID;

    static const QString PROJECT_PROVIDER_ID;
 
#ifndef SIP_RUN
    static inline QgsSettingsTreeNode *sTreeConfiguration = QgsSettingsTree::sTreeQgis->createChildNode( u"configuration"_s );

    static const QgsSettingsEntryBool *settingsPreferFilenameAsLayerName;
    static const QgsSettingsEntryString *settingsTempPath;
    static const QgsSettingsEntryString *settingsDefaultOutputVectorLayerExt;
    static const QgsSettingsEntryString *settingsDefaultOutputRasterLayerFormat;
    static const QgsSettingsEntryVariant *settingsDefaultGuiParam;
#endif
};
 
#endif // QGSPROCESSING_H