qgsprocessingparametertininputlayers.h

Go to the documentation of this file.

/***************************************************************************
  qgsprocessingparametertininputlayers.h
  ---------------------
  Date                 : August 2020
  Copyright            : (C) 2020 by Vincent Cloarec
  Email                : vcloarec 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 QGSPROCESSINGPARAMETERTININPUTLAYERS_H
#define QGSPROCESSINGPARAMETERTININPUTLAYERS_H
 
#include "qgsprocessingparameters.h"
#include "qgsprocessingparametertype.h"
 
class CORE_EXPORT QgsProcessingParameterTinInputLayers: public QgsProcessingParameterDefinition
{
  public:
 
    enum Type
    {
      Vertices, 
      StructureLines, 
      BreakLines 
    };
 
    struct InputLayer
    {
      QString source; 
      Type type; 
      int attributeIndex; 
    };
 
    QgsProcessingParameterTinInputLayers( const QString &name, const QString &description = QString() );
 
    QgsProcessingParameterDefinition *clone() const override;
    QString type() const override;
    bool checkValueIsAcceptable( const QVariant &input, QgsProcessingContext *context = nullptr ) const override;
    QString valueAsPythonString( const QVariant &value, QgsProcessingContext &context ) const override;
    QString valueAsString( const QVariant &value, QgsProcessingContext &context, bool &ok SIP_OUT ) const override;
    QVariant valueAsJsonObject( const QVariant &value, QgsProcessingContext &context ) const override;
    QString asPythonString( QgsProcessing::PythonOutputType outputType = QgsProcessing::PythonQgsProcessingAlgorithmSubclass ) const override;
 
    static QString typeName() { return QStringLiteral( "tininputlayers" ); }
};
 
#ifndef SIP_RUN
 
class CORE_EXPORT QgsProcessingParameterTypeTinInputLayers : public QgsProcessingParameterType
{
  public:
    QgsProcessingParameterDefinition *create( const QString &name ) const override SIP_FACTORY
    {
      return new QgsProcessingParameterTinInputLayers( name );
    }
 
    QString description() const override
    {
      return QCoreApplication::translate( "Processing", "An input allowing selection of multiple layers to create a TIN with vertices and/or break lines" );
    }
 
    QString name() const override
    {
      return QCoreApplication::translate( "Processing", "TIN Creation Layers" );
    }
 
    QString id() const override
    {
      return QgsProcessingParameterTinInputLayers::typeName();
    }
 
    QString pythonImportString() const override
    {
      return QStringLiteral( "from qgis.core import QgsProcessingParameterTinInputLayers" );
    }
 
    QString className() const override
    {
      return QStringLiteral( "QgsProcessingParameterTinInputLayers" );
    }
 
    QStringList acceptedPythonTypes() const override
    {
      return QStringList() << QObject::tr( "list[dict]: list of input layers as dictionaries, see QgsProcessingParameterTinInputLayers docs" );
    }
};
 
#endif
 
#endif // QGSPROCESSINGPARAMETERTININPUTLAYERS_H