QGIS API Documentation  3.17.0-Master (a035f434f4)
qgsalgorithmcalculateoverlaps.h
Go to the documentation of this file.
1 /***************************************************************************
2  qgsalgorithmcalculateoverlaps.h
3  ------------------
4  begin : May 2019
5  copyright : (C) 2019 by Nyall Dawson
6  email : nyall dot dawson 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 QGSALGORITHMCALCULATEOVERLAPS_H
19 #define QGSALGORITHMCALCULATEOVERLAPS_H
20 
21 #define SIP_NO_FILE
22 
23 #include "qgis_sip.h"
24 #include "qgsprocessingalgorithm.h"
25 #include "qgsapplication.h"
27 
29 
33 class QgsCalculateVectorOverlapsAlgorithm : public QgsProcessingAlgorithm
34 {
35 
36  public:
37 
38  QgsCalculateVectorOverlapsAlgorithm() = default;
39  void initAlgorithm( const QVariantMap &configuration = QVariantMap() ) override;
40  QIcon icon() const override;
41  QString svgIconPath() const override;
42  QString name() const override;
43  QString displayName() const override;
44  QStringList tags() const override;
45  QString group() const override;
46  QString groupId() const override;
47  QString shortHelpString() const override;
48  QgsCalculateVectorOverlapsAlgorithm *createInstance() const override SIP_FACTORY;
49 
50  protected:
51 
52  bool prepareAlgorithm( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback ) override;
53  QVariantMap processAlgorithm( const QVariantMap &parameters,
54  QgsProcessingContext &context, QgsProcessingFeedback *feedback ) override;
55 
56  private:
57 
58  std::unique_ptr< QgsProcessingFeatureSource > mSource;
59  QStringList mLayerNames;
60  std::vector< std::unique_ptr< QgsVectorLayerFeatureSource > > mOverlayerSources;
61  QgsFields mOutputFields;
64  QgsFeatureIterator mInputFeatures;
65  long mInputCount = 0;
66 
67 };
68 
70 
71 #endif // QGSALGORITHMCALCULATEOVERLAPS_H
72 
73 
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.
virtual QIcon icon() const
Returns an icon for the algorithm.
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.
Container of fields for a vector layer.
Definition: qgsfields.h:44
virtual QStringList tags() const
Returns a list of tags which relate to the algorithm, and are used to assist users in searching for s...
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.
Type
The WKB type describes the number of dimensions a geometry has.
Definition: qgswkbtypes.h:69
#define SIP_FACTORY
Definition: qgis_sip.h:76
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.
virtual QString displayName() const =0
Returns the translated algorithm name, which should be used for any user-visible display of the algor...
This class represents a coordinate reference system (CRS).
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.
virtual QString svgIconPath() const
Returns a path to an SVG version of the algorithm&#39;s icon.