QGIS API Documentation 3.39.0-Master (bca3cdb6021)
Loading...
Searching...
No Matches
qgsalgorithmjoinbylocation.h
Go to the documentation of this file.
1/***************************************************************************
2 qgsalgorithmjoinbylocation.h
3 ---------------------
4 begin : January 2020
5 copyright : (C) 2020 by Alexis Roy-Lizotte
6 email : roya2 at premiertech 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 QGSALGORITHMJOINBYLOCATION_H
19#define QGSALGORITHMJOINBYLOCATION_H
20
21#define SIP_NO_FILE
22
23#include "qgis.h"
25#include "qgsfeature.h"
26
27
29
35class QgsJoinByLocationAlgorithm : public QgsProcessingAlgorithm
36{
37
38 public:
39
40 QgsJoinByLocationAlgorithm() = default;
41 void initAlgorithm( const QVariantMap &configuration = QVariantMap() ) 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 QString shortDescription() const override;
50 QgsJoinByLocationAlgorithm *createInstance() const override SIP_FACTORY;
51
55 static QStringList translatedPredicates();
56
60 static void sortPredicates( QList<int > &predicates );
61
65 static bool featureFilter( const QgsFeature &feature, QgsGeometryEngine *engine, bool comparingToJoinedFeature, const QList<int> &predicates );
66
67 protected:
68 QVariantMap processAlgorithm( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback ) override;
69 bool processFeatureFromJoinSource( QgsFeature &joinFeature, QgsProcessingFeedback *feedback );
70 bool processFeatureFromInputSource( QgsFeature &inputFeature, QgsProcessingContext &context, QgsProcessingFeedback *feedback );
71
72 private:
73
74 void processAlgorithmByIteratingOverJoinedSource( QgsProcessingContext &context, QgsProcessingFeedback *feedback );
75 void processAlgorithmByIteratingOverInputSource( QgsProcessingContext &context, QgsProcessingFeedback *feedback );
76
77 enum JoinMethod
78 {
79 OneToMany = 0,
80 JoinToFirst = 1,
81 JoinToLargestOverlap = 2
82 };
83 long mJoinedCount = 0;
84 std::unique_ptr< QgsProcessingFeatureSource > mBaseSource;
85 std::unique_ptr< QgsProcessingFeatureSource > mJoinSource;
86 QgsAttributeList mJoinedFieldIndices;
87 bool mDiscardNonMatching = false;
88 std::unique_ptr< QgsFeatureSink > mJoinedFeatures;
89 QgsFeatureIds mAddedIds;
90 std::unique_ptr< QgsFeatureSink > mUnjoinedFeatures;
91 JoinMethod mJoinMethod = OneToMany;
92 QList<int> mPredicates;
93
94};
95
97
98#endif // QGSALGORITHMJOINBYLOCATION_H
99
100
QFlags< ProcessingAlgorithmDocumentationFlag > ProcessingAlgorithmDocumentationFlags
Flags describing algorithm behavior for documentation purposes.
Definition qgis.h:3339
The feature class encapsulates a single feature including its unique ID, geometry and a list of field...
Definition qgsfeature.h:58
A geometry engine is a low-level representation of a QgsAbstractGeometry object, optimised for use wi...
Abstract base class for processing algorithms.
virtual QgsProcessingAlgorithm * createInstance() const =0
Creates a new instance of the algorithm class.
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 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 QStringList tags() const
Returns a list of tags which relate to the algorithm, and are used to assist users in searching for s...
virtual void initAlgorithm(const QVariantMap &configuration=QVariantMap())=0
Initializes the algorithm using the specified configuration.
virtual QString name() const =0
Returns the algorithm name, used for identifying the algorithm.
virtual Qgis::ProcessingAlgorithmDocumentationFlags documentationFlags() const
Returns the flags describing algorithm behavior for documentation purposes.
Contains information about the context in which a processing algorithm is executed.
Base class for providing feedback from a processing algorithm.
#define SIP_FACTORY
Definition qgis_sip.h:76
QSet< QgsFeatureId > QgsFeatureIds
QList< int > QgsAttributeList
Definition qgsfield.h:27