QGIS API Documentation 3.38.0-Grenoble (exported)
Loading...
Searching...
No Matches
qgsprocessingparametertininputlayers.h
Go to the documentation of this file.
1/***************************************************************************
2 qgsprocessingparametertininputlayers.h
3 ---------------------
4 Date : August 2020
5 Copyright : (C) 2020 by Vincent Cloarec
6 Email : vcloarec 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 QGSPROCESSINGPARAMETERTININPUTLAYERS_H
17#define QGSPROCESSINGPARAMETERTININPUTLAYERS_H
18
21
37{
38 public:
39
47
49 QgsProcessingParameterTinInputLayers( const QString &name, const QString &description = QString() );
50
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;
55 QString valueAsString( const QVariant &value, QgsProcessingContext &context, bool &ok SIP_OUT ) const override;
56 QVariant valueAsJsonObject( const QVariant &value, QgsProcessingContext &context ) const override;
58
60 static QString typeName() { return QStringLiteral( "tininputlayers" ); }
61};
62
63#ifndef SIP_RUN
65
73class CORE_EXPORT QgsProcessingParameterTypeTinInputLayers : public QgsProcessingParameterType
74{
75 public:
76 QgsProcessingParameterDefinition *create( const QString &name ) const override SIP_FACTORY
77 {
78 return new QgsProcessingParameterTinInputLayers( name );
79 }
80
81 QString description() const override
82 {
83 return QCoreApplication::translate( "Processing", "An input allowing selection of multiple layers to create a TIN with vertices and/or break lines" );
84 }
85
86 QString name() const override
87 {
88 return QCoreApplication::translate( "Processing", "TIN Creation Layers" );
89 }
90
91 QString id() const override
92 {
94 }
95
96 QString pythonImportString() const override
97 {
98 return QStringLiteral( "from qgis.core import QgsProcessingParameterTinInputLayers" );
99 }
100
101 QString className() const override
102 {
103 return QStringLiteral( "QgsProcessingParameterTinInputLayers" );
104 }
105
106 QStringList acceptedPythonTypes() const override
107 {
108 return QStringList() << QObject::tr( "list[dict]: list of input layers as dictionaries, see QgsProcessingParameterTinInputLayers docs" );
109 }
110};
111
113#endif
114
115#endif // QGSPROCESSINGPARAMETERTININPUTLAYERS_H
ProcessingTinInputLayerType
Defines the type of input layer for a Processing TIN input.
Definition qgis.h:3304
Contains information about the context in which a processing algorithm is executed.
Base class for the definition of processing parameters.
virtual QVariant valueAsJsonObject(const QVariant &value, QgsProcessingContext &context) const
Returns a version of the parameter input value, which is suitable for use in a JSON object.
virtual QString asPythonString(QgsProcessing::PythonOutputType outputType=QgsProcessing::PythonOutputType::PythonQgsProcessingAlgorithmSubclass) const
Returns the parameter definition as a Python command which can be used within a Python Processing scr...
QString description() const
Returns the description for the parameter.
virtual QString valueAsString(const QVariant &value, QgsProcessingContext &context, bool &ok) const
Returns a string version of the parameter input value (if possible).
virtual QgsProcessingParameterDefinition * clone() const =0
Creates a clone of the parameter definition.
virtual QString type() const =0
Unique parameter type name.
QString name() const
Returns the name of the parameter.
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...
virtual bool checkValueIsAcceptable(const QVariant &input, QgsProcessingContext *context=nullptr) const
Checks whether the specified input value is acceptable for the parameter.
A parameter for processing algorithms that need a list of input vector layers to construct a TIN.
static QString typeName()
Returns the type name for the parameter class.
Makes metadata of processing parameters available.
PythonOutputType
Available Python output types.
@ PythonQgsProcessingAlgorithmSubclass
Full Python QgsProcessingAlgorithm subclass.
#define SIP_OUT
Definition qgis_sip.h:58
#define SIP_FACTORY
Definition qgis_sip.h:76
Used to store input layer Id and other associated parameters.
Qgis::ProcessingTinInputLayerType type
The source of the input layer.