QGIS API Documentation  3.17.0-Master (ca637cfeb2)
qgsalgorithmtinmeshcreation.h
Go to the documentation of this file.
1 /***************************************************************************
2  qgsalgorithmtinmeshcreation.h
3  ---------------------------
4  begin : August 2020
5  copyright : (C) 2020 by Vincent Cloarec
6  email : vcloarec at gmail dot com
7  ***************************************************************************/
8 
9 /***************************************************************************
10  * *
11  * This program is free software; you can redistribute it and/or modify *
12  * it under the terms of the GNU General Public License as published by *
13  * the Free Software Foundation; either version 2 of the License, or *
14  * (at your option) any later version. *
15  * *
16  ***************************************************************************/
17 
18 #ifndef QGSALGORITHMTINMESHCREATION_H
19 #define QGSALGORITHMTINMESHCREATION_H
20 
21 #define SIP_NO_FILE
22 
23 #include "qgsprocessingalgorithm.h"
24 
26 struct QgsMesh;
27 
28 class QgsTinMeshCreationAlgorithm: public QgsProcessingAlgorithm
29 {
30  public:
31 
32  QString group() const override;
33  QString groupId() const override;
34  QString shortHelpString() const override;
35  QString name() const override;
36  QString displayName() const override;
37  bool canExecute( QString *errorMessage ) const override;
38 
39  protected:
40  QgsProcessingAlgorithm *createInstance() const override;
41 
42  void initAlgorithm( const QVariantMap &configuration = QVariantMap() ) override;
43  bool prepareAlgorithm( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback ) override;
44  QVariantMap processAlgorithm( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback ) override;
45 
46  private:
47  QStringList mAvailableFormat;
48 
49  struct Layer
50  {
52  QgsCoordinateTransform transform;
53  int attributeIndex;
54  int featureCount;
55  };
56 
57  QList<Layer> mVerticesLayer;
58  QList<Layer> mBreakLinesLayer;
59 
60  void addZValueDataset( const QString &fileName, const QgsMesh &mesh, const QString &driver );
61 };
62 
64 
65 #endif // QGSALGORITHMTINMESHCREATION_H
virtual bool prepareAlgorithm(const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback) SIP_THROW(QgsProcessingException)
Prepares the algorithm to run using the specified parameters.
Wrapper for iterator of features from vector data provider or vector layer.
Base class for providing feedback from a processing algorithm.
virtual QString name() const =0
Returns the algorithm name, used for identifying the algorithm.
virtual QString group() const
Returns the name of the group this algorithm belongs to.
virtual QString shortHelpString() const
Returns a localised short helper string for the algorithm.
Abstract base class for processing algorithms.
virtual void initAlgorithm(const QVariantMap &configuration=QVariantMap())=0
Initializes the algorithm using the specified configuration.
virtual QgsProcessingAlgorithm * createInstance() const =0
Creates a new instance of the algorithm class.
virtual QVariantMap processAlgorithm(const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback) SIP_THROW(QgsProcessingException)=0
Runs the algorithm using the specified parameters.
Mesh - vertices, edges and faces.
virtual bool canExecute(QString *errorMessage=nullptr) const
Returns true if the algorithm can execute.
virtual QString displayName() const =0
Returns the translated algorithm name, which should be used for any user-visible display of the algor...
Class for doing transforms between two map coordinate systems.
virtual QString groupId() const
Returns the unique ID of the group this algorithm belongs to.
Contains information about the context in which a processing algorithm is executed.