QGIS API Documentation
4.3.0-Master (52aa6503bed)
Toggle main menu visibility
Loading...
Searching...
No Matches
src
analysis
processing
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
24
#include "
qgis_sip.h
"
25
#include "
qgsapplication.h
"
26
#include "
qgsprocessingalgorithm.h
"
27
28
#define SIP_NO_FILE
29
31
35
class
QgsShortestLineAlgorithm :
public
QgsProcessingAlgorithm
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
QString
shortDescription
()
const override
;
47
QgsShortestLineAlgorithm *
createInstance
()
const
override
SIP_FACTORY
;
48
49
protected
:
50
bool
prepareAlgorithm(
const
QVariantMap ¶meters,
QgsProcessingContext
&context,
QgsProcessingFeedback
* )
override
;
51
QVariantMap processAlgorithm(
const
QVariantMap ¶meters,
QgsProcessingContext
&context,
QgsProcessingFeedback
*feedback )
override
;
52
53
private
:
54
std::unique_ptr<QgsFeatureSource> mSource;
55
std::unique_ptr<QgsFeatureSource> mDestination;
56
int
mMethod = 0;
57
long
long
mKNeighbors = 1;
58
double
mMaxDistance = 0.0;
59
};
60
62
63
#endif
// QGSALGORITHMSHORTESTLINE_H
QgsProcessingAlgorithm
Abstract base class for processing algorithms.
Definition
qgsprocessingalgorithm.h:61
QgsProcessingAlgorithm::createInstance
virtual QgsProcessingAlgorithm * createInstance() const =0
Creates a new instance of the algorithm class.
QgsProcessingAlgorithm::group
virtual QString group() const
Returns the name of the group this algorithm belongs to.
Definition
qgsprocessingalgorithm.h:259
QgsProcessingAlgorithm::groupId
virtual QString groupId() const
Returns the unique ID of the group this algorithm belongs to.
Definition
qgsprocessingalgorithm.h:268
QgsProcessingAlgorithm::shortHelpString
virtual QString shortHelpString() const
Returns a localised short helper string for the algorithm.
Definition
qgsprocessingalgorithm.cpp:83
QgsProcessingAlgorithm::shortDescription
virtual QString shortDescription() const
Returns an optional translated short description of the algorithm.
Definition
qgsprocessingalgorithm.cpp:78
QgsProcessingAlgorithm::displayName
virtual QString displayName() const =0
Returns the translated algorithm name, which should be used for any user-visible display of the algor...
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:169
QgsProcessingAlgorithm::initAlgorithm
virtual void initAlgorithm(const QVariantMap &configuration=QVariantMap())=0
Initializes the algorithm using the specified configuration.
QgsProcessingAlgorithm::name
virtual QString name() const =0
Returns the algorithm name, used for identifying the algorithm.
QgsProcessingContext
Contains information about the context in which a processing algorithm is executed.
Definition
qgsprocessingcontext.h:45
QgsProcessingFeedback
Base class for providing feedback from a processing algorithm.
Definition
qgsprocessingfeedback.h:40
qgis_sip.h
SIP_FACTORY
#define SIP_FACTORY
Definition
qgis_sip.h:83
qgsapplication.h
qgsprocessingalgorithm.h
Generated on
for QGIS API Documentation by
1.17.0