summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorIvan Solovev <ivan.solovev@qt.io>2021-07-28 12:08:19 +0200
committerQt Cherry-pick Bot <cherrypick_bot@qt-project.org>2021-07-28 14:40:51 +0000
commitdecc47815ac89e3952156abbf1276f803667634e (patch)
treea054930b77ee885bcd48ace8f1970cb36fc0e94b
parent7515e249c5da337e87cb9542a086f1b03af7adc8 (diff)
QGeoPositionInfo: extend docs for attributes
Add the description of Position Accuracy - a 3D accuracy value. Qt does not provide it directly, but it can be calculated based on horizontal and vertical accuracy values. Task-number: QTBUG-64694 Change-Id: Ic043b2d3a8198fc3ec77f0c5af1ff83934a47044 Reviewed-by: Alex Blasche <alexander.blasche@qt.io> (cherry picked from commit 1efdfa7e810e7eb86b2cde3151a6291666dc3e35) Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
-rw-r--r--src/positioning/qgeopositioninfo.cpp8
1 files changed, 8 insertions, 0 deletions
diff --git a/src/positioning/qgeopositioninfo.cpp b/src/positioning/qgeopositioninfo.cpp
index abb672f5..2d50c57a 100644
--- a/src/positioning/qgeopositioninfo.cpp
+++ b/src/positioning/qgeopositioninfo.cpp
@@ -73,6 +73,14 @@ QT_BEGIN_NAMESPACE
\value MagneticVariation The angle between the horizontal component of the magnetic field and true north, in degrees. Also known as magnetic declination. A positive value indicates a clockwise direction from true north and a negative value indicates a counter-clockwise direction.
\value HorizontalAccuracy The accuracy of the provided latitude-longitude value, in meters.
\value VerticalAccuracy The accuracy of the provided altitude value, in meters.
+
+ NMEA protocol also suggests another type of accuracy - PositionAccuracy,
+ which is a 3D accuracy value. Qt does not provide a separate attribute for
+ it. If you need this value, you can calculate it based on the following
+ formula:
+
+ \c {PositionAccuracy} \sup 2 \c {= HorizontalAccuracy} \sup 2 \c { +
+ VerticalAccuracy} \sup 2
*/
/*!