/usr/share/qt5/doc/qtpositioning/qgeopositioninfo.html is in qtpositioning5-doc-html 5.3.2-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 213 214 215 216 217 218 219 | <?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en_US" lang="en_US">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qgeopositioninfo.cpp -->
<title>QGeoPositionInfo Class | QtPositioning 5.3</title>
<link rel="stylesheet" type="text/css" href="style/offline.css" />
</head>
<body>
<div class="header" id="qtdocheader">
<div class="main">
<div class="main-rounded">
<div class="navigationbar">
<ul>
<li>Qt 5.3</li>
<li><a href="qtpositioning-index.html">Qt Positioning</a></li>
<li><a href="qtpositioning-module.html">C++ Classes</a></li>
<li>QGeoPositionInfo</li>
<li id="buildversion">
Qt 5.3.2 Reference Documentation</li>
</ul>
</div>
</div>
<div class="content">
<div class="line">
<div class="content mainContent">
<div class="toc">
<h3><a name="toc">Contents</a></h3>
<ul>
<li class="level1"><a href="#public-types">Public Types</a></li>
<li class="level1"><a href="#public-functions">Public Functions</a></li>
<li class="level1"><a href="#related-non-members">Related Non-Members</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
</ul>
</div>
<h1 class="title">QGeoPositionInfo Class</h1>
<!-- $$$QGeoPositionInfo-brief -->
<p>The QGeoPositionInfo class contains information gathered on a global position, direction and velocity at a particular point in time. <a href="#details">More...</a></p>
<!-- @@@QGeoPositionInfo -->
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> </b><tt><span class="preprocessor">#include <QGeoPositionInfo></span>
</tt></td></tr><tr><td class="memItemLeft rightAlign topAlign"> qmake:</td><td class="memItemRight bottomAlign"> <tt>QT += positioning</tt></td></tr><tr><td class="memItemLeft rightAlign topAlign"> Since:</td><td class="memItemRight bottomAlign"> Qt 5.2</td></tr></table><ul>
<li><a href="qgeopositioninfo-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="public-types"></a>
<h2>Public Types</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> enum </td><td class="memItemRight bottomAlign"><b><a href="qgeopositioninfo.html#Attribute-enum">Attribute</a></b> { Direction, GroundSpeed, VerticalSpeed, MagneticVariation, HorizontalAccuracy, VerticalAccuracy }</td></tr>
</table>
<a name="public-functions"></a>
<h2>Public Functions</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qgeopositioninfo.html#QGeoPositionInfo">QGeoPositionInfo</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qgeopositioninfo.html#QGeoPositionInfo-2">QGeoPositionInfo</a></b>(const QGeoCoordinate &<i> coordinate</i>, const QDateTime &<i> timestamp</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qgeopositioninfo.html#QGeoPositionInfo-3">QGeoPositionInfo</a></b>(const QGeoPositionInfo &<i> other</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qgeopositioninfo.html#dtor.QGeoPositionInfo">~QGeoPositionInfo</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> qreal </td><td class="memItemRight bottomAlign"><b><a href="qgeopositioninfo.html#attribute">attribute</a></b>(Attribute<i> attribute</i>) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QGeoCoordinate </td><td class="memItemRight bottomAlign"><b><a href="qgeopositioninfo.html#coordinate">coordinate</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qgeopositioninfo.html#hasAttribute">hasAttribute</a></b>(Attribute<i> attribute</i>) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qgeopositioninfo.html#isValid">isValid</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qgeopositioninfo.html#removeAttribute">removeAttribute</a></b>(Attribute<i> attribute</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qgeopositioninfo.html#setAttribute">setAttribute</a></b>(Attribute<i> attribute</i>, qreal<i> value</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qgeopositioninfo.html#setCoordinate">setCoordinate</a></b>(const QGeoCoordinate &<i> coordinate</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qgeopositioninfo.html#setTimestamp">setTimestamp</a></b>(const QDateTime &<i> timestamp</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QDateTime </td><td class="memItemRight bottomAlign"><b><a href="qgeopositioninfo.html#timestamp">timestamp</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qgeopositioninfo.html#operator-not-eq">operator!=</a></b>(const QGeoPositionInfo &<i> other</i>) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QGeoPositionInfo & </td><td class="memItemRight bottomAlign"><b><a href="qgeopositioninfo.html#operator-eq">operator=</a></b>(const QGeoPositionInfo &<i> other</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qgeopositioninfo.html#operator-eq-eq">operator==</a></b>(const QGeoPositionInfo &<i> other</i>) const</td></tr>
</table>
<a name="related-non-members"></a>
<h2>Related Non-Members</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> QDataStream & </td><td class="memItemRight bottomAlign"><b><a href="qgeopositioninfo.html#operator-lt-lt-10">operator<<</a></b>(QDataStream &<i> stream</i>, QGeoPositionInfo::Attribute<i> attr</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QDataStream & </td><td class="memItemRight bottomAlign"><b><a href="qgeopositioninfo.html#operator-lt-lt-11">operator<<</a></b>(QDataStream &<i> stream</i>, const QGeoPositionInfo &<i> info</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QDataStream & </td><td class="memItemRight bottomAlign"><b><a href="qgeopositioninfo.html#operator-gt-gt-5">operator>></a></b>(QDataStream &<i> stream</i>, QGeoPositionInfo::Attribute &<i> attr</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QDataStream & </td><td class="memItemRight bottomAlign"><b><a href="qgeopositioninfo.html#operator-gt-gt-6">operator>></a></b>(QDataStream &<i> stream</i>, QGeoPositionInfo &<i> info</i>)</td></tr>
</table>
<a name="details"></a>
<!-- $$$QGeoPositionInfo-description -->
<div class="descr">
<h2>Detailed Description</h2>
<p>The QGeoPositionInfo class contains information gathered on a global position, direction and velocity at a particular point in time.</p>
<p>A QGeoPositionInfo contains, at a minimum, a geographical coordinate and a timestamp. It may also have heading and speed measurements as well as estimates of the accuracy of the provided data.</p>
</div>
<p><b>See also </b><a href="qgeopositioninfosource.html">QGeoPositionInfoSource</a>.</p>
<!-- @@@QGeoPositionInfo -->
<div class="types">
<h2>Member Type Documentation</h2>
<!-- $$$Attribute$$$Direction$$$GroundSpeed$$$VerticalSpeed$$$MagneticVariation$$$HorizontalAccuracy$$$VerticalAccuracy -->
<h3 class="fn"><a name="Attribute-enum"></a>enum QGeoPositionInfo::<span class="name">Attribute</span></h3>
<p>Defines the attributes for positional information.</p>
<table class="valuelist"><tr valign="top" class="odd"><th class="tblConst">Constant</th><th class="tblval">Value</th><th class="tbldscr">Description</th></tr>
<tr><td class="topAlign"><tt>QGeoPositionInfo::Direction</tt></td><td class="topAlign"><tt>0</tt></td><td class="topAlign">The bearing measured in degrees clockwise from true north to the direction of travel.</td></tr>
<tr><td class="topAlign"><tt>QGeoPositionInfo::GroundSpeed</tt></td><td class="topAlign"><tt>1</tt></td><td class="topAlign">The ground speed, in meters/sec.</td></tr>
<tr><td class="topAlign"><tt>QGeoPositionInfo::VerticalSpeed</tt></td><td class="topAlign"><tt>2</tt></td><td class="topAlign">The vertical speed, in meters/sec.</td></tr>
<tr><td class="topAlign"><tt>QGeoPositionInfo::MagneticVariation</tt></td><td class="topAlign"><tt>3</tt></td><td class="topAlign">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.</td></tr>
<tr><td class="topAlign"><tt>QGeoPositionInfo::HorizontalAccuracy</tt></td><td class="topAlign"><tt>4</tt></td><td class="topAlign">The accuracy of the provided latitude-longitude value, in meters.</td></tr>
<tr><td class="topAlign"><tt>QGeoPositionInfo::VerticalAccuracy</tt></td><td class="topAlign"><tt>5</tt></td><td class="topAlign">The accuracy of the provided altitude value, in meters.</td></tr>
</table>
<!-- @@@Attribute -->
</div>
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QGeoPositionInfo[overload1]$$$QGeoPositionInfo -->
<h3 class="fn"><a name="QGeoPositionInfo"></a>QGeoPositionInfo::<span class="name">QGeoPositionInfo</span>()</h3>
<p>Creates an invalid <a href="qgeopositioninfo.html">QGeoPositionInfo</a> object.</p>
<p><b>See also </b><a href="qgeopositioninfo.html#isValid">isValid</a>().</p>
<!-- @@@QGeoPositionInfo -->
<!-- $$$QGeoPositionInfo$$$QGeoPositionInfoconstQGeoCoordinate&constQDateTime& -->
<h3 class="fn"><a name="QGeoPositionInfo-2"></a>QGeoPositionInfo::<span class="name">QGeoPositionInfo</span>(const <span class="type"><a href="qgeocoordinate.html">QGeoCoordinate</a></span> &<i> coordinate</i>, const <span class="type">QDateTime</span> &<i> timestamp</i>)</h3>
<p>Creates a <a href="qgeopositioninfo.html">QGeoPositionInfo</a> for the given <i>coordinate</i> and <i>timestamp</i>.</p>
<!-- @@@QGeoPositionInfo -->
<!-- $$$QGeoPositionInfo$$$QGeoPositionInfoconstQGeoPositionInfo& -->
<h3 class="fn"><a name="QGeoPositionInfo-3"></a>QGeoPositionInfo::<span class="name">QGeoPositionInfo</span>(const <span class="type">QGeoPositionInfo</span> &<i> other</i>)</h3>
<p>Creates a <a href="qgeopositioninfo.html">QGeoPositionInfo</a> with the values of <i>other</i>.</p>
<!-- @@@QGeoPositionInfo -->
<!-- $$$~QGeoPositionInfo[overload1]$$$~QGeoPositionInfo -->
<h3 class="fn"><a name="dtor.QGeoPositionInfo"></a>QGeoPositionInfo::<span class="name">~QGeoPositionInfo</span>()</h3>
<p>Destroys a <a href="qgeopositioninfo.html">QGeoPositionInfo</a> object.</p>
<!-- @@@~QGeoPositionInfo -->
<!-- $$$attribute[overload1]$$$attributeAttribute -->
<h3 class="fn"><a name="attribute"></a><span class="type">qreal</span> QGeoPositionInfo::<span class="name">attribute</span>(<span class="type"><a href="qgeopositioninfo.html#Attribute-enum">Attribute</a></span><i> attribute</i>) const</h3>
<p>Returns the value of the specified <i>attribute</i> as a qreal value.</p>
<p>Returns NaN if the value has not been set.</p>
<p>The function <a href="qgeopositioninfo.html#hasAttribute">hasAttribute</a>() should be used to determine whether or not a value has been set for an attribute.</p>
<p><b>See also </b><a href="qgeopositioninfo.html#hasAttribute">hasAttribute</a>() and <a href="qgeopositioninfo.html#setAttribute">setAttribute</a>().</p>
<!-- @@@attribute -->
<!-- $$$coordinate[overload1]$$$coordinate -->
<h3 class="fn"><a name="coordinate"></a><span class="type"><a href="qgeocoordinate.html">QGeoCoordinate</a></span> QGeoPositionInfo::<span class="name">coordinate</span>() const</h3>
<p>Returns the coordinate for this position.</p>
<p>Returns an invalid coordinate if no coordinate has been set.</p>
<p><b>See also </b><a href="qgeopositioninfo.html#setCoordinate">setCoordinate</a>().</p>
<!-- @@@coordinate -->
<!-- $$$hasAttribute[overload1]$$$hasAttributeAttribute -->
<h3 class="fn"><a name="hasAttribute"></a><span class="type">bool</span> QGeoPositionInfo::<span class="name">hasAttribute</span>(<span class="type"><a href="qgeopositioninfo.html#Attribute-enum">Attribute</a></span><i> attribute</i>) const</h3>
<p>Returns true if the specified <i>attribute</i> is present for this <a href="qgeopositioninfo.html">QGeoPositionInfo</a> object.</p>
<!-- @@@hasAttribute -->
<!-- $$$isValid[overload1]$$$isValid -->
<h3 class="fn"><a name="isValid"></a><span class="type">bool</span> QGeoPositionInfo::<span class="name">isValid</span>() const</h3>
<p>Returns true if the <a href="qgeopositioninfo.html#timestamp">timestamp</a>() and <a href="qgeopositioninfo.html#coordinate">coordinate</a>() values are both valid.</p>
<p><b>See also </b><a href="qgeocoordinate.html#isValid">QGeoCoordinate::isValid</a>() and QDateTime::isValid().</p>
<!-- @@@isValid -->
<!-- $$$removeAttribute[overload1]$$$removeAttributeAttribute -->
<h3 class="fn"><a name="removeAttribute"></a><span class="type">void</span> QGeoPositionInfo::<span class="name">removeAttribute</span>(<span class="type"><a href="qgeopositioninfo.html#Attribute-enum">Attribute</a></span><i> attribute</i>)</h3>
<p>Removes the specified <i>attribute</i> and its value.</p>
<!-- @@@removeAttribute -->
<!-- $$$setAttribute[overload1]$$$setAttributeAttributeqreal -->
<h3 class="fn"><a name="setAttribute"></a><span class="type">void</span> QGeoPositionInfo::<span class="name">setAttribute</span>(<span class="type"><a href="qgeopositioninfo.html#Attribute-enum">Attribute</a></span><i> attribute</i>, <span class="type">qreal</span><i> value</i>)</h3>
<p>Sets the value for <i>attribute</i> to <i>value</i>.</p>
<p><b>See also </b><a href="qgeopositioninfo.html#attribute">attribute</a>().</p>
<!-- @@@setAttribute -->
<!-- $$$setCoordinate[overload1]$$$setCoordinateconstQGeoCoordinate& -->
<h3 class="fn"><a name="setCoordinate"></a><span class="type">void</span> QGeoPositionInfo::<span class="name">setCoordinate</span>(const <span class="type"><a href="qgeocoordinate.html">QGeoCoordinate</a></span> &<i> coordinate</i>)</h3>
<p>Sets the coordinate for this position to <i>coordinate</i>.</p>
<p><b>See also </b><a href="qgeopositioninfo.html#coordinate">coordinate</a>().</p>
<!-- @@@setCoordinate -->
<!-- $$$setTimestamp[overload1]$$$setTimestampconstQDateTime& -->
<h3 class="fn"><a name="setTimestamp"></a><span class="type">void</span> QGeoPositionInfo::<span class="name">setTimestamp</span>(const <span class="type">QDateTime</span> &<i> timestamp</i>)</h3>
<p>Sets the date and time at which this position was reported to <i>timestamp</i>.</p>
<p>The <i>timestamp</i> must be in UTC time.</p>
<p><b>See also </b><a href="qgeopositioninfo.html#timestamp">timestamp</a>().</p>
<!-- @@@setTimestamp -->
<!-- $$$timestamp[overload1]$$$timestamp -->
<h3 class="fn"><a name="timestamp"></a><span class="type">QDateTime</span> QGeoPositionInfo::<span class="name">timestamp</span>() const</h3>
<p>Returns the date and time at which this position was reported, in UTC time.</p>
<p>Returns an invalid QDateTime if no date/time value has been set.</p>
<p><b>See also </b><a href="qgeopositioninfo.html#setTimestamp">setTimestamp</a>().</p>
<!-- @@@timestamp -->
<!-- $$$operator!=[overload1]$$$operator!=constQGeoPositionInfo& -->
<h3 class="fn"><a name="operator-not-eq"></a><span class="type">bool</span> QGeoPositionInfo::<span class="name">operator!=</span>(const <span class="type">QGeoPositionInfo</span> &<i> other</i>) const</h3>
<p>Returns true if any of this object's values are not the same as those of <i>other</i>.</p>
<!-- @@@operator!= -->
<!-- $$$operator=[overload1]$$$operator=constQGeoPositionInfo& -->
<h3 class="fn"><a name="operator-eq"></a><span class="type">QGeoPositionInfo</span> & QGeoPositionInfo::<span class="name">operator=</span>(const <span class="type">QGeoPositionInfo</span> &<i> other</i>)</h3>
<p>Assigns the values from <i>other</i> to this <a href="qgeopositioninfo.html">QGeoPositionInfo</a>.</p>
<!-- @@@operator= -->
<!-- $$$operator==[overload1]$$$operator==constQGeoPositionInfo& -->
<h3 class="fn"><a name="operator-eq-eq"></a><span class="type">bool</span> QGeoPositionInfo::<span class="name">operator==</span>(const <span class="type">QGeoPositionInfo</span> &<i> other</i>) const</h3>
<p>Returns true if all of this object's values are the same as those of <i>other</i>.</p>
<!-- @@@operator== -->
</div>
<div class="relnonmem">
<h2>Related Non-Members</h2>
<!-- $$$operator<<$$$operator<<QDataStream&QGeoPositionInfo::Attribute -->
<h3 class="fn"><a name="operator-lt-lt-10"></a><span class="type">QDataStream</span> & <span class="name">operator<<</span>(<span class="type">QDataStream</span> &<i> stream</i>, <span class="type"><a href="qgeopositioninfo.html#Attribute-enum">QGeoPositionInfo::Attribute</a></span><i> attr</i>)</h3>
<p>Writes the given <i>attr</i> enumeration to the specified <i>stream</i>.</p>
<p><b>See also </b>Serializing Qt Data Types.</p>
<!-- @@@operator<< -->
<!-- $$$operator<<$$$operator<<QDataStream&constQGeoPositionInfo& -->
<h3 class="fn"><a name="operator-lt-lt-11"></a><span class="type">QDataStream</span> & <span class="name">operator<<</span>(<span class="type">QDataStream</span> &<i> stream</i>, const <span class="type">QGeoPositionInfo</span> &<i> info</i>)</h3>
<p>Writes the given <i>info</i> to the specified <i>stream</i>.</p>
<p><b>See also </b>Serializing Qt Data Types.</p>
<!-- @@@operator<< -->
<!-- $$$operator>>$$$operator>>QDataStream&QGeoPositionInfo::Attribute& -->
<h3 class="fn"><a name="operator-gt-gt-5"></a><span class="type">QDataStream</span> & <span class="name">operator>></span>(<span class="type">QDataStream</span> &<i> stream</i>, <span class="type"><a href="qgeopositioninfo.html#Attribute-enum">QGeoPositionInfo::Attribute</a></span> &<i> attr</i>)</h3>
<p>Reads an attribute enumeration from the specified <i>stream</i> info the given <i>attr</i>.</p>
<p><b>See also </b>Serializing Qt Data Types.</p>
<!-- @@@operator>> -->
<!-- $$$operator>>$$$operator>>QDataStream&QGeoPositionInfo& -->
<h3 class="fn"><a name="operator-gt-gt-6"></a><span class="type">QDataStream</span> & <span class="name">operator>></span>(<span class="type">QDataStream</span> &<i> stream</i>, <span class="type">QGeoPositionInfo</span> &<i> info</i>)</h3>
<p>Reads a coordinate from the specified <i>stream</i> into the given <i>info</i>.</p>
<p><b>See also </b>Serializing Qt Data Types.</p>
<!-- @@@operator>> -->
</div>
</div>
</div>
</div>
</div>
</div>
<div class="footer">
<p>
<acronym title="Copyright">©</acronym> 2014 Digia Plc and/or its
subsidiaries. Documentation contributions included herein are the copyrights of
their respective owners.<br> The documentation provided herein is licensed under the terms of the <a href="http://www.gnu.org/licenses/fdl.html">GNU Free Documentation License version 1.3</a> as published by the Free Software Foundation.<br> Digia, Qt and their respective logos are trademarks of Digia Plc in Finland and/or other countries worldwide. All other trademarks are property
of their respective owners. </p>
</div>
</body>
</html>
|