1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
|
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/elevation/qgsprofileexporter.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
class QgsProfileExporter
{
%Docstring(signature="appended")
Handles exports of elevation profiles in various formats.
.. versionadded:: 3.32
%End
%TypeHeaderCode
#include "qgsprofileexporter.h"
%End
public:
QgsProfileExporter( const QList< QgsAbstractProfileSource * > &sources,
const QgsProfileRequest &request,
Qgis::ProfileExportType type );
%Docstring
Constructor for QgsProfileExporter, using the provided list of profile
``sources`` to generate the results.
After construction, call :py:func:`~QgsProfileExporter.run` to initiate
the profile generation.
%End
~QgsProfileExporter();
void run( QgsFeedback *feedback = 0 );
%Docstring
Runs the profile generation. This method must be called before
retrieving any results from the exporter.
This method is safe to run in a background thread.
%End
QList< QgsVectorLayer * > toLayers() /Factory/;
%Docstring
Returns a list of vector layer containing the exported profile results.
While this method attempts to condense all results into a single layer,
multiple layers may be returned when the geometry types of exported
features differs.
Ownership of the returned layers is transferred to the caller.
%End
private:
QgsProfileExporter( const QgsProfileExporter &other );
};
class QgsProfileExporterTask : QgsTask
{
%Docstring(signature="appended")
Handles exports of elevation profiles in various formats in a background
task.
.. versionadded:: 3.32
%End
%TypeHeaderCode
#include "qgsprofileexporter.h"
%End
public:
enum class ExportResult
{
Success,
Empty,
DeviceError,
DxfExportFailed,
LayerExportFailed,
Canceled,
};
QgsProfileExporterTask( const QList< QgsAbstractProfileSource * > &sources,
const QgsProfileRequest &request,
Qgis::ProfileExportType type,
const QString &destination,
const QgsCoordinateTransformContext &transformContext );
%Docstring
Constructor for QgsProfileExporterTask, saving results to the specified
``destination`` file.
If ``destination`` is an empty string then the profile results will be
generated only and can be retrieved by calling
:py:func:`~QgsProfileExporterTask.takeLayers`.
%End
virtual bool run();
virtual void cancel();
QList< QgsVectorLayer * > takeLayers() /Factory/;
%Docstring
Returns a list of vector layer containing the exported profile results.
While this method attempts to condense all results into a single layer,
multiple layers may be returned when the geometry types of exported
features differs.
Ownership of the returned layers is transferred to the caller.
%End
QgsProfileExporterTask::ExportResult result() const;
%Docstring
Returns the result of the export operation.
.. seealso:: :py:func:`error`
%End
QStringList createdFiles() const;
%Docstring
Returns a list of layer files created during the export.
%End
QString error() const;
%Docstring
Returns a descriptive error message, if available.
%End
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/elevation/qgsprofileexporter.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
|
