QGIS API Documentation 3.43.0-Master (261ee7da134)
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#define SIP_NO_FILE
22
23#include "qgis_sip.h"
24#include "qgsprocessingalgorithm.h"
25
27
31class QgsCopyLayerMetadataAlgorithm : public QgsProcessingAlgorithm
32{
33 public:
34 QgsCopyLayerMetadataAlgorithm() = default;
35 QString name() const override;
36 QString displayName() const override;
37 QStringList tags() const override;
38 QString group() const override;
39 QString groupId() const override;
40 QString shortHelpString() const override;
41 QString shortDescription() const override;
42 void initAlgorithm( const QVariantMap &configuration = QVariantMap() ) override;
43 QgsCopyLayerMetadataAlgorithm *createInstance() const override SIP_FACTORY;
44
45 protected:
46 bool prepareAlgorithm( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback ) override;
47 QVariantMap processAlgorithm( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback * ) override;
48
49 private:
50 QString mLayerId;
51};
52
56class QgsApplyLayerMetadataAlgorithm : public QgsProcessingAlgorithm
57{
58 public:
59 QgsApplyLayerMetadataAlgorithm() = default;
60 QString name() const override;
61 QString displayName() const override;
62 QStringList tags() const override;
63 QString group() const override;
64 QString groupId() const override;
65 QString shortHelpString() const override;
66 QString shortDescription() const override;
67 void initAlgorithm( const QVariantMap &configuration = QVariantMap() ) override;
68 QgsApplyLayerMetadataAlgorithm *createInstance() const override SIP_FACTORY;
69
70 protected:
71 bool prepareAlgorithm( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback ) override;
72 QVariantMap processAlgorithm( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback * ) override;
73
74 private:
75 QString mLayerId;
76};
77
81class QgsExportLayerMetadataAlgorithm : public QgsProcessingAlgorithm
82{
83 public:
84 QgsExportLayerMetadataAlgorithm() = default;
85 QString name() const override;
86 QString displayName() const override;
87 QStringList tags() const override;
88 QString group() const override;
89 QString groupId() const override;
90 QString shortHelpString() const override;
91 QString shortDescription() const override;
92 void initAlgorithm( const QVariantMap &configuration = QVariantMap() ) override;
93 QgsExportLayerMetadataAlgorithm *createInstance() const override SIP_FACTORY;
94
95 protected:
96 QVariantMap processAlgorithm( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback * ) override;
97
98 private:
99 QString mLayerId;
100};
101
105class QgsAddHistoryMetadataAlgorithm : public QgsProcessingAlgorithm
106{
107 public:
108 QgsAddHistoryMetadataAlgorithm() = default;
109 QString name() const override;
110 QString displayName() const override;
111 QStringList tags() const override;
112 QString group() const override;
113 QString groupId() const override;
114 QString shortHelpString() const override;
115 QString shortDescription() const override;
116 void initAlgorithm( const QVariantMap &configuration = QVariantMap() ) override;
117 QgsAddHistoryMetadataAlgorithm *createInstance() const override SIP_FACTORY;
118
119 protected:
120 bool prepareAlgorithm( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback ) override;
121 QVariantMap processAlgorithm( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback * ) override;
122
123 private:
124 QString mLayerId;
125};
126
130class QgsUpdateLayerMetadataAlgorithm : public QgsProcessingAlgorithm
131{
132 public:
133 QgsUpdateLayerMetadataAlgorithm() = default;
134 QString name() const override;
135 QString displayName() const override;
136 QStringList tags() const override;
137 QString group() const override;
138 QString groupId() const override;
139 QString shortHelpString() const override;
140 QString shortDescription() const override;
141 void initAlgorithm( const QVariantMap &configuration = QVariantMap() ) override;
142 QgsUpdateLayerMetadataAlgorithm *createInstance() const override SIP_FACTORY;
143
144 protected:
145 bool prepareAlgorithm( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback ) override;
146 QVariantMap processAlgorithm( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback * ) override;
147
148 private:
149 QString mLayerId;
150};
151
152
156class QgsSetMetadataFieldsAlgorithm : public QgsProcessingAlgorithm
157{
158 public:
159 QgsSetMetadataFieldsAlgorithm() = default;
160 QString name() const override;
161 QString displayName() const override;
162 QStringList tags() const override;
163 QString group() const override;
164 QString groupId() const override;
165 QString shortHelpString() const override;
166 QString shortDescription() const override;
167 void initAlgorithm( const QVariantMap &configuration = QVariantMap() ) override;
168 QgsSetMetadataFieldsAlgorithm *createInstance() const override SIP_FACTORY;
169
170 protected:
171 bool prepareAlgorithm( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback ) override;
172 QVariantMap processAlgorithm( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback * ) override;
173
174 private:
175 QString mLayerId;
176};
177
179
180#endif // QGSMETADATAALGORITHMS_H
QgsProcessingAlgorithm
Abstract base class for processing algorithms.
Definition qgsprocessingalgorithm.h:51
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:211
QgsProcessingAlgorithm::groupId
virtual QString groupId() const
Returns the unique ID of the group this algorithm belongs to.
Definition qgsprocessingalgorithm.h:220
QgsProcessingAlgorithm::shortHelpString
virtual QString shortHelpString() const
Returns a localised short helper string for the algorithm.
Definition qgsprocessingalgorithm.cpp:65
QgsProcessingAlgorithm::shortDescription
virtual QString shortDescription() const
Returns an optional translated short description of the algorithm.
Definition qgsprocessingalgorithm.cpp:60
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:158
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:76
Generated on Mon Jun 2 2025 00:14:09 for QGIS API Documentation by doxygen 1.9.8