QGIS API Documentation 3.28.0-Firenze (ed3ad0430f)
qgsalgorithmroundness.h
Go to the documentation of this file.
1/***************************************************************************
2 qgsalgorithmroundness.h
3 ---------------------
4 begin : September 2021
5 copyright : (C) 2021 by Antoine Facchini
6 email : antoine dot facchini @oslandia 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 QGSALGORITHMROUNDNESS_H
19#define QGSALGORITHMROUNDNESS_H
20
21#define SIP_NO_FILE
22
23#include "qgis_sip.h"
25
27
31class QgsRoundnessAlgorithm : public QgsProcessingFeatureBasedAlgorithm
32{
33
34 public:
35
36 QgsRoundnessAlgorithm() = 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 QgsRoundnessAlgorithm *createInstance() const override SIP_FACTORY;
45 QList<int> inputLayerTypes() const override;
46
47 protected:
48 QString outputName() const override;
49 QgsProcessing::SourceType outputLayerType() const override;
50 QgsFields outputFields( const QgsFields &inputFields ) const override;
51
52 QgsFeatureList processFeature( const QgsFeature &feature, QgsProcessingContext &context, QgsProcessingFeedback *feedback ) override;
53};
54
55
57
58#endif // QGSALGORITHMROUNDNESS_H
59
60
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 QgsProcessingAlgorithm * createInstance() const =0
Creates a new instance of the algorithm class.
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 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...
Base class for providing feedback from a processing algorithm.
SourceType
Data source types enum.
Definition: qgsprocessing.h:46
#define SIP_FACTORY
Definition: qgis_sip.h:76
QList< QgsFeature > QgsFeatureList
Definition: qgsfeature.h:922