QGIS API Documentation  3.17.0-Master (a035f434f4)
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;
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 
61  private:
62 
63  QString mFieldName;
64  QString mWeightFieldName;
65  QString mClassFieldName;
66  int mWeightFieldIndex = -1;
67  int mClassFieldIndex = -1;
68  mutable int mDestFieldIndex = -1;
69  mutable QgsFields mFields;
70  mutable QgsCoordinateReferenceSystem mCrs;
71  QgsAttributeList mPointAttributes;
72  std::unique_ptr< QgsProcessingFeatureSource > mPointSource;
73 
74 };
75 
77 
78 #endif // QGSALGORITHMPOINTSINPOLYGON_H
79 
80 
virtual QString outputName() const =0
Returns the translated, user visible name for any layers created by this algorithm.
virtual QgsFields outputFields(const QgsFields &inputFields) const
Maps the input source fields (inputFields) to corresponding output fields generated by the algorithm...
virtual bool prepareAlgorithm(const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback) SIP_THROW(QgsProcessingException)
Prepares the algorithm to run using the specified parameters.
virtual QIcon icon() const
Returns an icon for the algorithm.
Base class for providing feedback from a processing algorithm.
virtual QgsFeatureList processFeature(const QgsFeature &feature, QgsProcessingContext &context, QgsProcessingFeedback *feedback) SIP_THROW(QgsProcessingException)=0
Processes an individual input feature from the source.
QList< QgsFeature > QgsFeatureList
Definition: qgsfeature.h:583
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 inputParameterName() const
Returns the name of the parameter corresponding to the input layer.
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...
The feature class encapsulates a single feature including its id, geometry and a list of field/values...
Definition: qgsfeature.h:55
virtual QList< int > inputLayerTypes() const
Returns the valid input layer types for the source layer for this algorithm.
virtual QString shortHelpString() const
Returns a localised short helper string for the algorithm.
#define SIP_FACTORY
Definition: qgis_sip.h:76
virtual QgsProcessingAlgorithm * createInstance() const =0
Creates a new instance of the algorithm class.
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 shortDescription() const
Returns an optional translated short description of the algorithm.
SourceType
Data source types enum.
Definition: qgsprocessing.h:44
virtual void initParameters(const QVariantMap &configuration=QVariantMap())
Initializes any extra parameters added by the algorithm subclass.
virtual QString inputParameterDescription() const
Returns the translated description of the parameter corresponding to the input layer.
virtual QString groupId() const
Returns the unique ID of the group this algorithm belongs to.
QList< int > QgsAttributeList
Definition: qgsfield.h:26
An abstract QgsProcessingAlgorithm base class for processing algorithms which operate "feature-by-fea...
Contains information about the context in which a processing algorithm is executed.
virtual QgsCoordinateReferenceSystem outputCrs(const QgsCoordinateReferenceSystem &inputCrs) const
Maps the input source coordinate reference system (inputCrs) to a corresponding output CRS generated ...
virtual QgsProcessing::SourceType outputLayerType() const
Returns the layer type for layers generated by this algorithm, if this is possible to determine in ad...
virtual QString svgIconPath() const
Returns a path to an SVG version of the algorithm&#39;s icon.