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
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
|
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/elevation/qgsprofilerequest.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
class QgsProfileRequest
{
%Docstring(signature="appended")
Encapsulates properties and constraints relating to fetching elevation
profiles from different sources.
.. versionadded:: 3.26
%End
%TypeHeaderCode
#include "qgsprofilerequest.h"
%End
public:
QgsProfileRequest( QgsCurve *curve /Transfer/ );
%Docstring
Constructor for QgsProfileRequest.
The ``curve`` argument specifies the line along which the profile should
be generated. Ownership is transferred to the request.
%End
QgsProfileRequest( const QgsProfileRequest &other );
~QgsProfileRequest();
bool operator==( const QgsProfileRequest &other ) const;
bool operator!=( const QgsProfileRequest &other ) const;
QgsProfileRequest &setProfileCurve( QgsCurve *curve /Transfer/ );
%Docstring
Sets the cross section profile ``curve``, which represents the line
along which the profile should be generated.
Ownership of ``curve`` is transferred to the request.
The coordinate reference system of the ``curve`` is set via
:py:func:`~QgsProfileRequest.setCrs`.
.. seealso:: :py:func:`profileCurve`
%End
QgsCurve *profileCurve() const;
%Docstring
Returns the cross section profile curve, which represents the line along
which the profile should be generated.
The coordinate reference system of the curve is retrieved via
:py:func:`~QgsProfileRequest.crs`.
.. seealso:: :py:func:`setProfileCurve`
%End
QgsProfileRequest &setCrs( const QgsCoordinateReferenceSystem &crs );
%Docstring
Sets the desired Coordinate Reference System (``crs``) for the profile.
This also represents the CRS associated with the
:py:func:`~QgsProfileRequest.profileCurve`.
.. seealso:: :py:func:`crs`
%End
QgsCoordinateReferenceSystem crs() const;
%Docstring
Returns the desired Coordinate Reference System for the profile.
This also represents the CRS associated with the
:py:func:`~QgsProfileRequest.profileCurve`.
.. seealso:: :py:func:`setCrs`
%End
QgsCoordinateTransformContext transformContext() const;
%Docstring
Returns the transform context, for use when transforming coordinates
from a source to the request's :py:func:`~QgsProfileRequest.crs`
.. seealso:: :py:func:`setTransformContext`
%End
QgsProfileRequest &setTransformContext( const QgsCoordinateTransformContext &context );
%Docstring
Sets the transform ``context``, for use when transforming coordinates
from a source to the request's :py:func:`~QgsProfileRequest.crs`
.. seealso:: :py:func:`transformContext`
%End
QgsProfileRequest &setTolerance( double tolerance );
%Docstring
Sets the tolerance of the request (in :py:func:`~QgsProfileRequest.crs`
units).
This value determines how far from the
:py:func:`~QgsProfileRequest.profileCurve` is appropriate for inclusion
of results. For instance, when a profile is generated for a point vector
layer this tolerance distance will dictate how far from the actual
profile curve a point can reside within to be included in the results.
Other sources may completely ignore this tolerance if it is not
appropriate for the particular source.
.. seealso:: :py:func:`tolerance`
%End
double tolerance() const;
%Docstring
Returns the tolerance of the request (in
:py:func:`~QgsProfileRequest.crs` units).
This value determines how far from the
:py:func:`~QgsProfileRequest.profileCurve` is appropriate for inclusion
of results. For instance, when a profile is generated for a point vector
layer this tolerance distance will dictate how far from the actual
profile curve a point can reside within to be included in the results.
Other sources may completely ignore this tolerance if it is not
appropriate for the particular source.
.. seealso:: :py:func:`setTolerance`
%End
QgsProfileRequest &setTerrainProvider( QgsAbstractTerrainProvider *provider /Transfer/ );
%Docstring
Sets the terrain ``provider``.
Ownership of ``provider`` is transferred to the request.
.. seealso:: :py:func:`terrainProvider`
%End
QgsAbstractTerrainProvider *terrainProvider() const;
%Docstring
Returns the terrain provider.
.. seealso:: :py:func:`setTerrainProvider`
%End
QgsProfileRequest &setStepDistance( double distance );
%Docstring
Sets the profile step ``distance`` (in :py:func:`~QgsProfileRequest.crs`
units).
This value determines the approximate distance between sampled points
along the :py:func:`~QgsProfileRequest.profileCurve`. Depending on the
sources sampled, smaller step distances may be used in some
circumstances. Effectively, this value is the "smallest permissible
maximum distance between sampled points".
Smaller distances will take longer to calculate.
A NaN ``distance`` value will cause an appropriate step distance to be
automatically calculated.
.. seealso:: :py:func:`stepDistance`
%End
double stepDistance() const;
%Docstring
Returns the profile step distance (in :py:func:`~QgsProfileRequest.crs`
units).
This value determines the approximate distance between sampled points
along the :py:func:`~QgsProfileRequest.profileCurve`. Depending on the
sources sampled, smaller step distances may be used in some
circumstances. Effectively, this value is the "smallest permissible
maximum distance between sampled points".
Smaller distances will take longer to calculate.
A NaN distance value indicates that an appropriate step distance will be
automatically calculated.
.. seealso:: :py:func:`setStepDistance`
%End
QgsExpressionContext &expressionContext();
%Docstring
Returns the expression context used to evaluate expressions.
.. seealso:: :py:func:`setExpressionContext`
%End
QgsProfileRequest &setExpressionContext( const QgsExpressionContext &context );
%Docstring
Sets the expression context used to evaluate expressions.
.. seealso:: :py:func:`expressionContext`
%End
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/elevation/qgsprofilerequest.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
|
