QGIS API Documentation
4.3.0-Master (52aa6503bed)
Toggle main menu visibility
Loading...
Searching...
No Matches
src
analysis
processing
qgsalgorithmgenerateelevationprofile.h
Go to the documentation of this file.
1
/***************************************************************************
2
qgsalgorithmgenerateelevationprofile.h
3
---------------------
4
begin : October 2024
5
copyright : (C) 2024 by Mathieu Pellerin
6
email : mathieu at opengis dot ch
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 QGSALGORITHMGENERATEELEVATIONPROFILE_H
19
#define QGSALGORITHMGENERATEELEVATIONPROFILE_H
20
21
22
#include "
qgis_sip.h
"
23
#include "
qgsapplication.h
"
24
#include "
qgsprocessingalgorithm.h
"
25
#include "
qgsprofilerenderer.h
"
26
27
#define SIP_NO_FILE
28
29
class
QgsProfilePlotRenderer
;
30
32
36
class
QgsGenerateElevationProfileAlgorithm :
public
QgsProcessingAlgorithm
37
{
38
public
:
39
QgsGenerateElevationProfileAlgorithm() =
default
;
40
void
initAlgorithm
(
const
QVariantMap &configuration = QVariantMap() )
override
;
41
QString
name
()
const override
;
42
QString
displayName
()
const override
;
43
QStringList
tags
()
const override
;
44
QString
group
()
const override
;
45
QString
groupId
()
const override
;
46
QString
shortHelpString
()
const override
;
47
QString
shortDescription
()
const override
;
48
QgsGenerateElevationProfileAlgorithm *
createInstance
() const override
SIP_FACTORY
;
49
50
protected:
51
bool
prepareAlgorithm( const QVariantMap ¶meters,
QgsProcessingContext
&context,
QgsProcessingFeedback
*feedback ) override;
52
QVariantMap processAlgorithm( const QVariantMap ¶meters,
QgsProcessingContext
&context,
QgsProcessingFeedback
*feedback ) override;
53
54
private:
55
std::unique_ptr<
QgsProfilePlotRenderer
> mRenderer;
56
57
static constexpr
double
MAX_ERROR_PIXELS = 2;
58
};
59
61
62
#endif
// QGSALGORITHMGENERATEELEVATIONPROFILE_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
QgsProfilePlotRenderer
Generates and renders elevation profile plots.
Definition
qgsprofilerenderer.h:60
qgis_sip.h
SIP_FACTORY
#define SIP_FACTORY
Definition
qgis_sip.h:83
qgsapplication.h
qgsprocessingalgorithm.h
qgsprofilerenderer.h
Generated on
for QGIS API Documentation by
1.17.0