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
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>GypsyCourse</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="GypsyAccuracy.html" title="GypsyAccuracy">
<link rel="next" href="GypsyPosition.html" title="GypsyPosition">
<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="GypsyAccuracy.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="GypsyPosition.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="#id2588413" class="shortcut">Top</a>
 | 
<a href="#id2558314" class="shortcut">Description</a>
 | 
<a href="#id2573560" class="shortcut">Object Hierarchy</a>
 | 
<a href="#id2573584" class="shortcut">Properties</a>
 | 
<a href="#id2573614" class="shortcut">Signals</a></nobr></td></tr>
</table>
<div class="refentry" lang="en">
<a name="GypsyCourse"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2>
<a name="id2588413"></a><span class="refentrytitle">GypsyCourse</span>
</h2>
<p>GypsyCourse — Object for obtaining course information</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<h2>Synopsis</h2>
<pre class="synopsis">
<a href="GypsyCourse.html#GypsyCourse-struct">GypsyCourse</a>;
#define <a href="GypsyCourse.html#GYPSY-COURSE-DBUS-INTERFACE:CAPS">GYPSY_COURSE_DBUS_INTERFACE</a>
#define <a href="GypsyCourse.html#GYPSY-COURSE-DBUS-SERVICE:CAPS">GYPSY_COURSE_DBUS_SERVICE</a>
enum <a href="GypsyCourse.html#GypsyCourseFields">GypsyCourseFields</a>;
<a href="GypsyCourse.html" title="GypsyCourse">GypsyCourse</a>* <a href="GypsyCourse.html#gypsy-course-new">gypsy_course_new</a> (const char *object_path);
<a href="GypsyCourse.html#GypsyCourseFields">GypsyCourseFields</a> <a href="GypsyCourse.html#gypsy-course-get-course">gypsy_course_get_course</a> (<a href="GypsyCourse.html" title="GypsyCourse">GypsyCourse</a> *course,
int *timestamp,
double *speed,
double *direction,
double *climb,
GError **error);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2573560"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
GObject
+----GypsyCourse
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2573584"></a><h2>Properties</h2>
<pre class="synopsis">
"<a href="GypsyCourse.html#GypsyCourse--object-path">object-path</a>" gchararray : Write / Construct Only
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2573614"></a><h2>Signals</h2>
<pre class="synopsis">
"<a href="GypsyCourse.html#GypsyCourse-course-changed">course-changed</a>" : Run First / No Recursion
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2558314"></a><h2>Description</h2>
<p>
<a href="GypsyCourse.html" title="GypsyCourse"><span class="type">GypsyCourse</span></a> is used whenever the client program wishes to know about
GPS course changes. It can report the current course, and has a signal
to notify listeners of changes. The course consists of the speed, direction
and rate of ascent or descent (called the climb).
</p>
<p>
A <a href="GypsyCourse.html" title="GypsyCourse"><span class="type">GypsyCourse</span></a> object is created using <a href="GypsyCourse.html#gypsy-course-new"><code class="function">gypsy_course_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
course with <a href="GypsyCourse.html#gypsy-course-get-course"><code class="function">gypsy_course_get_course()</code></a>.
</p>
<p>
As the course information changes <a href="GypsyCourse.html" title="GypsyCourse"><span class="type">GypsyCourse</span></a> will emit the
course-changed signal. This signal contains the course information if
gypsy-daemon knows it. It has a fields paramater which is a bitmask of
<a href="GypsyCourse.html#GypsyCourseFields"><span class="type">GypsyCourseFields</span></a> which indicates which of the speed, direction or
climb contains valid information. The timestamp will always be valid
if it is greater than 0.
</p>
<p>
</p>
<div class="informalexample"><pre class="programlisting">
GypsyCourse *course;
GError *error = NULL;
. . .
/ * path comes from the gypsy_control_create() function * /
course = gypsy_course_new (path);
g_signal_connect (course, "course-changed", G_CALLBACK (course_changed), NULL);
. . .
static void
course_changed (GypsyCourse *course,
GypsyCourseFields fields,
int timestamp,
double speed,
double direction,
double climb,
gpointer userdata)
{
  g_print ("speed: %fm/s\n", (fields & GYPSY_COURSE_FIELDS_SPEED) ? speed : -1.0);
}
</pre></div>
<p>
</p>
</div>
<div class="refsect1" lang="en">
<a name="id2558427"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id2558438"></a><h3>
<a name="GypsyCourse-struct"></a>GypsyCourse</h3>
<a class="indexterm" name="id2558451"></a><pre class="programlisting">typedef struct _GypsyCourse GypsyCourse;</pre>
<p>
There are no public fields in <a href="GypsyCourse.html" title="GypsyCourse"><span class="type">GypsyCourse</span></a>.</p>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2559400"></a><h3>
<a name="GYPSY-COURSE-DBUS-INTERFACE:CAPS"></a>GYPSY_COURSE_DBUS_INTERFACE</h3>
<a class="indexterm" name="id2559411"></a><pre class="programlisting">#define GYPSY_COURSE_DBUS_INTERFACE "org.freedesktop.Gypsy.Course"
</pre>
<p>
A define containing the name of the Course interface</p>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2559432"></a><h3>
<a name="GYPSY-COURSE-DBUS-SERVICE:CAPS"></a>GYPSY_COURSE_DBUS_SERVICE</h3>
<a class="indexterm" name="id2559443"></a><pre class="programlisting">#define GYPSY_COURSE_DBUS_SERVICE "org.freedesktop.Gypsy"
</pre>
<p>
A define containing the address of the Course service</p>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2559464"></a><h3>
<a name="GypsyCourseFields"></a>enum GypsyCourseFields</h3>
<a class="indexterm" name="id2559476"></a><pre class="programlisting">typedef enum {
GYPSY_COURSE_FIELDS_NONE = 0,
GYPSY_COURSE_FIELDS_SPEED = 1 << 0,
GYPSY_COURSE_FIELDS_DIRECTION = 1 << 1,
GYPSY_COURSE_FIELDS_CLIMB = 1 << 2
} GypsyCourseFields;
</pre>
<p>
A bitfield telling which fields in the course_changed callback are valid</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><a name="GYPSY-COURSE-FIELDS-NONE:CAPS"></a><code class="literal">GYPSY_COURSE_FIELDS_NONE</code></span></td>
<td> None of the fields are valid
</td>
</tr>
<tr>
<td><span class="term"><a name="GYPSY-COURSE-FIELDS-SPEED:CAPS"></a><code class="literal">GYPSY_COURSE_FIELDS_SPEED</code></span></td>
<td> The speed field is valid
</td>
</tr>
<tr>
<td><span class="term"><a name="GYPSY-COURSE-FIELDS-DIRECTION:CAPS"></a><code class="literal">GYPSY_COURSE_FIELDS_DIRECTION</code></span></td>
<td> The direction field is valid
</td>
</tr>
<tr>
<td><span class="term"><a name="GYPSY-COURSE-FIELDS-CLIMB:CAPS"></a><code class="literal">GYPSY_COURSE_FIELDS_CLIMB</code></span></td>
<td> The climb field is valid
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2559590"></a><h3>
<a name="gypsy-course-new"></a>gypsy_course_new ()</h3>
<a class="indexterm" name="id2559602"></a><pre class="programlisting"><a href="GypsyCourse.html" title="GypsyCourse">GypsyCourse</a>* gypsy_course_new (const char *object_path);</pre>
<p>
Creates a new <a href="GypsyCourse.html" title="GypsyCourse"><span class="type">GypsyCourse</span></a> object that listens for course changes
from the GPS device 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="GypsyCourse.html" title="GypsyCourse"><span class="type">GypsyCourse</span></a> object
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2594801"></a><h3>
<a name="gypsy-course-get-course"></a>gypsy_course_get_course ()</h3>
<a class="indexterm" name="id2594812"></a><pre class="programlisting"><a href="GypsyCourse.html#GypsyCourseFields">GypsyCourseFields</a> gypsy_course_get_course (<a href="GypsyCourse.html" title="GypsyCourse">GypsyCourse</a> *course,
int *timestamp,
double *speed,
double *direction,
double *climb,
GError **error);</pre>
<p>
Obtains the course details from <em class="parameter"><code>course</code></em>. <em class="parameter"><code>timestamp</code></em>, <em class="parameter"><code>speed</code></em>, <em class="parameter"><code>direction</code></em> and
<em class="parameter"><code>climb</code></em> can be <span class="type">NULL</span> if that detail is not required.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>course</code></em> :</span></td>
<td> A <a href="GypsyCourse.html" title="GypsyCourse"><span class="type">GypsyCourse</span></a> object
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>timestamp</code></em> :</span></td>
<td> Pointer for the timestamp to be returned
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>speed</code></em> :</span></td>
<td> Pointer for the speed to be returned
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>direction</code></em> :</span></td>
<td> Pointer for the direction to be returned
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>climb</code></em> :</span></td>
<td> Pointer for the climb to be returned
</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 bitmask of the fields that are set.
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1" lang="en">
<a name="id2595033"></a><h2>Property Details</h2>
<div class="refsect2" lang="en">
<a name="id2604350"></a><h3>
<a name="GypsyCourse--object-path"></a>The "<code class="literal">object-path</code>" property</h3>
<a class="indexterm" name="id2604362"></a><pre class="programlisting"> "object-path" gchararray : Write / Construct Only</pre>
<p>
The path of the Gypsy GPS object</p>
<p>
</p>
<p>Default value: ""</p>
</div>
</div>
<div class="refsect1" lang="en">
<a name="id2604391"></a><h2>Signal Details</h2>
<div class="refsect2" lang="en">
<a name="id2604400"></a><h3>
<a name="GypsyCourse-course-changed"></a>The "course-changed" signal</h3>
<a class="indexterm" name="id2604407"></a><pre class="programlisting">void user_function (<a href="GypsyCourse.html" title="GypsyCourse">GypsyCourse</a> *fields,
gint timestamp,
gint speed,
gdouble direction,
gdouble climb,
gdouble arg5,
gpointer user_data) : Run First / No Recursion</pre>
<p>
The ::course-changed signal is emitted when the GPS device
indicates that one or more of the course fields has changed.
The fields which have changed will be indicated in the <em class="parameter"><code>fields</code></em>
bitmask.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>fields</code></em> :</span></td>
<td> A bitmask of <a href="GypsyCourse.html#GypsyCourseFields"><span class="type">GypsyCourseFields</span></a> indicating which of the following fields are valid
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>timestamp</code></em> :</span></td>
<td> The time this change occurred
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>speed</code></em> :</span></td>
<td> The new speed
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>direction</code></em> :</span></td>
<td> The new direction
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>climb</code></em> :</span></td>
<td> The new rate of climb
</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>
|
