QGIS API Documentation  3.16.0-Hannover (43b64b13f3)
qgsprocessingparametervectortilewriterlayers.h
Go to the documentation of this file.
1 /***************************************************************************
2  qgsprocessingparametervectortilewriterlayers.h
3  ---------------------
4  Date : April 2020
5  Copyright : (C) 2020 by Martin Dobias
6  Email : wonder dot sk at gmail dot com
7  ***************************************************************************
8  * *
9  * This program is free software; you can redistribute it and/or modify *
10  * it under the terms of the GNU General Public License as published by *
11  * the Free Software Foundation; either version 2 of the License, or *
12  * (at your option) any later version. *
13  * *
14  ***************************************************************************/
15 
16 #ifndef QGSPROCESSINGPARAMETERVECTORTILEWRITERLAYERS_H
17 #define QGSPROCESSINGPARAMETERVECTORTILEWRITERLAYERS_H
18 
21 #include "qgsvectortilewriter.h"
22 
23 
46 {
47  public:
49  QgsProcessingParameterVectorTileWriterLayers( const QString &name, const QString &description = QString() );
50 
51  QgsProcessingParameterDefinition *clone() const override;
52  QString type() const override;
53  bool checkValueIsAcceptable( const QVariant &input, QgsProcessingContext *context = nullptr ) const override;
54  QString valueAsPythonString( const QVariant &value, QgsProcessingContext &context ) const override;
56 
58  static QString typeName() { return QStringLiteral( "vectortilewriterlayers" ); }
59 
61  static QList<QgsVectorTileWriter::Layer> parameterAsLayers( const QVariant &layersVariant, QgsProcessingContext &context );
63  static QgsVectorTileWriter::Layer variantMapAsLayer( const QVariantMap &layerVariantMap, QgsProcessingContext &context );
65  static QVariantMap layerAsVariantMap( const QgsVectorTileWriter::Layer &layer );
66 
67 };
68 
69 
78 {
79  public:
80  QgsProcessingParameterDefinition *create( const QString &name ) const override SIP_FACTORY
81  {
83  }
84 
85  QString description() const override
86  {
87  return QCoreApplication::translate( "Processing", "An input allowing selection of multiple layers for export in vector tiles." );
88  }
89 
90  QString name() const override
91  {
92  return QCoreApplication::translate( "Processing", "Vector Tile Writer Layers" );
93  }
94 
95  QString id() const override
96  {
98  }
99 
100  QString pythonImportString() const override
101  {
102  return QStringLiteral( "from qgis.core import QgsProcessingParameterVectorTileWriterLayers" );
103  }
104 
105  QString className() const override
106  {
107  return QStringLiteral( "QgsProcessingParameterVectorTileWriterLayers" );
108  }
109 
110  QStringList acceptedPythonTypes() const override
111  {
112  return QStringList() << QObject::tr( "list[dict]: list of input layers as dictionaries, see QgsProcessingParameterVectorTileWriterLayers docs" );
113  }
114 };
115 
116 
117 #endif // QGSPROCESSINGPARAMETERVECTORTILEWRITERLAYERS_H
QgsProcessingParameterTypeVectorTileWriterLayers::className
QString className() const override
Returns the corresponding class name for the parameter type.
Definition: qgsprocessingparametervectortilewriterlayers.h:105
qgsprocessingparametertype.h
QgsProcessingParameterDefinition::valueAsPythonString
virtual QString valueAsPythonString(const QVariant &value, QgsProcessingContext &context) const
Returns a string version of the parameter input value, which is suitable for use as an input paramete...
Definition: qgsprocessingparameters.cpp:2312
QgsProcessingParameterTypeVectorTileWriterLayers::pythonImportString
QString pythonImportString() const override
Returns a valid Python import string for importing the corresponding parameter type,...
Definition: qgsprocessingparametervectortilewriterlayers.h:100
QgsProcessingParameterDefinition
Base class for the definition of processing parameters.
Definition: qgsprocessingparameters.h:331
QgsProcessingParameterType
Makes metadata of processing parameters available.
Definition: qgsprocessingparametertype.h:34
SIP_FACTORY
#define SIP_FACTORY
Definition: qgis_sip.h:76
QgsProcessing::PythonQgsProcessingAlgorithmSubclass
@ PythonQgsProcessingAlgorithmSubclass
Full Python QgsProcessingAlgorithm subclass.
Definition: qgsprocessing.h:60
QgsProcessingContext
Contains information about the context in which a processing algorithm is executed.
Definition: qgsprocessingcontext.h:44
QgsProcessingParameterTypeVectorTileWriterLayers::id
QString id() const override
A static id for this type which will be used for storing this parameter type.
Definition: qgsprocessingparametervectortilewriterlayers.h:95
QgsProcessingParameterTypeVectorTileWriterLayers::name
QString name() const override
A human readable and translatable short name for this parameter type.
Definition: qgsprocessingparametervectortilewriterlayers.h:90
QgsProcessingParameterVectorTileWriterLayers::typeName
static QString typeName()
Returns the type name for the parameter class.
Definition: qgsprocessingparametervectortilewriterlayers.h:58
qgsvectortilewriter.h
qgsprocessingparameters.h
QgsProcessingParameterVectorTileWriterLayers
A parameter for processing algorithms that need a list of input vector layers for writing of vector t...
Definition: qgsprocessingparametervectortilewriterlayers.h:46
QgsProcessingParameterTypeVectorTileWriterLayers::create
QgsProcessingParameterDefinition * create(const QString &name) const override
Creates a new parameter of this type.
Definition: qgsprocessingparametervectortilewriterlayers.h:80
QgsProcessingParameterTypeVectorTileWriterLayers::description
QString description() const override
A human readable and translatable description for this parameter type.
Definition: qgsprocessingparametervectortilewriterlayers.h:85
QgsVectorTileWriter::Layer
Configuration of a single input vector layer to be included in the output.
Definition: qgsvectortilewriter.h:85
QgsProcessingParameterTypeVectorTileWriterLayers
Parameter type definition for QgsProcessingParameterVectorTileWriterLayers.
Definition: qgsprocessingparametervectortilewriterlayers.h:78
QgsProcessingParameterDefinition::asPythonString
virtual QString asPythonString(QgsProcessing::PythonOutputType outputType=QgsProcessing::PythonQgsProcessingAlgorithmSubclass) const
Returns the parameter definition as a Python command which can be used within a Python Processing scr...
Definition: qgsprocessingparameters.cpp:2333
QgsProcessingParameterDefinition::clone
virtual QgsProcessingParameterDefinition * clone() const =0
Creates a clone of the parameter definition.
QgsProcessingParameterDefinition::type
virtual QString type() const =0
Unique parameter type name.
QgsProcessing::PythonOutputType
PythonOutputType
Available Python output types.
Definition: qgsprocessing.h:59
QgsProcessingParameterDefinition::checkValueIsAcceptable
virtual bool checkValueIsAcceptable(const QVariant &input, QgsProcessingContext *context=nullptr) const
Checks whether the specified input value is acceptable for the parameter.
Definition: qgsprocessingparameters.cpp:2300
QgsProcessingParameterTypeVectorTileWriterLayers::acceptedPythonTypes
QStringList acceptedPythonTypes() const override
Returns a list of the Python data types accepted as values for the parameter.
Definition: qgsprocessingparametervectortilewriterlayers.h:110