/usr/share/qt5/doc/qtpositioning/qgeosatelliteinfo.html is in qtlocation5-doc-html 5.2.1-1ubuntu2.
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 | <?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" />
<!-- qgeosatelliteinfo.cpp -->
<title>QGeoSatelliteInfo Class | QtPositioning 5.2</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.2</li>
<li><a href="qtpositioning-index.html">Qt Positioning</a></li>
<li><a href="qtpositioning-module.html">C++ Classes</a></li>
<li>QGeoSatelliteInfo</li>
<li id="buildversion">
Qt 5.2.1 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">QGeoSatelliteInfo Class</h1>
<!-- $$$QGeoSatelliteInfo-brief -->
<p>The QGeoSatelliteInfo class contains basic information about a satellite. <a href="#details">More...</a></p>
<!-- @@@QGeoSatelliteInfo -->
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> </b><tt><span class="preprocessor">#include <QGeoSatelliteInfo></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="qgeosatelliteinfo-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="qgeosatelliteinfo.html#Attribute-enum">Attribute</a></b> { Elevation, Azimuth }</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> enum </td><td class="memItemRight bottomAlign"><b><a href="qgeosatelliteinfo.html#SatelliteSystem-enum">SatelliteSystem</a></b> { Undefined, GPS, GLONASS }</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="qgeosatelliteinfo.html#QGeoSatelliteInfo">QGeoSatelliteInfo</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qgeosatelliteinfo.html#QGeoSatelliteInfo-2">QGeoSatelliteInfo</a></b>(const QGeoSatelliteInfo &<i> other</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qgeosatelliteinfo.html#dtor.QGeoSatelliteInfo">~QGeoSatelliteInfo</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> qreal </td><td class="memItemRight bottomAlign"><b><a href="qgeosatelliteinfo.html#attribute">attribute</a></b>(Attribute<i> attribute</i>) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qgeosatelliteinfo.html#hasAttribute">hasAttribute</a></b>(Attribute<i> attribute</i>) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qgeosatelliteinfo.html#removeAttribute">removeAttribute</a></b>(Attribute<i> attribute</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qgeosatelliteinfo.html#satelliteIdentifier">satelliteIdentifier</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> SatelliteSystem </td><td class="memItemRight bottomAlign"><b><a href="qgeosatelliteinfo.html#satelliteSystem">satelliteSystem</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qgeosatelliteinfo.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="qgeosatelliteinfo.html#setSatelliteIdentifier">setSatelliteIdentifier</a></b>(int<i> satId</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qgeosatelliteinfo.html#setSatelliteSystem">setSatelliteSystem</a></b>(SatelliteSystem<i> system</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qgeosatelliteinfo.html#setSignalStrength">setSignalStrength</a></b>(int<i> signalStrength</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qgeosatelliteinfo.html#signalStrength">signalStrength</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qgeosatelliteinfo.html#operator-not-eq">operator!=</a></b>(const QGeoSatelliteInfo &<i> other</i>) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QGeoSatelliteInfo & </td><td class="memItemRight bottomAlign"><b><a href="qgeosatelliteinfo.html#operator-eq">operator=</a></b>(const QGeoSatelliteInfo &<i> other</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qgeosatelliteinfo.html#operator-eq-eq">operator==</a></b>(const QGeoSatelliteInfo &<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="qgeosatelliteinfo.html#operator-lt-lt-9">operator<<</a></b>(QDataStream &<i> stream</i>, const QGeoSatelliteInfo &<i> info</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QDataStream & </td><td class="memItemRight bottomAlign"><b><a href="qgeosatelliteinfo.html#operator-gt-gt-5">operator>></a></b>(QDataStream &<i> stream</i>, QGeoSatelliteInfo &<i> info</i>)</td></tr>
</table>
<a name="details"></a>
<!-- $$$QGeoSatelliteInfo-description -->
<div class="descr">
<h2>Detailed Description</h2>
<p>The QGeoSatelliteInfo class contains basic information about a satellite.</p>
</div>
<p><b>See also </b><a href="qgeosatelliteinfosource.html">QGeoSatelliteInfoSource</a>.</p>
<!-- @@@QGeoSatelliteInfo -->
<div class="types">
<h2>Member Type Documentation</h2>
<!-- $$$Attribute$$$Elevation$$$Azimuth -->
<h3 class="fn"><a name="Attribute-enum"></a>enum QGeoSatelliteInfo::<span class="name">Attribute</span></h3>
<p>Defines the attributes for the satellite 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>QGeoSatelliteInfo::Elevation</tt></td><td class="topAlign"><tt>0</tt></td><td class="topAlign">The elevation of the satellite, in degrees.</td></tr>
<tr><td class="topAlign"><tt>QGeoSatelliteInfo::Azimuth</tt></td><td class="topAlign"><tt>1</tt></td><td class="topAlign">The azimuth to true north, in degrees.</td></tr>
</table>
<!-- @@@Attribute -->
<!-- $$$SatelliteSystem$$$Undefined$$$GPS$$$GLONASS -->
<h3 class="fn"><a name="SatelliteSystem-enum"></a>enum QGeoSatelliteInfo::<span class="name">SatelliteSystem</span></h3>
<p>Defines the GNSS system of the satellite.</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>QGeoSatelliteInfo::Undefined</tt></td><td class="topAlign"><tt>0x00</tt></td><td class="topAlign">Not defined.</td></tr>
<tr><td class="topAlign"><tt>QGeoSatelliteInfo::GPS</tt></td><td class="topAlign"><tt>0x01</tt></td><td class="topAlign">Global Positioning System (USA).</td></tr>
<tr><td class="topAlign"><tt>QGeoSatelliteInfo::GLONASS</tt></td><td class="topAlign"><tt>0x02</tt></td><td class="topAlign">Global Positioning System (Russia).</td></tr>
</table>
<!-- @@@SatelliteSystem -->
</div>
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QGeoSatelliteInfo[overload1]$$$QGeoSatelliteInfo -->
<h3 class="fn"><a name="QGeoSatelliteInfo"></a>QGeoSatelliteInfo::<span class="name">QGeoSatelliteInfo</span>()</h3>
<p>Creates a satellite information object.</p>
<!-- @@@QGeoSatelliteInfo -->
<!-- $$$QGeoSatelliteInfo$$$QGeoSatelliteInfoconstQGeoSatelliteInfo& -->
<h3 class="fn"><a name="QGeoSatelliteInfo-2"></a>QGeoSatelliteInfo::<span class="name">QGeoSatelliteInfo</span>(const <span class="type">QGeoSatelliteInfo</span> &<i> other</i>)</h3>
<p>Creates a satellite information object with the values of <i>other</i>.</p>
<!-- @@@QGeoSatelliteInfo -->
<!-- $$$~QGeoSatelliteInfo[overload1]$$$~QGeoSatelliteInfo -->
<h3 class="fn"><a name="dtor.QGeoSatelliteInfo"></a>QGeoSatelliteInfo::<span class="name">~QGeoSatelliteInfo</span>()</h3>
<p>Destroys a satellite information object.</p>
<!-- @@@~QGeoSatelliteInfo -->
<!-- $$$attribute[overload1]$$$attributeAttribute -->
<h3 class="fn"><a name="attribute"></a><span class="type">qreal</span> QGeoSatelliteInfo::<span class="name">attribute</span>(<span class="type"><a href="qgeosatelliteinfo.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 -1 if the value has not been set.</p>
<p><b>See also </b><a href="qgeosatelliteinfo.html#hasAttribute">hasAttribute</a>() and <a href="qgeosatelliteinfo.html#setAttribute">setAttribute</a>().</p>
<!-- @@@attribute -->
<!-- $$$hasAttribute[overload1]$$$hasAttributeAttribute -->
<h3 class="fn"><a name="hasAttribute"></a><span class="type">bool</span> QGeoSatelliteInfo::<span class="name">hasAttribute</span>(<span class="type"><a href="qgeosatelliteinfo.html#Attribute-enum">Attribute</a></span><i> attribute</i>) const</h3>
<p>Returns true if the specified <i>attribute</i> is present in this update.</p>
<!-- @@@hasAttribute -->
<!-- $$$removeAttribute[overload1]$$$removeAttributeAttribute -->
<h3 class="fn"><a name="removeAttribute"></a><span class="type">void</span> QGeoSatelliteInfo::<span class="name">removeAttribute</span>(<span class="type"><a href="qgeosatelliteinfo.html#Attribute-enum">Attribute</a></span><i> attribute</i>)</h3>
<p>Removes the specified <i>attribute</i> and its value.</p>
<!-- @@@removeAttribute -->
<!-- $$$satelliteIdentifier[overload1]$$$satelliteIdentifier -->
<h3 class="fn"><a name="satelliteIdentifier"></a><span class="type">int</span> QGeoSatelliteInfo::<span class="name">satelliteIdentifier</span>() const</h3>
<p>Returns the satellite identifier number.</p>
<p>The satellite identifier number can be used to identify a satellite inside the satellite system. For satellite system GPS the satellite identifier number represents the PRN (Pseudo-random noise) number. For satellite system GLONASS the satellite identifier number represents the slot number.</p>
<p><b>See also </b><a href="qgeosatelliteinfo.html#setSatelliteIdentifier">setSatelliteIdentifier</a>().</p>
<!-- @@@satelliteIdentifier -->
<!-- $$$satelliteSystem[overload1]$$$satelliteSystem -->
<h3 class="fn"><a name="satelliteSystem"></a><span class="type"><a href="qgeosatelliteinfo.html#SatelliteSystem-enum">SatelliteSystem</a></span> QGeoSatelliteInfo::<span class="name">satelliteSystem</span>() const</h3>
<p>Returns the Satellite System (GPS, GLONASS, ...)</p>
<p><b>See also </b><a href="qgeosatelliteinfo.html#setSatelliteSystem">setSatelliteSystem</a>().</p>
<!-- @@@satelliteSystem -->
<!-- $$$setAttribute[overload1]$$$setAttributeAttributeqreal -->
<h3 class="fn"><a name="setAttribute"></a><span class="type">void</span> QGeoSatelliteInfo::<span class="name">setAttribute</span>(<span class="type"><a href="qgeosatelliteinfo.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="qgeosatelliteinfo.html#attribute">attribute</a>().</p>
<!-- @@@setAttribute -->
<!-- $$$setSatelliteIdentifier[overload1]$$$setSatelliteIdentifierint -->
<h3 class="fn"><a name="setSatelliteIdentifier"></a><span class="type">void</span> QGeoSatelliteInfo::<span class="name">setSatelliteIdentifier</span>(<span class="type">int</span><i> satId</i>)</h3>
<p>Sets the satellite identifier number to <i>satId</i>.</p>
<p>The satellite identifier number can be used to identify a satellite inside the satellite system. For satellite system GPS the satellite identifier number represents the PRN (Pseudo-random noise) number. For satellite system GLONASS the satellite identifier number represents the slot number.</p>
<p><b>See also </b><a href="qgeosatelliteinfo.html#satelliteIdentifier">satelliteIdentifier</a>().</p>
<!-- @@@setSatelliteIdentifier -->
<!-- $$$setSatelliteSystem[overload1]$$$setSatelliteSystemSatelliteSystem -->
<h3 class="fn"><a name="setSatelliteSystem"></a><span class="type">void</span> QGeoSatelliteInfo::<span class="name">setSatelliteSystem</span>(<span class="type"><a href="qgeosatelliteinfo.html#SatelliteSystem-enum">SatelliteSystem</a></span><i> system</i>)</h3>
<p>Sets the Satellite System (GPS, GLONASS, ...) to <i>system</i>.</p>
<p><b>See also </b><a href="qgeosatelliteinfo.html#satelliteSystem">satelliteSystem</a>().</p>
<!-- @@@setSatelliteSystem -->
<!-- $$$setSignalStrength[overload1]$$$setSignalStrengthint -->
<h3 class="fn"><a name="setSignalStrength"></a><span class="type">void</span> QGeoSatelliteInfo::<span class="name">setSignalStrength</span>(<span class="type">int</span><i> signalStrength</i>)</h3>
<p>Sets the signal strength to <i>signalStrength</i>, in decibels.</p>
<p><b>See also </b><a href="qgeosatelliteinfo.html#signalStrength">signalStrength</a>().</p>
<!-- @@@setSignalStrength -->
<!-- $$$signalStrength[overload1]$$$signalStrength -->
<h3 class="fn"><a name="signalStrength"></a><span class="type">int</span> QGeoSatelliteInfo::<span class="name">signalStrength</span>() const</h3>
<p>Returns the signal strength, or -1 if the value has not been set.</p>
<p><b>See also </b><a href="qgeosatelliteinfo.html#setSignalStrength">setSignalStrength</a>().</p>
<!-- @@@signalStrength -->
<!-- $$$operator!=[overload1]$$$operator!=constQGeoSatelliteInfo& -->
<h3 class="fn"><a name="operator-not-eq"></a><span class="type">bool</span> QGeoSatelliteInfo::<span class="name">operator!=</span>(const <span class="type">QGeoSatelliteInfo</span> &<i> other</i>) const</h3>
<p>Returns true if any of the information for this satellite are not the same as those of <i>other</i>.</p>
<!-- @@@operator!= -->
<!-- $$$operator=[overload1]$$$operator=constQGeoSatelliteInfo& -->
<h3 class="fn"><a name="operator-eq"></a><span class="type">QGeoSatelliteInfo</span> & QGeoSatelliteInfo::<span class="name">operator=</span>(const <span class="type">QGeoSatelliteInfo</span> &<i> other</i>)</h3>
<p>Assigns the values from <i>other</i> to this object.</p>
<!-- @@@operator= -->
<!-- $$$operator==[overload1]$$$operator==constQGeoSatelliteInfo& -->
<h3 class="fn"><a name="operator-eq-eq"></a><span class="type">bool</span> QGeoSatelliteInfo::<span class="name">operator==</span>(const <span class="type">QGeoSatelliteInfo</span> &<i> other</i>) const</h3>
<p>Returns true if all the information for this satellite are the same as those of <i>other</i>.</p>
<!-- @@@operator== -->
</div>
<div class="relnonmem">
<h2>Related Non-Members</h2>
<!-- $$$operator<<$$$operator<<QDataStream&constQGeoSatelliteInfo& -->
<h3 class="fn"><a name="operator-lt-lt-9"></a><span class="type">QDataStream</span> & <span class="name">operator<<</span>(<span class="type">QDataStream</span> &<i> stream</i>, const <span class="type">QGeoSatelliteInfo</span> &<i> info</i>)</h3>
<p>Writes the given <i>info</i> to the specified <i>stream</i>.</p>
<p><b>See also </b>Format of the QDataStream operators.</p>
<!-- @@@operator<< -->
<!-- $$$operator>>$$$operator>>QDataStream&QGeoSatelliteInfo& -->
<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">QGeoSatelliteInfo</span> &<i> info</i>)</h3>
<p>Reads satellite information from the specified <i>stream</i> into the given <i>info</i>.</p>
<p><b>See also </b>Format of the QDataStream operators.</p>
<!-- @@@operator>> -->
</div>
</div>
</div>
</div>
</div>
</div>
<div class="footer">
<p>
<acronym title="Copyright">©</acronym> 2013 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>
|