/usr/share/gtk-doc/html/gypsy/GypsySatellite.html is in libgypsy-doc 0.8-0ubuntu7.
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 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GypsySatellite</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="index.html" title="Gypsy Reference Manual">
<link rel="up" href="ch03.html" title="GPS Data Objects">
<link rel="prev" href="GypsyPosition.html" title="GypsyPosition">
<link rel="next" href="gypsy-GypsyTime.html" title="GypsyTime">
<meta name="generator" content="GTK-Doc V1.15 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="GypsyPosition.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch03.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">Gypsy Reference Manual</th>
<td><a accesskey="n" href="gypsy-GypsyTime.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#GypsySatellite.synopsis" class="shortcut">Top</a>
|
<a href="#GypsySatellite.description" class="shortcut">Description</a>
|
<a href="#GypsySatellite.object-hierarchy" class="shortcut">Object Hierarchy</a>
|
<a href="#GypsySatellite.properties" class="shortcut">Properties</a>
|
<a href="#GypsySatellite.signals" class="shortcut">Signals</a>
</td></tr>
</table>
<div class="refentry" title="GypsySatellite">
<a name="GypsySatellite"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GypsySatellite.top_of_page"></a>GypsySatellite</span></h2>
<p>GypsySatellite — Object for obtaining satellite information</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv" title="Synopsis">
<a name="GypsySatellite.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis"> <a class="link" href="GypsySatellite.html#GypsySatellite-struct" title="GypsySatellite">GypsySatellite</a>;
#define <a class="link" href="GypsySatellite.html#GYPSY-SATELLITE-DBUS-INTERFACE:CAPS" title="GYPSY_SATELLITE_DBUS_INTERFACE">GYPSY_SATELLITE_DBUS_INTERFACE</a>
#define <a class="link" href="GypsySatellite.html#GYPSY-SATELLITE-DBUS-SERVICE:CAPS" title="GYPSY_SATELLITE_DBUS_SERVICE">GYPSY_SATELLITE_DBUS_SERVICE</a>
<a class="link" href="GypsySatellite.html#GypsySatelliteDetails" title="GypsySatelliteDetails">GypsySatelliteDetails</a>;
<a class="link" href="GypsySatellite.html" title="GypsySatellite"><span class="returnvalue">GypsySatellite</span></a> * <a class="link" href="GypsySatellite.html#gypsy-satellite-new" title="gypsy_satellite_new ()">gypsy_satellite_new</a> (<em class="parameter"><code>const <span class="type">char</span> *object_path</code></em>);
<a href="/usr/share/gtk-doc/html/glib/glib-Pointer-Arrays.html#GPtrArray"><span class="returnvalue">GPtrArray</span></a> * <a class="link" href="GypsySatellite.html#gypsy-satellite-get-satellites" title="gypsy_satellite_get_satellites ()">gypsy_satellite_get_satellites</a> (<em class="parameter"><code><a class="link" href="GypsySatellite.html" title="GypsySatellite"><span class="type">GypsySatellite</span></a> *satellite</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
<span class="returnvalue">void</span> <a class="link" href="GypsySatellite.html#gypsy-satellite-free-satellite-array" title="gypsy_satellite_free_satellite_array ()">gypsy_satellite_free_satellite_array</a>
(<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Pointer-Arrays.html#GPtrArray"><span class="type">GPtrArray</span></a> *satellites</code></em>);
</pre>
</div>
<div class="refsect1" title="Object Hierarchy">
<a name="GypsySatellite.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
<a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a>
+----GypsySatellite
</pre>
</div>
<div class="refsect1" title="Properties">
<a name="GypsySatellite.properties"></a><h2>Properties</h2>
<pre class="synopsis">
"<a class="link" href="GypsySatellite.html#GypsySatellite--object-path" title='The "object-path" property'>object-path</a>" <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Write / Construct Only
</pre>
</div>
<div class="refsect1" title="Signals">
<a name="GypsySatellite.signals"></a><h2>Signals</h2>
<pre class="synopsis">
"<a class="link" href="GypsySatellite.html#GypsySatellite-satellites-changed" title='The "satellites-changed" signal'>satellites-changed</a>" : Run Last
</pre>
</div>
<div class="refsect1" title="Description">
<a name="GypsySatellite.description"></a><h2>Description</h2>
<p>
<a class="link" href="GypsySatellite.html" title="GypsySatellite"><span class="type">GypsySatellite</span></a> is used whenever the client program wishes to know about
changes in the satellite details. The satellite details contain the satellite
ID number (the PRN), the elevation, the azimuth, the signal-to-noise ratio
(SNR) and whether or not the satellite was used to calculate the fix.
</p>
<p>
A <a class="link" href="GypsySatellite.html" title="GypsySatellite"><span class="type">GypsySatellite</span></a> object is created using <a class="link" href="GypsySatellite.html#gypsy-satellite-new" title="gypsy_satellite_new ()"><code class="function">gypsy_satellite_new()</code></a> using the
D-Bus path of the GPS device. This path is returned from the
<a class="link" href="gypsy-gypsy-control.html#gypsy-control-create" title="gypsy_control_create ()"><code class="function">gypsy_control_create()</code></a> function. The client can then find out about the
visible satellites with <a class="link" href="GypsySatellite.html#gypsy-satellite-get-satellites" title="gypsy_satellite_get_satellites ()"><code class="function">gypsy_satellite_get_satellites()</code></a> which returns a
GPtrArray containing the <a class="link" href="GypsySatellite.html#GypsySatelliteDetails" title="GypsySatelliteDetails"><span class="type">GypsySatelliteDetails</span></a> for each visible satellite.
Once the client is finished with this GPtrArray
<a class="link" href="GypsySatellite.html#gypsy-satellite-free-satellite-array" title="gypsy_satellite_free_satellite_array ()"><code class="function">gypsy_satellite_free_satellite_array()</code></a> should be used to free the data.
</p>
<p>
As the satellite information changes <a class="link" href="GypsySatellite.html" title="GypsySatellite"><span class="type">GypsySatellite</span></a> will emit the
satellite-changed signal. This signal contains the satellite details in
a GPtrArray. In this case the satellite array does not need to be freed
with <a class="link" href="GypsySatellite.html#gypsy-satellite-free-satellite-array" title="gypsy_satellite_free_satellite_array ()"><code class="function">gypsy_satellite_free_satellite_array()</code></a>.
</p>
<p>
Although gypsy-daemon only emits signals whenever the associated data has
changed, satellite data is constantly changing, so so the satellite-changed
signal will be emitted at a rate of once every second.
</p>
<p>
</p>
<div class="informalexample">
<table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
<tbody>
<tr>
<td class="listing_lines" align="right"><pre>1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22</pre></td>
<td class="listing_code"><pre class="programlisting">GypsySatellite <span class="symbol">*</span>satellite<span class="symbol">;</span>
GError <span class="symbol">*</span>error <span class="symbol">=</span> NULL<span class="symbol">;</span>
<span class="symbol">. . .</span>
<span class="symbol">/ *</span> path comes from the <span class="function"><a href="gypsy-gypsy-control.html#gypsy-control-create">gypsy_control_create</a></span><span class="symbol">()</span> function <span class="symbol">* /</span>
satellite <span class="symbol">=</span> <span class="function"><a href="GypsySatellite.html#gypsy-satellite-new">gypsy_satellite_new</a></span> <span class="symbol">(</span>path<span class="symbol">);</span>
<span class="function"><a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#g-signal-connect">g_signal_connect</a></span> <span class="symbol">(</span>satellite<span class="symbol">,</span> <span class="string">"satellite-changed"</span><span class="symbol">,</span> <span class="function"><a href="/usr/share/gtk-doc/html/gobject/gobject-Closures.html#G-CALLBACK:CAPS">G_CALLBACK</a></span> <span class="symbol">(</span>satellite_changed<span class="symbol">),</span> NULL<span class="symbol">);</span>
<span class="symbol">. . .</span>
<span class="gtkdoc kwb">static void</span> <span class="function">satellite_changed</span> <span class="symbol">(</span>GypsySatellite <span class="symbol">*</span>satellite<span class="symbol">,</span>
GPtrArray <span class="symbol">*</span>satellites<span class="symbol">,</span>
gpointer userdata<span class="symbol">)</span>
<span class="symbol">{</span>
<span class="gtkdoc kwb">int</span> i<span class="symbol">;</span>
<span class="keyword">for</span> <span class="symbol">(</span>i <span class="symbol">=</span> <span class="number">0</span><span class="symbol">;</span> i <span class="symbol"><</span> satellites<span class="symbol">-></span>len<span class="symbol">;</span> i<span class="symbol">++) {</span>
GypsySatelliteDetails <span class="symbol">*</span>details <span class="symbol">=</span> satellites<span class="symbol">-></span>pdata<span class="symbol">[</span>i<span class="symbol">];</span>
<span class="function"><a href="/usr/share/gtk-doc/html/glib/glib-Warnings-and-Assertions.html#g-print">g_print</a></span> <span class="symbol">(</span><span class="string">"Satellite %d: %s"</span><span class="symbol">,</span> details<span class="symbol">-></span>satellite_id<span class="symbol">,</span> details<span class="symbol">-></span>in_use ? <span class="string">"In use"</span> <span class="symbol">:</span> <span class="string">"Not in use"</span><span class="symbol">);</span>
<span class="symbol">}</span>
<span class="symbol">}</span></pre></td>
</tr>
</tbody>
</table>
</div>
<p>
</p>
</div>
<div class="refsect1" title="Details">
<a name="GypsySatellite.details"></a><h2>Details</h2>
<div class="refsect2" title="GypsySatellite">
<a name="GypsySatellite-struct"></a><h3>GypsySatellite</h3>
<pre class="programlisting">typedef struct _GypsySatellite GypsySatellite;</pre>
<p>
There are no public fields in <a class="link" href="GypsySatellite.html" title="GypsySatellite"><span class="type">GypsySatellite</span></a>.
</p>
</div>
<hr>
<div class="refsect2" title="GYPSY_SATELLITE_DBUS_INTERFACE">
<a name="GYPSY-SATELLITE-DBUS-INTERFACE:CAPS"></a><h3>GYPSY_SATELLITE_DBUS_INTERFACE</h3>
<pre class="programlisting">#define GYPSY_SATELLITE_DBUS_INTERFACE "org.freedesktop.Gypsy.Satellite"
</pre>
<p>
A define containing the name of the Satellite interface
</p>
</div>
<hr>
<div class="refsect2" title="GYPSY_SATELLITE_DBUS_SERVICE">
<a name="GYPSY-SATELLITE-DBUS-SERVICE:CAPS"></a><h3>GYPSY_SATELLITE_DBUS_SERVICE</h3>
<pre class="programlisting">#define GYPSY_SATELLITE_DBUS_SERVICE "org.freedesktop.Gypsy"
</pre>
<p>
A define containing the address of the Satellite service.
</p>
</div>
<hr>
<div class="refsect2" title="GypsySatelliteDetails">
<a name="GypsySatelliteDetails"></a><h3>GypsySatelliteDetails</h3>
<pre class="programlisting">typedef struct {
int satellite_id;
gboolean in_use;
guint elevation;
guint azimuth;
guint snr;
} GypsySatelliteDetails;
</pre>
<p>
A structure defining a satellite
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><span class="type">int</span> <em class="structfield"><code><a name="GypsySatelliteDetails.satellite-id"></a>satellite_id</code></em>;</span></p></td>
<td>The satellite PRN id
</td>
</tr>
<tr>
<td><p><span class="term"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> <em class="structfield"><code><a name="GypsySatelliteDetails.in-use"></a>in_use</code></em>;</span></p></td>
<td>Whether this satellite was used in calculating the fix
</td>
</tr>
<tr>
<td><p><span class="term"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> <em class="structfield"><code><a name="GypsySatelliteDetails.elevation"></a>elevation</code></em>;</span></p></td>
<td>The satellite elevation
</td>
</tr>
<tr>
<td><p><span class="term"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> <em class="structfield"><code><a name="GypsySatelliteDetails.azimuth"></a>azimuth</code></em>;</span></p></td>
<td>The satellite azimuth
</td>
</tr>
<tr>
<td><p><span class="term"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> <em class="structfield"><code><a name="GypsySatelliteDetails.snr"></a>snr</code></em>;</span></p></td>
<td>The signal to noise ratio
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="gypsy_satellite_new ()">
<a name="gypsy-satellite-new"></a><h3>gypsy_satellite_new ()</h3>
<pre class="programlisting"><a class="link" href="GypsySatellite.html" title="GypsySatellite"><span class="returnvalue">GypsySatellite</span></a> * gypsy_satellite_new (<em class="parameter"><code>const <span class="type">char</span> *object_path</code></em>);</pre>
<p>
Creates a new <a class="link" href="GypsySatellite.html" title="GypsySatellite"><span class="type">GypsySatellite</span></a> object that listens for satellite changes
from the GPS found at <em class="parameter"><code>object_path</code></em>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>object_path</code></em> :</span></p></td>
<td>Object path to the GPS device
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> A <a class="link" href="GypsySatellite.html" title="GypsySatellite"><span class="type">GypsySatellite</span></a> object
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="gypsy_satellite_get_satellites ()">
<a name="gypsy-satellite-get-satellites"></a><h3>gypsy_satellite_get_satellites ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Pointer-Arrays.html#GPtrArray"><span class="returnvalue">GPtrArray</span></a> * gypsy_satellite_get_satellites (<em class="parameter"><code><a class="link" href="GypsySatellite.html" title="GypsySatellite"><span class="type">GypsySatellite</span></a> *satellite</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>
Retrieves the <a class="link" href="GypsySatellite.html#GypsySatelliteDetails" title="GypsySatelliteDetails"><span class="type">GypsySatelliteDetails</span></a> about the satellites that the
GPS is able to see.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>satellite</code></em> :</span></p></td>
<td>A <a class="link" href="GypsySatellite.html" title="GypsySatellite"><span class="type">GypsySatellite</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>A <a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> for error return
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> A <a href="/usr/share/gtk-doc/html/glib/glib-Pointer-Arrays.html#GPtrArray"><span class="type">GPtrArray</span></a> of <a class="link" href="GypsySatellite.html#GypsySatelliteDetails" title="GypsySatelliteDetails"><span class="type">GypsySatelliteDetails</span></a> or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><span class="type">NULL</span></a> on error.
Should be freed using <a class="link" href="GypsySatellite.html#gypsy-satellite-free-satellite-array" title="gypsy_satellite_free_satellite_array ()"><code class="function">gypsy_satellite_free_satellite_array()</code></a>.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="gypsy_satellite_free_satellite_array ()">
<a name="gypsy-satellite-free-satellite-array"></a><h3>gypsy_satellite_free_satellite_array ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gypsy_satellite_free_satellite_array
(<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Pointer-Arrays.html#GPtrArray"><span class="type">GPtrArray</span></a> *satellites</code></em>);</pre>
<p>
Frees all resources used in the array.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>satellites</code></em> :</span></p></td>
<td>
<a href="/usr/share/gtk-doc/html/glib/glib-Pointer-Arrays.html#GPtrArray"><span class="type">GPtrArray</span></a> containing <a class="link" href="GypsySatellite.html#GypsySatelliteDetails" title="GypsySatelliteDetails"><span class="type">GypsySatelliteDetails</span></a>
</td>
</tr></tbody>
</table></div>
</div>
</div>
<div class="refsect1" title="Property Details">
<a name="GypsySatellite.property-details"></a><h2>Property Details</h2>
<div class="refsect2" title='The "object-path" property'>
<a name="GypsySatellite--object-path"></a><h3>The <code class="literal">"object-path"</code> property</h3>
<pre class="programlisting"> "object-path" <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Write / Construct Only</pre>
<p>The DBus path to the object.</p>
<p>Default value: ""</p>
</div>
</div>
<div class="refsect1" title="Signal Details">
<a name="GypsySatellite.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2" title='The "satellites-changed" signal'>
<a name="GypsySatellite-satellites-changed"></a><h3>The <code class="literal">"satellites-changed"</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="GypsySatellite.html" title="GypsySatellite"><span class="type">GypsySatellite</span></a> *satellites,
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> arg1,
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data) : Run Last</pre>
<p>
The ::satellites-changed signal is emitted every time the GPS
reports a change in the satellite data.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>satellites</code></em> :</span></p></td>
<td>A <a href="/usr/share/gtk-doc/html/glib/glib-Pointer-Arrays.html#GPtrArray"><span class="type">GPtrArray</span></a> containing <a class="link" href="GypsySatellite.html#GypsySatelliteDetails" title="GypsySatelliteDetails"><span class="type">GypsySatelliteDetails</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.15</div>
</body>
</html>
|