QGIS API Documentation 3.29.0-Master (8c80f25a4f)
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
41 enum Type
42 {
45 BreakLines
46 };
47
50 {
51 QString source;
54 };
55
57 QgsProcessingParameterTinInputLayers( const QString &name, const QString &description = QString() );
58
60 QString type() const override;
61 bool checkValueIsAcceptable( const QVariant &input, QgsProcessingContext *context = nullptr ) const override;
62 QString valueAsPythonString( const QVariant &value, QgsProcessingContext &context ) const override;
63 QString valueAsString( const QVariant &value, QgsProcessingContext &context, bool &ok SIP_OUT ) const override;
64 QVariant valueAsJsonObject( const QVariant &value, QgsProcessingContext &context ) const override;
66
68 static QString typeName() { return QStringLiteral( "tininputlayers" ); }
69};
70
71#ifndef SIP_RUN
73
81class CORE_EXPORT QgsProcessingParameterTypeTinInputLayers : public QgsProcessingParameterType
82{
83 public:
84 QgsProcessingParameterDefinition *create( const QString &name ) const override SIP_FACTORY
85 {
86 return new QgsProcessingParameterTinInputLayers( name );
87 }
88
89 QString description() const override
90 {
91 return QCoreApplication::translate( "Processing", "An input allowing selection of multiple layers to create a TIN with vertices and/or break lines" );
92 }
93
94 QString name() const override
95 {
96 return QCoreApplication::translate( "Processing", "TIN Creation Layers" );
97 }
98
99 QString id() const override
100 {
102 }
103
104 QString pythonImportString() const override
105 {
106 return QStringLiteral( "from qgis.core import QgsProcessingParameterTinInputLayers" );
107 }
108
109 QString className() const override
110 {
111 return QStringLiteral( "QgsProcessingParameterTinInputLayers" );
112 }
113
114 QStringList acceptedPythonTypes() const override
115 {
116 return QStringList() << QObject::tr( "list[dict]: list of input layers as dictionaries, see QgsProcessingParameterTinInputLayers docs" );
117 }
118};
119
121#endif
122
123#endif // QGSPROCESSINGPARAMETERTININPUTLAYERS_H
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::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.
@ StructureLines
Input that adds add structure lines.
static QString typeName()
Returns the type name for the parameter class.
Makes metadata of processing parameters available.
PythonOutputType
Available Python output types.
Definition: qgsprocessing.h:63
@ PythonQgsProcessingAlgorithmSubclass
Full Python QgsProcessingAlgorithm subclass.
Definition: qgsprocessing.h:64
#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.