QGIS API Documentation 3.99.0-Master (c22de0620c0)
Loading...
Searching...
No Matches
qgsmetadataalgorithms.h
Go to the documentation of this file.
1/***************************************************************************
2 qgsmetadataalgorithms.h
3 ---------------------
4 begin : November 2024
5 copyright : (C) 2024 by Alexander Bruy
6 email : alexander dot bruy 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 QGSMETADATAALGORITHMS_H
19#define QGSMETADATAALGORITHMS_H
20
21
22#include "qgis_sip.h"
23#include "qgsprocessingalgorithm.h"
24
25#define SIP_NO_FILE
26
28
32class QgsCopyLayerMetadataAlgorithm : public QgsProcessingAlgorithm
33{
34 public:
35 QgsCopyLayerMetadataAlgorithm() = default;
36 QString name() const override;
37 QString displayName() const override;
38 QStringList tags() const override;
39 QString group() const override;
40 QString groupId() const override;
41 QString shortHelpString() const override;
42 QString shortDescription() const override;
43 void initAlgorithm( const QVariantMap &configuration = QVariantMap() ) override;
44 QgsCopyLayerMetadataAlgorithm *createInstance() const override SIP_FACTORY;
45
46 protected:
47 bool prepareAlgorithm( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback ) override;
48 QVariantMap processAlgorithm( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback * ) override;
49
50 private:
51 QString mLayerId;
52};
53
57class QgsApplyLayerMetadataAlgorithm : public QgsProcessingAlgorithm
58{
59 public:
60 QgsApplyLayerMetadataAlgorithm() = default;
61 QString name() const override;
62 QString displayName() const override;
63 QStringList tags() const override;
64 QString group() const override;
65 QString groupId() const override;
66 QString shortHelpString() const override;
67 QString shortDescription() const override;
68 void initAlgorithm( const QVariantMap &configuration = QVariantMap() ) override;
69 QgsApplyLayerMetadataAlgorithm *createInstance() const override SIP_FACTORY;
70
71 protected:
72 bool prepareAlgorithm( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback ) override;
73 QVariantMap processAlgorithm( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback * ) override;
74
75 private:
76 QString mLayerId;
77};
78
82class QgsExportLayerMetadataAlgorithm : public QgsProcessingAlgorithm
83{
84 public:
85 QgsExportLayerMetadataAlgorithm() = default;
86 QString name() const override;
87 QString displayName() const override;
88 QStringList tags() const override;
89 QString group() const override;
90 QString groupId() const override;
91 QString shortHelpString() const override;
92 QString shortDescription() const override;
93 void initAlgorithm( const QVariantMap &configuration = QVariantMap() ) override;
94 QgsExportLayerMetadataAlgorithm *createInstance() const override SIP_FACTORY;
95
96 protected:
97 QVariantMap processAlgorithm( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback * ) override;
98
99 private:
100 QString mLayerId;
101};
102
106class QgsAddHistoryMetadataAlgorithm : public QgsProcessingAlgorithm
107{
108 public:
109 QgsAddHistoryMetadataAlgorithm() = default;
110 QString name() const override;
111 QString displayName() const override;
112 QStringList tags() const override;
113 QString group() const override;
114 QString groupId() const override;
115 QString shortHelpString() const override;
116 QString shortDescription() const override;
117 void initAlgorithm( const QVariantMap &configuration = QVariantMap() ) override;
118 QgsAddHistoryMetadataAlgorithm *createInstance() const override SIP_FACTORY;
119
120 protected:
121 bool prepareAlgorithm( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback ) override;
122 QVariantMap processAlgorithm( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback * ) override;
123
124 private:
125 QString mLayerId;
126};
127
131class QgsUpdateLayerMetadataAlgorithm : public QgsProcessingAlgorithm
132{
133 public:
134 QgsUpdateLayerMetadataAlgorithm() = default;
135 QString name() const override;
136 QString displayName() const override;
137 QStringList tags() const override;
138 QString group() const override;
139 QString groupId() const override;
140 QString shortHelpString() const override;
141 QString shortDescription() const override;
142 void initAlgorithm( const QVariantMap &configuration = QVariantMap() ) override;
143 QgsUpdateLayerMetadataAlgorithm *createInstance() const override SIP_FACTORY;
144
145 protected:
146 bool prepareAlgorithm( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback ) override;
147 QVariantMap processAlgorithm( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback * ) override;
148
149 private:
150 QString mLayerId;
151};
152
153
157class QgsSetMetadataFieldsAlgorithm : public QgsProcessingAlgorithm
158{
159 public:
160 QgsSetMetadataFieldsAlgorithm() = default;
161 QString name() const override;
162 QString displayName() const override;
163 QStringList tags() const override;
164 QString group() const override;
165 QString groupId() const override;
166 QString shortHelpString() const override;
167 QString shortDescription() const override;
168 void initAlgorithm( const QVariantMap &configuration = QVariantMap() ) override;
169 QgsSetMetadataFieldsAlgorithm *createInstance() const override SIP_FACTORY;
170
171 protected:
172 bool prepareAlgorithm( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback ) override;
173 QVariantMap processAlgorithm( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback * ) override;
174
175 private:
176 QString mLayerId;
177};
178
180
181#endif // QGSMETADATAALGORITHMS_H
QgsProcessingAlgorithm
Abstract base class for processing algorithms.
Definition qgsprocessingalgorithm.h:52
QgsProcessingAlgorithm::createInstance
virtual QgsProcessingAlgorithm * createInstance() const =0
Creates a new instance of the algorithm class.
QgsProcessingAlgorithm::group
virtual QString group() const
Returns the name of the group this algorithm belongs to.
Definition qgsprocessingalgorithm.h:212
QgsProcessingAlgorithm::groupId
virtual QString groupId() const
Returns the unique ID of the group this algorithm belongs to.
Definition qgsprocessingalgorithm.h:221
QgsProcessingAlgorithm::shortHelpString
virtual QString shortHelpString() const
Returns a localised short helper string for the algorithm.
Definition qgsprocessingalgorithm.cpp:73
QgsProcessingAlgorithm::shortDescription
virtual QString shortDescription() const
Returns an optional translated short description of the algorithm.
Definition qgsprocessingalgorithm.cpp:68
QgsProcessingAlgorithm::displayName
virtual QString displayName() const =0
Returns the translated algorithm name, which should be used for any user-visible display of the algor...
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:159
QgsProcessingAlgorithm::initAlgorithm
virtual void initAlgorithm(const QVariantMap &configuration=QVariantMap())=0
Initializes the algorithm using the specified configuration.
QgsProcessingAlgorithm::name
virtual QString name() const =0
Returns the algorithm name, used for identifying the algorithm.
QgsProcessingContext
Contains information about the context in which a processing algorithm is executed.
Definition qgsprocessingcontext.h:45
QgsProcessingFeedback
Base class for providing feedback from a processing algorithm.
Definition qgsprocessingfeedback.h:38
qgis_sip.h
SIP_FACTORY
#define SIP_FACTORY
Definition qgis_sip.h:83
Generated on for QGIS API Documentation by doxygen 1.15.0