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
350
351
352
353
354
355
356
357
358
359
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>GypsySatellite</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.72.0">
<link rel="start" 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.8 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="reference" href="rn01.html" title="Gypsy Overview">
<link rel="reference" href="rn02.html" title="Tutorials">
<link rel="chapter" href="ch01.html" title="Programming Gypsy With Python">
<link rel="reference" href="gypsy-server-interfaces.html" title="Gypsy Server Interface">
<link rel="reference" href="gypsy-client-interfaces.html" title="Gypsy Client Interface">
<link rel="reference" href="rn05.html" title="LibGypsy API Reference">
<link rel="chapter" href="ch02.html" title="Gypsy-Daemon Control">
<link rel="chapter" href="ch03.html" title="GPS Data Objects">
</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"><nobr><a href="#id2561647" class="shortcut">Top</a>
 | 
<a href="#id2568401" class="shortcut">Description</a>
 | 
<a href="#id2568322" class="shortcut">Object Hierarchy</a>
 | 
<a href="#id2568346" class="shortcut">Properties</a>
 | 
<a href="#id2568376" class="shortcut">Signals</a></nobr></td></tr>
</table>
<div class="refentry" lang="en">
<a name="GypsySatellite"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2>
<a name="id2561647"></a><span class="refentrytitle">GypsySatellite</span>
</h2>
<p>GypsySatellite — Object for obtaining satellite information</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<h2>Synopsis</h2>
<pre class="synopsis">
<a href="GypsySatellite.html#GypsySatellite-struct">GypsySatellite</a>;
#define <a href="GypsySatellite.html#GYPSY-SATELLITE-DBUS-INTERFACE:CAPS">GYPSY_SATELLITE_DBUS_INTERFACE</a>
#define <a href="GypsySatellite.html#GYPSY-SATELLITE-DBUS-SERVICE:CAPS">GYPSY_SATELLITE_DBUS_SERVICE</a>
<a href="GypsySatellite.html#GypsySatelliteDetails">GypsySatelliteDetails</a>;
<a href="GypsySatellite.html" title="GypsySatellite">GypsySatellite</a>* <a href="GypsySatellite.html#gypsy-satellite-new">gypsy_satellite_new</a> (const char *object_path);
GPtrArray* <a href="GypsySatellite.html#gypsy-satellite-get-satellites">gypsy_satellite_get_satellites</a> (<a href="GypsySatellite.html" title="GypsySatellite">GypsySatellite</a> *satellite,
GError **error);
void <a href="GypsySatellite.html#gypsy-satellite-free-satellite-array">gypsy_satellite_free_satellite_array</a>
(GPtrArray *satellites);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2568322"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
GObject
+----GypsySatellite
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2568346"></a><h2>Properties</h2>
<pre class="synopsis">
"<a href="GypsySatellite.html#GypsySatellite--object-path">object-path</a>" gchararray : Write / Construct Only
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2568376"></a><h2>Signals</h2>
<pre class="synopsis">
"<a href="GypsySatellite.html#GypsySatellite-satellites-changed">satellites-changed</a>" : Run Last
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2568401"></a><h2>Description</h2>
<p>
<a 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 href="GypsySatellite.html" title="GypsySatellite"><span class="type">GypsySatellite</span></a> object is created using <a href="GypsySatellite.html#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 href="GypsyControl.html#gypsy-control-create"><code class="function">gypsy_control_create()</code></a> function. The client can then find out about the
visible satellites with <a href="GypsySatellite.html#gypsy-satellite-get-satellites"><code class="function">gypsy_satellite_get_satellites()</code></a> which returns a
GPtrArray containing the <a href="GypsySatellite.html#GypsySatelliteDetails"><span class="type">GypsySatelliteDetails</span></a> for each visible satellite.
Once the client is finished with this GPtrArray
<a href="GypsySatellite.html#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 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 href="GypsySatellite.html#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"><pre class="programlisting">
GypsySatellite *satellite;
GError *error = NULL;
. . .
/ * path comes from the gypsy_control_create() function * /
satellite = gypsy_satellite_new (path);
g_signal_connect (satellite, "satellite-changed", G_CALLBACK (satellite_changed), NULL);
. . .
static void satellite_changed (GypsySatellite *satellite,
GPtrArray *satellites,
gpointer userdata)
{
  int i;
  for (i = 0; i < satellites->len; i++) {
    GypsySatelliteDetails *details = satellites->pdata[i];
    g_print ("Satellite %d: %s", details->satellite_id, details->in_use ? "In use" : "Not in use");
  }
}
</pre></div>
<p>
</p>
</div>
<div class="refsect1" lang="en">
<a name="id2597278"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id2560339"></a><h3>
<a name="GypsySatellite-struct"></a>GypsySatellite</h3>
<a class="indexterm" name="id2589424"></a><pre class="programlisting">typedef struct _GypsySatellite GypsySatellite;</pre>
<p>
There are no public fields in <a href="GypsySatellite.html" title="GypsySatellite"><span class="type">GypsySatellite</span></a>.</p>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2599941"></a><h3>
<a name="GYPSY-SATELLITE-DBUS-INTERFACE:CAPS"></a>GYPSY_SATELLITE_DBUS_INTERFACE</h3>
<a class="indexterm" name="id2604707"></a><pre class="programlisting">#define GYPSY_SATELLITE_DBUS_INTERFACE "org.freedesktop.Gypsy.Satellite"
</pre>
<p>
A define containing the name of the Satellite interface</p>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2604728"></a><h3>
<a name="GYPSY-SATELLITE-DBUS-SERVICE:CAPS"></a>GYPSY_SATELLITE_DBUS_SERVICE</h3>
<a class="indexterm" name="id2604742"></a><pre class="programlisting">#define GYPSY_SATELLITE_DBUS_SERVICE "org.freedesktop.Gypsy"
</pre>
<p>
A define containing the address of the Satellite service.</p>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2604763"></a><h3>
<a name="GypsySatelliteDetails"></a>GypsySatelliteDetails</h3>
<a class="indexterm" name="id2604774"></a><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>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term">int <em class="structfield"><code>satellite_id</code></em>;</span></td>
<td> The satellite PRN id
</td>
</tr>
<tr>
<td><span class="term">gboolean <em class="structfield"><code>in_use</code></em>;</span></td>
<td> Whether this satellite was used in calculating the fix
</td>
</tr>
<tr>
<td><span class="term">guint <em class="structfield"><code>elevation</code></em>;</span></td>
<td> The satellite elevation
</td>
</tr>
<tr>
<td><span class="term">guint <em class="structfield"><code>azimuth</code></em>;</span></td>
<td> The satellite azimuth
</td>
</tr>
<tr>
<td><span class="term">guint <em class="structfield"><code>snr</code></em>;</span></td>
<td> The signal to noise ratio
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2604904"></a><h3>
<a name="gypsy-satellite-new"></a>gypsy_satellite_new ()</h3>
<a class="indexterm" name="id2604916"></a><pre class="programlisting"><a href="GypsySatellite.html" title="GypsySatellite">GypsySatellite</a>* gypsy_satellite_new (const char *object_path);</pre>
<p>
Creates a new <a 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>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>object_path</code></em> :</span></td>
<td> Object path to the GPS device
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> A <a href="GypsySatellite.html" title="GypsySatellite"><span class="type">GypsySatellite</span></a> object
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2603957"></a><h3>
<a name="gypsy-satellite-get-satellites"></a>gypsy_satellite_get_satellites ()</h3>
<a class="indexterm" name="id2603970"></a><pre class="programlisting">GPtrArray* gypsy_satellite_get_satellites (<a href="GypsySatellite.html" title="GypsySatellite">GypsySatellite</a> *satellite,
GError **error);</pre>
<p>
Retrieves the <a href="GypsySatellite.html#GypsySatelliteDetails"><span class="type">GypsySatelliteDetails</span></a> about the satellites that the
GPS is able to see.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>satellite</code></em> :</span></td>
<td> A <a href="GypsySatellite.html" title="GypsySatellite"><span class="type">GypsySatellite</span></a>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>error</code></em> :</span></td>
<td> A <span class="type">GError</span> for error return
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> A <span class="type">GPtrArray</span> of <a href="GypsySatellite.html#GypsySatelliteDetails"><span class="type">GypsySatelliteDetails</span></a> or <span class="type">NULL</span> on error.
Should be freed using <a href="GypsySatellite.html#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" lang="en">
<a name="id2604106"></a><h3>
<a name="gypsy-satellite-free-satellite-array"></a>gypsy_satellite_free_satellite_array ()</h3>
<a class="indexterm" name="id2604119"></a><pre class="programlisting">void gypsy_satellite_free_satellite_array
(GPtrArray *satellites);</pre>
<p>
Frees all resources used in the array.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><span class="term"><em class="parameter"><code>satellites</code></em> :</span></td>
<td> <span class="type">GPtrArray</span> containing <a href="GypsySatellite.html#GypsySatelliteDetails"><span class="type">GypsySatelliteDetails</span></a>
</td>
</tr></tbody>
</table></div>
</div>
</div>
<div class="refsect1" lang="en">
<a name="id2604186"></a><h2>Property Details</h2>
<div class="refsect2" lang="en">
<a name="id2606733"></a><h3>
<a name="GypsySatellite--object-path"></a>The "<code class="literal">object-path</code>" property</h3>
<a class="indexterm" name="id2606744"></a><pre class="programlisting"> "object-path" gchararray : Write / Construct Only</pre>
<p>The DBus path to the object.</p>
<p>Default value: ""</p>
</div>
</div>
<div class="refsect1" lang="en">
<a name="id2606770"></a><h2>Signal Details</h2>
<div class="refsect2" lang="en">
<a name="id2606779"></a><h3>
<a name="GypsySatellite-satellites-changed"></a>The "satellites-changed" signal</h3>
<a class="indexterm" name="id2606788"></a><pre class="programlisting">void user_function (<a href="GypsySatellite.html" title="GypsySatellite">GypsySatellite</a> *satellites,
gpointer arg1,
gpointer user_data) : Run Last</pre>
<p>
The ::satellites-changed signal is emitted every time the GPS
reports a change in the satellite data.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>satellites</code></em> :</span></td>
<td> A <span class="type">GPtrArray</span> containing <a href="GypsySatellite.html#GypsySatelliteDetails"><span class="type">GypsySatelliteDetails</span></a>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>user_data</code></em> :</span></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
</body>
</html>
|
