QGIS API Documentation  3.26.3-Buenos Aires (65e4edfdad)
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 shortDescription() const override;
36  QString name() const override;
37  QString displayName() const override;
38  bool canExecute( QString *errorMessage ) const override;
39 
40  protected:
41  QgsProcessingAlgorithm *createInstance() const override;
42 
43  void initAlgorithm( const QVariantMap &configuration = QVariantMap() ) override;
44  bool prepareAlgorithm( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback ) override;
45  QVariantMap processAlgorithm( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback ) override;
46 
47  private:
48  QStringList mAvailableFormat;
49  QMap<QString, QString> mDriverSuffix;
50 
51  struct Layer
52  {
54  QgsCoordinateTransform transform;
55  int attributeIndex;
56  long long featureCount;
57  };
58 
59  QList<Layer> mVerticesLayer;
60  QList<Layer> mBreakLinesLayer;
61 
62  void addZValueDataset( const QString &fileName, const QgsMesh &mesh, const QString &driver );
63 };
64 
66 
67 #endif // QGSALGORITHMTINMESHCREATION_H
QgsProcessingAlgorithm::shortDescription
virtual QString shortDescription() const
Returns an optional translated short description of the algorithm.
Definition: qgsprocessingalgorithm.cpp:60
QgsProcessingAlgorithm::canExecute
virtual bool canExecute(QString *errorMessage=nullptr) const
Returns true if the algorithm can execute.
Definition: qgsprocessingalgorithm.cpp:95
QgsProcessingAlgorithm::displayName
virtual QString displayName() const =0
Returns the translated algorithm name, which should be used for any user-visible display of the algor...
QgsProcessingFeedback
Base class for providing feedback from a processing algorithm.
Definition: qgsprocessingfeedback.h:37
QgsProcessingAlgorithm::groupId
virtual QString groupId() const
Returns the unique ID of the group this algorithm belongs to.
Definition: qgsprocessingalgorithm.h:234
QgsProcessingAlgorithm::createInstance
virtual QgsProcessingAlgorithm * createInstance() const =0
Creates a new instance of the algorithm class.
QgsMesh
Mesh - vertices, edges and faces.
Definition: qgsmeshdataprovider.h:58
QgsProcessingAlgorithm::prepareAlgorithm
virtual bool prepareAlgorithm(const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback) SIP_THROW(QgsProcessingException)
Prepares the algorithm to run using the specified parameters.
Definition: qgsprocessingalgorithm.cpp:451
QgsProcessingAlgorithm::name
virtual QString name() const =0
Returns the algorithm name, used for identifying the algorithm.
QgsProcessingAlgorithm::processAlgorithm
virtual QVariantMap processAlgorithm(const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback) SIP_THROW(QgsProcessingException)=0
Runs the algorithm using the specified parameters.
QgsProcessingContext
Contains information about the context in which a processing algorithm is executed.
Definition: qgsprocessingcontext.h:46
qgsprocessingalgorithm.h
QgsProcessingAlgorithm::shortHelpString
virtual QString shortHelpString() const
Returns a localised short helper string for the algorithm.
Definition: qgsprocessingalgorithm.cpp:65
QgsProcessingAlgorithm
Abstract base class for processing algorithms.
Definition: qgsprocessingalgorithm.h:52
QgsProcessingAlgorithm::group
virtual QString group() const
Returns the name of the group this algorithm belongs to.
Definition: qgsprocessingalgorithm.h:225
QgsCoordinateTransform
Class for doing transforms between two map coordinate systems.
Definition: qgscoordinatetransform.h:57
QgsFeatureIterator
Wrapper for iterator of features from vector data provider or vector layer.
Definition: qgsfeatureiterator.h:289
QgsProcessingAlgorithm::initAlgorithm
virtual void initAlgorithm(const QVariantMap &configuration=QVariantMap())=0
Initializes the algorithm using the specified configuration.