qgsmeshcalculator.h

Go to the documentation of this file.

/***************************************************************************
                          qgsmeshcalculator.h
                          -------------------
    begin                : December 18th, 2018
    copyright            : (C) 2018 by Peter Petrik
    email                : zilolv 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 QGSMESHCALCULATOR_H
#define QGSMESHCALCULATOR_H
 
#include "qgis_core.h"
#include "qgis_sip.h"
#include "qgsgeometry.h"
#include "qgsmeshdataset.h"
#include "qgsprovidermetadata.h"
#include "qgsrectangle.h"
 
#include <QString>
#include <QStringList>
#include <QVector>
 
class QgsMeshLayer;
class QgsFeedback;

class CORE_EXPORT QgsMeshCalculator
{
  public:
    enum Result
    {
      Success = 0,       
      Canceled,          
      CreateOutputError, 
      InputLayerError,   
      ParserError,       
      InvalidDatasets,   
      EvaluateError,     
      MemoryError,       
    };

    Q_DECL_DEPRECATED QgsMeshCalculator( const QString &formulaString, const QString &outputFile, const QgsRectangle &outputExtent, double startTime, double endTime, QgsMeshLayer *layer )
      SIP_DEPRECATED;

    Q_DECL_DEPRECATED QgsMeshCalculator( const QString &formulaString, const QString &outputFile, const QgsGeometry &outputMask, double startTime, double endTime, QgsMeshLayer *layer ) SIP_DEPRECATED;

    QgsMeshCalculator(
      const QString &formulaString, const QString &outputDriver, const QString &outputGroupName, const QString &outputFile, const QgsRectangle &outputExtent, double startTime, double endTime, QgsMeshLayer *layer
    );

    QgsMeshCalculator(
      const QString &formulaString, const QString &outputDriver, const QString &outputGroupName, const QString &outputFile, const QgsGeometry &outputMask, double startTime, double endTime, QgsMeshLayer *layer
    );

    QgsMeshCalculator(
      const QString &formulaString, const QString &outputGroupName, const QgsRectangle &outputExtent, const QgsMeshDatasetGroup::Type &destination, QgsMeshLayer *layer, double startTime, double endTime
    );

    QgsMeshCalculator(
      const QString &formulaString, const QString &outputGroupName, const QgsGeometry &outputMask, const QgsMeshDatasetGroup::Type &destination, QgsMeshLayer *layer, double startTime, double endTime
    );

    Result processCalculation( QgsFeedback *feedback = nullptr );

    Q_DECL_DEPRECATED static Result expression_valid( const QString &formulaString, QgsMeshLayer *layer ) SIP_DEPRECATED;

    static Result expressionIsValid( const QString &formulaString, QgsMeshLayer *layer, QgsMeshDriverMetadata::MeshDriverCapability &requiredCapability );
 
  private:
    QgsMeshCalculator();
 
    QString mFormulaString;
    QString mOutputDriver;
    QString mOutputGroupName;
    QString mOutputFile;
    QgsRectangle mOutputExtent;
    QgsGeometry mOutputMask;
    bool mUseMask = false;
    QgsMeshDatasetGroup::Type mDestination = QgsMeshDatasetGroup::Persistent;
    double mStartTime = 0.0;
    double mEndTime = 0.0;
    QgsMeshLayer *mMeshLayer = nullptr;
};
 
#endif // QGSMESHCALCULATOR_H