qgsprocessingparametermeshdataset.h

Go to the documentation of this file.

/***************************************************************************
  qgsprocessingparametermeshdataset.h
  ---------------------
  Date                 : October 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 QGSPROCESSINGPARAMETERMESHDATASET_H
#define QGSPROCESSINGPARAMETERMESHDATASET_H
 
#include "qgsprocessingparameters.h"
#include "qgsprocessingparametertype.h"
#include "qgsmeshdataset.h"
 
class CORE_EXPORT QgsProcessingParameterMeshDatasetGroups : public QgsProcessingParameterDefinition
{
  public:
 
    QgsProcessingParameterMeshDatasetGroups( const QString &name,
        const QString &description = QString(),
        const QString &meshLayerParameterName = QString(),
        QSet<int> supportedDataType = QSet<int>(),
        bool optional = false );
 
    QgsProcessingParameterDefinition *clone() const override SIP_FACTORY;
    QString type() const override;
    bool checkValueIsAcceptable( const QVariant &input, QgsProcessingContext *context = nullptr ) const override;
    QString valueAsPythonString( const QVariant &value, QgsProcessingContext &context ) const override;
    QString asPythonString( QgsProcessing::PythonOutputType outputType = QgsProcessing::PythonOutputType::PythonQgsProcessingAlgorithmSubclass ) const override;
    QStringList dependsOnOtherParameters() const override;
    QVariantMap toVariantMap() const override;
    bool fromVariantMap( const QVariantMap &map ) override;
 
    static QString typeName() { return QStringLiteral( "meshdatasetgroups" ); }
 
    QString meshLayerParameterName() const;
 
    bool isDataTypeSupported( QgsMeshDatasetGroupMetadata::DataType dataType ) const;
 
    static QList<int> valueAsDatasetGroup( const QVariant &value );
 
  private:
    QString mMeshLayerParameterName;
    QSet<int> mSupportedDataType;
 
    static bool valueIsAcceptable( const QVariant &input, bool allowEmpty );
};
 
#ifndef SIP_RUN
 
class CORE_EXPORT QgsProcessingParameterTypeMeshDatasetGroups : public QgsProcessingParameterType
{
  public:
    QgsProcessingParameterDefinition *create( const QString &name ) const override SIP_FACTORY
    {
      return new QgsProcessingParameterMeshDatasetGroups( name );
    }
 
    QString description() const override
    {
      return QCoreApplication::translate( "Processing", "An input allowing selection dataset groups from a mesh layer" );
    }
 
    QString name() const override
    {
      return QCoreApplication::translate( "Processing", "Mesh Dataset Groups" );
    }
 
    QString id() const override
    {
      return QgsProcessingParameterMeshDatasetGroups::typeName();
    }
 
    QString pythonImportString() const override
    {
      return QStringLiteral( "from qgis.core import QgsProcessingParameterMeshDatasetGroups" );
    }
 
    QString className() const override
    {
      return QStringLiteral( "QgsProcessingParameterMeshDatasetGroups" );
    }
 
    QStringList acceptedPythonTypes() const override
    {
      return QStringList() << QObject::tr( "list[int]: list of dataset group indexes, see QgsProcessingParameterMeshDatasetGroups docs" );
    }
};
 
#endif //SIP_RUN
 
class CORE_EXPORT QgsProcessingParameterMeshDatasetTime : public QgsProcessingParameterDefinition
{
  public:
 
    QgsProcessingParameterMeshDatasetTime(
      const QString &name,
      const QString &description = QString(),
      const QString &meshLayerParameterName = QString(),
      const QString &datasetGroupParameterName = QString() );
 
    QgsProcessingParameterDefinition *clone() const override SIP_FACTORY;
    QString type() const override;
    bool checkValueIsAcceptable( const QVariant &input, QgsProcessingContext *context = nullptr ) const override;
    QString valueAsPythonString( const QVariant &value, QgsProcessingContext &context ) const override;
    QString asPythonString( QgsProcessing::PythonOutputType outputType = QgsProcessing::PythonOutputType::PythonQgsProcessingAlgorithmSubclass ) const override;
    QStringList dependsOnOtherParameters() const override;
    QVariantMap toVariantMap() const override;
    bool fromVariantMap( const QVariantMap &map ) override;
 
    static QString typeName() { return QStringLiteral( "meshdatasettime" ); }
 
    QString meshLayerParameterName() const;
 
    QString datasetGroupParameterName() const;
 
    static QString valueAsTimeType( const QVariant &value );
 
    static QgsMeshDatasetIndex timeValueAsDatasetIndex( const QVariant &value );
 
    static QDateTime timeValueAsDefinedDateTime( const QVariant &value );
 
  private:
    QString mMeshLayerParameterName;
    QString mDatasetGroupParameterName;
 
    static bool valueIsAcceptable( const QVariant &input, bool allowEmpty );
};
 
#ifndef SIP_RUN
 
class CORE_EXPORT QgsProcessingParameterTypeMeshDatasetTime: public QgsProcessingParameterType
{
  public:
    QgsProcessingParameterDefinition *create( const QString &name ) const override SIP_FACTORY
    {
      return new QgsProcessingParameterMeshDatasetTime( name );
    }
 
    QString description() const override
    {
      return QCoreApplication::translate( "Processing", "An input allowing selection of dataset index from a mesh layer by time setting" );
    }
 
    QString name() const override
    {
      return QCoreApplication::translate( "Processing", "Mesh Dataset Time" );
    }
 
    QString id() const override
    {
      return QgsProcessingParameterMeshDatasetTime::typeName();
    }
 
    QString pythonImportString() const override
    {
      return QStringLiteral( "from qgis.core import QgsProcessingParameterMeshDatasetTime" );
    }
 
    QString className() const override
    {
      return QStringLiteral( "QgsProcessingParameterMeshDatasetTime" );
    }
 
    QStringList acceptedPythonTypes() const override
    {
      return QStringList() << QObject::tr( "dict{}: dictionary, see QgsProcessingParameterMeshDatasetTime docs" );
    }
};
 
#endif //SIP_RUN
 
 
#endif // QGSPROCESSINGPARAMETERMESHDATASET_H