QGIS API Documentation  3.17.0-Master (a035f434f4)
qgsalgorithmextractlayoutmapextent.h
Go to the documentation of this file.
1 /***************************************************************************
2  qgsalgorithmextractlayoutmapextent.h
3  ---------------------
4  begin : March 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 QGSALGORITHMEXTRACTLAYOUTMAPEXTENT_H
19 #define QGSALGORITHMEXTRACTLAYOUTMAPEXTENT_H
20 
21 #define SIP_NO_FILE
22 
23 #include "qgis_sip.h"
24 #include "qgsprocessingalgorithm.h"
25 
27 
31 class QgsLayoutMapExtentToLayerAlgorithm : public QgsProcessingAlgorithm
32 {
33 
34  public:
35 
36  QgsLayoutMapExtentToLayerAlgorithm() = default;
37  void initAlgorithm( const QVariantMap &configuration = QVariantMap() ) override;
38  QString name() const override;
39  QString displayName() const override;
40  QStringList tags() const override;
41  QString group() const override;
42  QString groupId() const override;
43  QString shortDescription() const override;
44  QString shortHelpString() const override;
45  QgsLayoutMapExtentToLayerAlgorithm *createInstance() const override SIP_FACTORY;
46 
47  protected:
48  bool prepareAlgorithm( const QVariantMap &parameters,
49  QgsProcessingContext &context, QgsProcessingFeedback *feedback ) override;
50  QVariantMap processAlgorithm( const QVariantMap &parameters,
51  QgsProcessingContext &context, QgsProcessingFeedback *feedback ) override;
52 
53  private:
54  QgsFeatureList mFeatures;
55  double mWidth = 0;
56  double mHeight = 0;
57  double mScale = 0;
58  double mRotation = 0;
60 
61 };
62 
64 
65 #endif // QGSALGORITHMEXTRACTLAYOUTMAPEXTENT_H
66 
67 
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.
QList< QgsFeature > QgsFeatureList
Definition: qgsfeature.h:583
virtual QString name() const =0
Returns the algorithm name, used for identifying the algorithm.
virtual QString group() const
Returns the name of the group this algorithm belongs to.
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 shortHelpString() const
Returns a localised short helper string for the algorithm.
Abstract base class for processing algorithms.
virtual void initAlgorithm(const QVariantMap &configuration=QVariantMap())=0
Initializes the algorithm using the specified configuration.
#define SIP_FACTORY
Definition: qgis_sip.h:76
virtual QgsProcessingAlgorithm * createInstance() const =0
Creates a new instance of the algorithm class.
virtual QVariantMap processAlgorithm(const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback) SIP_THROW(QgsProcessingException)=0
Runs the algorithm using the specified parameters.
virtual QString displayName() const =0
Returns the translated algorithm name, which should be used for any user-visible display of the algor...
This class represents a coordinate reference system (CRS).
virtual QString shortDescription() const
Returns an optional translated short description of the algorithm.
virtual QString groupId() const
Returns the unique ID of the group this algorithm belongs to.
Contains information about the context in which a processing algorithm is executed.