QGIS API Documentation 3.28.0-Firenze (ed3ad0430f)
|
Encapsulates properties and constraints relating to fetching elevation profiles from different sources. More...
#include <qgsprofilerequest.h>
Public Member Functions | |
QgsProfileRequest (const QgsProfileRequest &other) | |
Copy constructor. More... | |
QgsProfileRequest (QgsCurve *curve) | |
Constructor for QgsProfileRequest. More... | |
~QgsProfileRequest () | |
QgsCoordinateReferenceSystem | crs () const |
Returns the desired Coordinate Reference System for the profile. More... | |
QgsExpressionContext & | expressionContext () |
Returns the expression context used to evaluate expressions. More... | |
const QgsExpressionContext & | expressionContext () const |
Returns the expression context used to evaluate expressions. More... | |
bool | operator!= (const QgsProfileRequest &other) const |
QgsProfileRequest & | operator= (const QgsProfileRequest &other) |
Assignment operator. More... | |
bool | operator== (const QgsProfileRequest &other) const |
QgsCurve * | profileCurve () const |
Returns the cross section profile curve, which represents the line along which the profile should be generated. More... | |
QgsProfileRequest & | setCrs (const QgsCoordinateReferenceSystem &crs) |
Sets the desired Coordinate Reference System (crs) for the profile. More... | |
QgsProfileRequest & | setExpressionContext (const QgsExpressionContext &context) |
Sets the expression context used to evaluate expressions. More... | |
QgsProfileRequest & | setProfileCurve (QgsCurve *curve) |
Sets the cross section profile curve, which represents the line along which the profile should be generated. More... | |
QgsProfileRequest & | setStepDistance (double distance) |
Sets the profile step distance (in crs() units). More... | |
QgsProfileRequest & | setTerrainProvider (QgsAbstractTerrainProvider *provider) |
Sets the terrain provider. More... | |
QgsProfileRequest & | setTolerance (double tolerance) |
Sets the tolerance of the request (in crs() units). More... | |
QgsProfileRequest & | setTransformContext (const QgsCoordinateTransformContext &context) |
Sets the transform context, for use when transforming coordinates from a source to the request's crs() More... | |
double | stepDistance () const |
Returns the profile step distance (in crs() units). More... | |
QgsAbstractTerrainProvider * | terrainProvider () const |
Returns the terrain provider. More... | |
double | tolerance () const |
Returns the tolerance of the request (in crs() units). More... | |
QgsCoordinateTransformContext | transformContext () const |
Returns the transform context, for use when transforming coordinates from a source to the request's crs() More... | |
Encapsulates properties and constraints relating to fetching elevation profiles from different sources.
Definition at line 37 of file qgsprofilerequest.h.
QgsProfileRequest::QgsProfileRequest | ( | QgsCurve * | curve | ) |
Constructor for QgsProfileRequest.
The curve argument specifies the line along which the profile should be generated. Ownership is transferred to the request.
Definition at line 21 of file qgsprofilerequest.cpp.
QgsProfileRequest::QgsProfileRequest | ( | const QgsProfileRequest & | other | ) |
Copy constructor.
Definition at line 29 of file qgsprofilerequest.cpp.
|
default |
QgsCoordinateReferenceSystem QgsProfileRequest::crs | ( | ) | const |
Returns the desired Coordinate Reference System for the profile.
This also represents the CRS associated with the profileCurve().
Definition at line 108 of file qgsprofilerequest.cpp.
|
inline |
Returns the expression context used to evaluate expressions.
Definition at line 193 of file qgsprofilerequest.h.
|
inline |
Returns the expression context used to evaluate expressions.
Definition at line 199 of file qgsprofilerequest.h.
bool QgsProfileRequest::operator!= | ( | const QgsProfileRequest & | other | ) | const |
Definition at line 86 of file qgsprofilerequest.cpp.
QgsProfileRequest & QgsProfileRequest::operator= | ( | const QgsProfileRequest & | other | ) |
Assignment operator.
Definition at line 41 of file qgsprofilerequest.cpp.
bool QgsProfileRequest::operator== | ( | const QgsProfileRequest & | other | ) | const |
Definition at line 53 of file qgsprofilerequest.cpp.
QgsCurve * QgsProfileRequest::profileCurve | ( | ) | const |
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 crs().
Definition at line 97 of file qgsprofilerequest.cpp.
QgsProfileRequest & QgsProfileRequest::setCrs | ( | const QgsCoordinateReferenceSystem & | crs | ) |
Sets the desired Coordinate Reference System (crs) for the profile.
This also represents the CRS associated with the profileCurve().
Definition at line 102 of file qgsprofilerequest.cpp.
QgsProfileRequest & QgsProfileRequest::setExpressionContext | ( | const QgsExpressionContext & | context | ) |
Sets the expression context used to evaluate expressions.
Definition at line 147 of file qgsprofilerequest.cpp.
QgsProfileRequest & QgsProfileRequest::setProfileCurve | ( | QgsCurve * | curve | ) |
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 setCrs().
Definition at line 91 of file qgsprofilerequest.cpp.
QgsProfileRequest & QgsProfileRequest::setStepDistance | ( | double | distance | ) |
Sets the profile step distance (in crs() units).
This value determines the approximate distance between sampled points along the 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.
Definition at line 141 of file qgsprofilerequest.cpp.
QgsProfileRequest & QgsProfileRequest::setTerrainProvider | ( | QgsAbstractTerrainProvider * | provider | ) |
Sets the terrain provider.
Ownership of provider is transferred to the request.
Definition at line 130 of file qgsprofilerequest.cpp.
QgsProfileRequest & QgsProfileRequest::setTolerance | ( | double | tolerance | ) |
Sets the tolerance of the request (in crs() units).
This value determines how far from the 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.
Definition at line 124 of file qgsprofilerequest.cpp.
QgsProfileRequest & QgsProfileRequest::setTransformContext | ( | const QgsCoordinateTransformContext & | context | ) |
Sets the transform context, for use when transforming coordinates from a source to the request's crs()
Definition at line 118 of file qgsprofilerequest.cpp.
|
inline |
Returns the profile step distance (in crs() units).
This value determines the approximate distance between sampled points along the 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.
Definition at line 187 of file qgsprofilerequest.h.
QgsAbstractTerrainProvider * QgsProfileRequest::terrainProvider | ( | ) | const |
Returns the terrain provider.
Definition at line 136 of file qgsprofilerequest.cpp.
|
inline |
Returns the tolerance of the request (in crs() units).
This value determines how far from the 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.
Definition at line 141 of file qgsprofilerequest.h.
QgsCoordinateTransformContext QgsProfileRequest::transformContext | ( | ) | const |
Returns the transform context, for use when transforming coordinates from a source to the request's crs()
Definition at line 113 of file qgsprofilerequest.cpp.