QGIS API Documentation  3.21.0-Master (56b4176581)
qgsalgorithmpointsalonggeometry.h
Go to the documentation of this file.
1 /***************************************************************************
2  qgsalgorithmpointsalonggeometry.h
3  ---------------------
4  begin : June 2019
5  copyright : (C) 2019 by Nyall Dawson
6  email : nyall dot dawson 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 #ifndef QGSPOINTSALONGGEOMETRYALGORITHM_H
19 #define QGSPOINTSALONGGEOMETRYALGORITHM_H
20 
21 #define SIP_NO_FILE
22 
23 #include "qgis_sip.h"
24 #include "qgsprocessingalgorithm.h"
25 
27 
31 class QgsPointsAlongGeometryAlgorithm : public QgsProcessingFeatureBasedAlgorithm
32 {
33 
34  public:
35 
36  QgsPointsAlongGeometryAlgorithm() = 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  QString shortDescription() const override;
44  QList<int> inputLayerTypes() const override;
46  QgsWkbTypes::Type outputWkbType( QgsWkbTypes::Type inputWkbType ) const override;
47  QgsFields outputFields( const QgsFields &inputFields ) const override;
48  QgsPointsAlongGeometryAlgorithm *createInstance() const override SIP_FACTORY;
49  void initParameters( const QVariantMap &configuration = QVariantMap() ) override;
50  QIcon icon() const override;
51  QString svgIconPath() const override;
52 
53  protected:
54  QString outputName() const override;
55  QgsProcessingFeatureSource::Flag sourceFlags() const override;
56  QgsFeatureSink::SinkFlags sinkFlags() const override;
57  bool prepareAlgorithm( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback ) override;
58  QgsFeatureList processFeature( const QgsFeature &feature, QgsProcessingContext &, QgsProcessingFeedback *feedback ) override;
59 
60  private:
61 
62  double mDistance = 0.0;
63  bool mDynamicDistance = false;
64  QgsProperty mDistanceProperty;
65 
66  double mStartOffset = 0.0;
67  bool mDynamicStartOffset = false;
68  QgsProperty mStartOffsetProperty;
69 
70  double mEndOffset = 0.0;
71  bool mDynamicEndOffset = false;
72  QgsProperty mEndOffsetProperty;
73 
74 };
75 
76 
78 
79 #endif // QGSPOINTSALONGGEOMETRYALGORITHM_H
80 
81 
The feature class encapsulates a single feature including its unique ID, geometry and a list of field...
Definition: qgsfeature.h:56
Container of fields for a vector layer.
Definition: qgsfields.h:45
virtual QString group() const
Returns the name of the group this algorithm belongs to.
virtual QString groupId() const
Returns the unique ID of the group this algorithm belongs to.
virtual QString shortHelpString() const
Returns a localised short helper string for the algorithm.
virtual QString shortDescription() const
Returns an optional translated short description of the algorithm.
virtual QString displayName() const =0
Returns the translated algorithm name, which should be used for any user-visible display of the algor...
virtual QgsProcessingAlgorithm * createInstance() const =0
Creates a new instance of the algorithm class.
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 name() const =0
Returns the algorithm name, used for identifying the algorithm.
Contains information about the context in which a processing algorithm is executed.
An abstract QgsProcessingAlgorithm base class for processing algorithms which operate "feature-by-fea...
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 QgsFields outputFields(const QgsFields &inputFields) const
Maps the input source fields (inputFields) to corresponding output fields generated by 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...
virtual QList< int > inputLayerTypes() const
Returns the valid input layer types for the source layer for this algorithm.
Flag
Flags controlling how QgsProcessingFeatureSource fetches features.
Base class for providing feedback from a processing algorithm.
SourceType
Data source types enum.
Definition: qgsprocessing.h:46
A store for object properties.
Definition: qgsproperty.h:232
Type
The WKB type describes the number of dimensions a geometry has.
Definition: qgswkbtypes.h:70
#define SIP_FACTORY
Definition: qgis_sip.h:76
QList< QgsFeature > QgsFeatureList
Definition: qgsfeature.h:834