QGIS API Documentation  3.26.3-Buenos Aires (65e4edfdad)
qgsalgorithmshortestline.h
Go to the documentation of this file.
1 /***************************************************************************
2  qgsalgorithmshortestline.cpp
3  ---------------------
4  begin : September 2021
5  copyright : (C) 2020 by Matteo Ghetta, Clemens Raffler
6  email : clemens dot raffler 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 //Disclaimer:This feature was originally developed in Python by: Matteo Ghetta, 2021
19 
20 #ifndef QGSALGORITHMSHORTESTLINE_H
21 #define QGSALGORITHMSHORTESTLINE_H
22 
23 #define SIP_NO_FILE
24 
25 #include "qgis_sip.h"
26 #include "qgsapplication.h"
27 #include "qgsprocessingalgorithm.h"
28 
30 
34 class QgsShortestLineAlgorithm : public QgsProcessingAlgorithm
35 {
36 
37  public:
38  QgsShortestLineAlgorithm() = default;
39  void initAlgorithm( const QVariantMap &configuration = QVariantMap() ) override;
40  QString name() const override;
41  QString displayName() const override;
42  QStringList tags() const override;
43  QString group() const override;
44  QString groupId() const override;
45  QString shortHelpString() const override;
46  QgsShortestLineAlgorithm *createInstance() const override SIP_FACTORY;
47 
48  protected:
49  bool prepareAlgorithm( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback * ) override;
50  QVariantMap processAlgorithm( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback ) override;
51 
52  private:
53  std::unique_ptr< QgsFeatureSource > mSource;
54  std::unique_ptr< QgsFeatureSource > mDestination;
55  int mMethod = 0;
56  long long mKNeighbors = 1;
57  double mMaxDistance = 0.0;
58 
59 
60 };
61 
63 
64 #endif // QGSALGORITHMSHORTESTLINE_H
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.
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
SIP_FACTORY
#define SIP_FACTORY
Definition: qgis_sip.h:76
qgsapplication.h
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
qgis_sip.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
QgsProcessingAlgorithm::tags
virtual QStringList tags() const
Returns a list of tags which relate to the algorithm, and are used to assist users in searching for s...
Definition: qgsprocessingalgorithm.h:181
QgsProcessingAlgorithm::initAlgorithm
virtual void initAlgorithm(const QVariantMap &configuration=QVariantMap())=0
Initializes the algorithm using the specified configuration.