QGIS API Documentation  3.21.0-Master (56b4176581)
qgsalgorithmpointsinpolygon.h
Go to the documentation of this file.
1 /***************************************************************************
2  qgsalgorithmpointsinpolygon.h
3  ---------------------
4  begin : November 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 QGSALGORITHMPOINTSINPOLYGON_H
19 #define QGSALGORITHMPOINTSINPOLYGON_H
20 
21 #define SIP_NO_FILE
22 
23 #include "qgis.h"
24 #include "qgsprocessingalgorithm.h"
25 
27 
31 class QgsPointsInPolygonAlgorithm : public QgsProcessingFeatureBasedAlgorithm
32 {
33 
34  public:
35 
36  QgsPointsInPolygonAlgorithm() = default;
37  void initParameters( const QVariantMap &configuration = QVariantMap() ) override;
38  QString name() const override;
39  QString displayName() const override;
40  QStringList tags() const override;
41  QString svgIconPath() const override;
42  QIcon icon() const override;
43  QString group() const override;
44  QString groupId() const override;
45  QString shortHelpString() const override;
46  QString shortDescription() const override;
47  QgsPointsInPolygonAlgorithm *createInstance() const override SIP_FACTORY;
48  QList<int> inputLayerTypes() const override;
49  QgsProcessing::SourceType outputLayerType() const override;
51 
52 
53  protected:
54  QString inputParameterName() const override;
55  QString inputParameterDescription() const override;
56  QString outputName() const override;
57  bool prepareAlgorithm( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback ) override;
58  QgsFeatureList processFeature( const QgsFeature &feature, QgsProcessingContext &context, QgsProcessingFeedback *feedback ) override;
59  QgsFields outputFields( const QgsFields &inputFields ) const override;
60  bool supportInPlaceEdit( const QgsMapLayer *layer ) const override;
61 
62  private:
63  bool mIsInPlace = false;
64  QString mFieldName;
65  QString mWeightFieldName;
66  QString mClassFieldName;
67  int mWeightFieldIndex = -1;
68  int mClassFieldIndex = -1;
69  mutable int mDestFieldIndex = -1;
70  mutable QgsFields mFields;
71  mutable QgsCoordinateReferenceSystem mCrs;
72  QgsAttributeList mPointAttributes;
73  std::unique_ptr< QgsProcessingFeatureSource > mPointSource;
74 
75 };
76 
78 
79 #endif // QGSALGORITHMPOINTSINPOLYGON_H
80 
81 
This class represents a coordinate reference system (CRS).
The feature class encapsulates a single feature including its unique ID, geometry and a list of field...
Definition: qgsfeature.h:56
Container of fields for a vector layer.
Definition: qgsfields.h:45
Base class for all map layer types.
Definition: qgsmaplayer.h:72
virtual QString group() const
Returns the name of the group this algorithm belongs to.
virtual QString groupId() const
Returns the unique ID of the group this algorithm belongs to.
virtual QIcon icon() const
Returns an icon for the algorithm.
virtual QString shortHelpString() const
Returns a localised short helper string for the algorithm.
virtual QString shortDescription() const
Returns an optional translated short description of the algorithm.
virtual QString displayName() const =0
Returns the translated algorithm name, which should be used for any user-visible display of the algor...
virtual QgsProcessingAlgorithm * createInstance() const =0
Creates a new instance of the algorithm class.
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 svgIconPath() const
Returns a path to an SVG version of the algorithm's icon.
virtual QString name() const =0
Returns the algorithm name, used for identifying the algorithm.
Contains information about the context in which a processing algorithm is executed.
An abstract QgsProcessingAlgorithm base class for processing algorithms which operate "feature-by-fea...
virtual void initParameters(const QVariantMap &configuration=QVariantMap())
Initializes any extra parameters added by the algorithm subclass.
Base class for providing feedback from a processing algorithm.
SourceType
Data source types enum.
Definition: qgsprocessing.h:46
#define SIP_FACTORY
Definition: qgis_sip.h:76
QList< QgsFeature > QgsFeatureList
Definition: qgsfeature.h:834
QList< int > QgsAttributeList
Definition: qgsfield.h:26
const QgsCoordinateReferenceSystem & outputCrs