QGIS API Documentation  3.14.0-Pi (9f7028fd23)
qgsalgorithmrandompointsonlines.h
Go to the documentation of this file.
1 /***************************************************************************
2  qgsalgorithmrandompointsonlines.h
3  ---------------------
4  begin : March 2020
5  copyright : (C) 2020 by HÃ¥vard Tveite
6  email : havard dot tveite at nmbu dot no
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 
19 #ifndef QGSALGORITHMRANDOMPOINTSONLINES_H
20 #define QGSALGORITHMRANDOMPOINTSONLINES_H
21 
22 #define SIP_NO_FILE
23 
24 #include "qgis_sip.h"
25 #include "qgsprocessingalgorithm.h"
26 #include "qgsapplication.h"
27 
29 
33 class QgsRandomPointsOnLinesAlgorithm : public QgsProcessingAlgorithm
34 {
35  public:
36 
37  QgsRandomPointsOnLinesAlgorithm() = default;
38  void initAlgorithm( const QVariantMap &configuration = QVariantMap() ) override;
39  QIcon icon() const override { return QgsApplication::getThemeIcon( QStringLiteral( "/algorithms/mAlgorithmRandomPointsOnLines.svg" ) ); }
40  QString svgIconPath() const override { return QgsApplication::iconPath( QStringLiteral( "/algorithms/mAlgorithmRandomPointsOnLines.svg" ) ); }
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  QgsRandomPointsOnLinesAlgorithm *createInstance() const override SIP_FACTORY;
48 
49  protected:
50  bool prepareAlgorithm( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback * ) override;
51  QVariantMap processAlgorithm( const QVariantMap &parameters,
52  QgsProcessingContext &context,
53  QgsProcessingFeedback *feedback ) override;
54 
55 
56  private:
57  int mNumPoints;
58  bool mDynamicNumPoints = false;
59  QgsProperty mNumPointsProperty;
60 
61  double mMinDistance = 0;
62  bool mDynamicMinDistance = false;
63  QgsProperty mMinDistanceProperty;
64 
65  double mMinDistanceGlobal = 0;
66 
67  int mMaxAttempts = 10;
68  bool mDynamicMaxAttempts = false;
69  QgsProperty mMaxAttemptsProperty;
70 
71  bool mUseRandomSeed = false;
72  int mRandSeed = 0;
73  bool mIncludeLineAttr = false;
74 };
75 
77 
78 #endif // QGSALGORITHMRANDOMPOINTSONLINES_H
QgsProperty
A store for object properties.
Definition: qgsproperty.h:231
QgsApplication::getThemeIcon
static QIcon getThemeIcon(const QString &name)
Helper to get a theme icon.
Definition: qgsapplication.cpp:605
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
Definition: qgsprocessingfeedback.h:37
QgsProcessingAlgorithm::groupId
virtual QString groupId() const
Returns the unique ID of the group this algorithm belongs to.
Definition: qgsprocessingalgorithm.h:231
QgsProcessingAlgorithm::createInstance
virtual QgsProcessingAlgorithm * createInstance() const =0
Creates a new instance of the algorithm class.
QgsProcessingAlgorithm::svgIconPath
virtual QString svgIconPath() const
Returns a path to an SVG version of the algorithm's icon.
Definition: qgsprocessingalgorithm.cpp:83
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:359
QgsApplication::iconPath
static QString iconPath(const QString &iconFile)
Returns path to the desired icon file.
Definition: qgsapplication.cpp:594
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
Definition: qgsprocessingcontext.h:43
qgsprocessingalgorithm.h
qgis_sip.h
QgsProcessingAlgorithm::shortHelpString
virtual QString shortHelpString() const
Returns a localised short helper string for the algorithm.
Definition: qgsprocessingalgorithm.cpp:63
QgsProcessingAlgorithm
Definition: qgsprocessingalgorithm.h:51
QgsProcessingAlgorithm::icon
virtual QIcon icon() const
Returns an icon for the algorithm.
Definition: qgsprocessingalgorithm.cpp:78
QgsProcessingAlgorithm::group
virtual QString group() const
Returns the name of the group this algorithm belongs to.
Definition: qgsprocessingalgorithm.h:222
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:178
QgsProcessingAlgorithm::initAlgorithm
virtual void initAlgorithm(const QVariantMap &configuration=QVariantMap())=0
Initializes the algorithm using the specified configuration.