QGIS API Documentation  3.4.15-Madeira (e83d02e274)
Go to the documentation of this file.
1 /***************************************************************************
2  qgsalgorithmwedgebuffers.h
3  ---------------------
4  begin : April 2018
5  copyright : (C) 2018 by Nyall Dawson
6  email : nyall dot dawson at gmail dot com
7  ***************************************************************************/
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  ***************************************************************************/
21 #define SIP_NO_FILE
23 #include "qgis.h"
24 #include "qgsprocessingalgorithm.h"
31 class QgsWedgeBuffersAlgorithm : public QgsProcessingFeatureBasedAlgorithm
32 {
34  public:
36  QgsWedgeBuffersAlgorithm() = default;
37  QString name() const override;
38  QString displayName() const override;
39  QStringList tags() const override;
40  QString group() const override;
41  QString groupId() const override;
42  QString shortHelpString() const override;
43  QList<int> inputLayerTypes() const override;
45  QgsWedgeBuffersAlgorithm *createInstance() const override SIP_FACTORY;
47  protected:
49  void initParameters( const QVariantMap &configuration = QVariantMap() ) override;
50  QString outputName() const override;
51  QgsWkbTypes::Type outputWkbType( QgsWkbTypes::Type inputWkbType ) const override;
53  bool prepareAlgorithm( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback ) override;
54  QgsFeatureList processFeature( const QgsFeature &feature, QgsProcessingContext &context, QgsProcessingFeedback *feedback ) override;
56  private:
58  double mAzimuth = 0.0;
59  bool mDynamicAzimuth = false;
60  QgsProperty mAzimuthProperty;
61  double mWidth = 45.0;
62  bool mDynamicWidth = false;
63  QgsProperty mWidthProperty;
64  double mOuterRadius = 1.0;
65  bool mDynamicOuterRadius = false;
66  QgsProperty mOuterRadiusProperty;
67  double mInnerRadius = 1.0;
68  bool mDynamicInnerRadius = false;
69  QgsProperty mInnerRadiusProperty;
71 };
virtual QString outputName() const =0
Returns the translated, user visible name for any layers created by this algorithm.
virtual bool prepareAlgorithm(const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback) SIP_THROW(QgsProcessingException)
Prepares the algorithm to run using the specified parameters.
Base class for providing feedback from a processing algorithm.
virtual QgsFeatureList processFeature(const QgsFeature &feature, QgsProcessingContext &context, QgsProcessingFeedback *feedback) SIP_THROW(QgsProcessingException)=0
Processes an individual input feature from the source.
virtual QgsProcessingFeatureSource::Flag sourceFlags() const
Returns the processing feature source flags to be used in the algorithm.
QList< QgsFeature > QgsFeatureList
Definition: qgsfeature.h:571
virtual QString name() const =0
Returns the algorithm name, used for identifying the algorithm.
virtual QgsProcessing::SourceType outputLayerType() const
Returns the layer type for layers generated by this algorithm, if this is possible to determine in ad...
The feature class encapsulates a single feature including its id, geometry and a list of field/values...
Definition: qgsfeature.h:55
virtual QgsWkbTypes::Type outputWkbType(QgsWkbTypes::Type inputWkbType) const
Maps the input WKB geometry type (inputWkbType) to the corresponding output WKB type generated by the...
virtual QStringList tags() const
Returns a list of tags which relate to the algorithm, and are used to assist users in searching for s...
The WKB type describes the number of dimensions a geometry has.
Definition: qgswkbtypes.h:68
Definition: qgis_sip.h:69
A store for object properties.
Definition: qgsproperty.h:229
virtual QgsProcessingAlgorithm * createInstance() const =0
Creates a new instance of the algorithm class.
Flags controlling how QgsProcessingFeatureSource fetches features.
virtual QString groupId() const
Returns the unique ID of the group this algorithm belongs to.
virtual QString displayName() const =0
Returns the translated algorithm name, which should be used for any user-visible display of the algor...
virtual QString group() const
Returns the name of the group this algorithm belongs to.
Data source types enum.
Definition: qgsprocessing.h:44
virtual void initParameters(const QVariantMap &configuration=QVariantMap())
Initializes any extra parameters added by the algorithm subclass.
virtual QList< int > inputLayerTypes() const
Returns the valid input layer types for the source layer for this algorithm.
An abstract QgsProcessingAlgorithm base class for processing algorithms which operate "feature-by-fea...
Contains information about the context in which a processing algorithm is executed.
virtual QString shortHelpString() const
Returns a localised short helper string for the algorithm.