QGIS API Documentation  3.17.0-Master (ca637cfeb2)
qgsalgorithmrandompointsinpolygons.h
Go to the documentation of this file.
1 /***************************************************************************
2  qgsalgorithmrandompointsinpolygons.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 QGSALGORITHMRANDOMPOINTSINPOLYGONS_H
20 #define QGSALGORITHMRANDOMPOINTSINPOLYGONS_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 QgsRandomPointsInPolygonsAlgorithm : public QgsProcessingAlgorithm
34 {
35  public:
36  QgsRandomPointsInPolygonsAlgorithm() = default;
37  void initAlgorithm( const QVariantMap &configuration = QVariantMap() ) override;
38  QIcon icon() const override { return QgsApplication::getThemeIcon( QStringLiteral( "/algorithms/mAlgorithmRandomPointsInPolygons.svg" ) ); }
39  QString svgIconPath() const override { return QgsApplication::iconPath( QStringLiteral( "/algorithms/mAlgorithmRandomPointsInPolygons.svg" ) ); }
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  QgsRandomPointsInPolygonsAlgorithm *createInstance() const override SIP_FACTORY;
47 
48  protected:
49  bool prepareAlgorithm( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback * ) override;
50  QVariantMap processAlgorithm( const QVariantMap &parameters,
51  QgsProcessingContext &context,
52  QgsProcessingFeedback *feedback ) override;
53 
54  private:
55  int mNumPoints;
56  bool mDynamicNumPoints = false;
57  QgsProperty mNumPointsProperty;
58 
59  double mMinDistance = 0;
60  bool mDynamicMinDistance = false;
61  QgsProperty mMinDistanceProperty;
62 
63  double mMinDistanceGlobal = 0;
64 
65  int mMaxAttempts = 10;
66  bool mDynamicMaxAttempts = false;
67  QgsProperty mMaxAttemptsProperty;
68 
69  bool mUseRandomSeed = false;
70  int mRandSeed = 0;
71  bool mIncludePolygonAttr = false;
72 };
73 
75 
76 #endif // QGSALGORITHMRANDOMPOINTSINPOLYGONS_H
virtual bool prepareAlgorithm(const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback) SIP_THROW(QgsProcessingException)
Prepares the algorithm to run using the specified parameters.
virtual QIcon icon() const
Returns an icon for the algorithm.
Base class for providing feedback from a processing algorithm.
virtual QString name() const =0
Returns the algorithm name, used for identifying the algorithm.
virtual QString group() const
Returns the name of the group this algorithm belongs to.
static QString iconPath(const QString &iconFile)
Returns path to the desired icon file.
static QIcon getThemeIcon(const QString &name)
Helper to get a theme icon.
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 QString shortHelpString() const
Returns a localised short helper string for the algorithm.
Abstract base class for processing algorithms.
virtual void initAlgorithm(const QVariantMap &configuration=QVariantMap())=0
Initializes the algorithm using the specified configuration.
#define SIP_FACTORY
Definition: qgis_sip.h:76
A store for object properties.
Definition: qgsproperty.h:231
virtual QgsProcessingAlgorithm * createInstance() const =0
Creates a new instance of the algorithm class.
virtual QVariantMap processAlgorithm(const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback) SIP_THROW(QgsProcessingException)=0
Runs the algorithm using the specified parameters.
virtual QString displayName() const =0
Returns the translated algorithm name, which should be used for any user-visible display of the algor...
virtual QString groupId() const
Returns the unique ID of the group this algorithm belongs to.
Contains information about the context in which a processing algorithm is executed.
virtual QString svgIconPath() const
Returns a path to an SVG version of the algorithm's icon.