/usr/share/gtk-doc/html/gypsy/gypsy-gypsy-course.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 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GypsyCourse</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="GypsyAccuracy.html" title="GypsyAccuracy">
<link rel="next" href="GypsyPosition.html" title="GypsyPosition">
<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="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">
<a href="#gypsy-gypsy-course.synopsis" class="shortcut">Top</a>
|
<a href="#gypsy-gypsy-course.description" class="shortcut">Description</a>
|
<a href="#gypsy-gypsy-course.object-hierarchy" class="shortcut">Object Hierarchy</a>
|
<a href="#gypsy-gypsy-course.properties" class="shortcut">Properties</a>
|
<a href="#gypsy-gypsy-course.signals" class="shortcut">Signals</a>
</td></tr>
</table>
<div class="refentry" title="GypsyCourse">
<a name="gypsy-gypsy-course"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="gypsy-gypsy-course.top_of_page"></a>GypsyCourse</span></h2>
<p>GypsyCourse — Object for obtaining course information</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv" title="Synopsis">
<a name="gypsy-gypsy-course.synopsis"></a><h2>Synopsis</h2>
<a name="GypsyCourse"></a><pre class="synopsis"> <a class="link" href="gypsy-gypsy-course.html#GypsyCourse-struct" title="GypsyCourse">GypsyCourse</a>;
#define <a class="link" href="gypsy-gypsy-course.html#GYPSY-COURSE-DBUS-INTERFACE:CAPS" title="GYPSY_COURSE_DBUS_INTERFACE">GYPSY_COURSE_DBUS_INTERFACE</a>
#define <a class="link" href="gypsy-gypsy-course.html#GYPSY-COURSE-DBUS-SERVICE:CAPS" title="GYPSY_COURSE_DBUS_SERVICE">GYPSY_COURSE_DBUS_SERVICE</a>
enum <a class="link" href="gypsy-gypsy-course.html#GypsyCourseFields" title="enum GypsyCourseFields">GypsyCourseFields</a>;
<a class="link" href="gypsy-gypsy-course.html#GypsyCourse"><span class="returnvalue">GypsyCourse</span></a> * <a class="link" href="gypsy-gypsy-course.html#gypsy-course-new" title="gypsy_course_new ()">gypsy_course_new</a> (<em class="parameter"><code>const <span class="type">char</span> *object_path</code></em>);
<a class="link" href="gypsy-gypsy-course.html#GypsyCourseFields" title="enum GypsyCourseFields"><span class="returnvalue">GypsyCourseFields</span></a> <a class="link" href="gypsy-gypsy-course.html#gypsy-course-get-course" title="gypsy_course_get_course ()">gypsy_course_get_course</a> (<em class="parameter"><code><a class="link" href="gypsy-gypsy-course.html#GypsyCourse"><span class="type">GypsyCourse</span></a> *course</code></em>,
<em class="parameter"><code><span class="type">int</span> *timestamp</code></em>,
<em class="parameter"><code><span class="type">double</span> *speed</code></em>,
<em class="parameter"><code><span class="type">double</span> *direction</code></em>,
<em class="parameter"><code><span class="type">double</span> *climb</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>
</div>
<div class="refsect1" title="Object Hierarchy">
<a name="gypsy-gypsy-course.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>
+----GypsyCourse
</pre>
</div>
<div class="refsect1" title="Properties">
<a name="gypsy-gypsy-course.properties"></a><h2>Properties</h2>
<pre class="synopsis">
"<a class="link" href="gypsy-gypsy-course.html#GypsyCourse--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="gypsy-gypsy-course.signals"></a><h2>Signals</h2>
<pre class="synopsis">
"<a class="link" href="gypsy-gypsy-course.html#GypsyCourse-course-changed" title='The "course-changed" signal'>course-changed</a>" : Run First / No Recursion
</pre>
</div>
<div class="refsect1" title="Description">
<a name="gypsy-gypsy-course.description"></a><h2>Description</h2>
<p>
<a class="link" href="gypsy-gypsy-course.html#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 class="link" href="gypsy-gypsy-course.html#GypsyCourse"><span class="type">GypsyCourse</span></a> object is created using <a class="link" href="gypsy-gypsy-course.html#gypsy-course-new" title="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 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
course with <a class="link" href="gypsy-gypsy-course.html#gypsy-course-get-course" title="gypsy_course_get_course ()"><code class="function">gypsy_course_get_course()</code></a>.
</p>
<p>
As the course information changes <a class="link" href="gypsy-gypsy-course.html#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 class="link" href="gypsy-gypsy-course.html#GypsyCourseFields" title="enum 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">
<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">GypsyCourse <span class="symbol">*</span>course<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>
course <span class="symbol">=</span> <span class="function"><a href="gypsy-gypsy-course.html#gypsy-course-new">gypsy_course_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>course<span class="symbol">,</span> <span class="string">"course-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>course_changed<span class="symbol">),</span> NULL<span class="symbol">);</span>
<span class="symbol">. . .</span>
<span class="gtkdoc kwb">static void</span>
<span class="function">course_changed</span> <span class="symbol">(</span>GypsyCourse <span class="symbol">*</span>course<span class="symbol">,</span>
GypsyCourseFields fields<span class="symbol">,</span>
<span class="gtkdoc kwb">int</span> timestamp<span class="symbol">,</span>
<span class="gtkdoc kwb">double</span> speed<span class="symbol">,</span>
<span class="gtkdoc kwb">double</span> direction<span class="symbol">,</span>
<span class="gtkdoc kwb">double</span> climb<span class="symbol">,</span>
gpointer userdata<span class="symbol">)</span>
<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">"speed: %fm/s</span><span class="gtkdoc esc">\n</span><span class="string">"</span><span class="symbol">, (</span>fields <span class="symbol">&</span> GYPSY_COURSE_FIELDS_SPEED<span class="symbol">)</span> ? speed <span class="symbol">: -</span><span class="number">1.0</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="gypsy-gypsy-course.details"></a><h2>Details</h2>
<div class="refsect2" title="GypsyCourse">
<a name="GypsyCourse-struct"></a><h3>GypsyCourse</h3>
<pre class="programlisting">typedef struct _GypsyCourse GypsyCourse;</pre>
<p>
There are no public fields in <a class="link" href="gypsy-gypsy-course.html#GypsyCourse"><span class="type">GypsyCourse</span></a>.
</p>
</div>
<hr>
<div class="refsect2" title="GYPSY_COURSE_DBUS_INTERFACE">
<a name="GYPSY-COURSE-DBUS-INTERFACE:CAPS"></a><h3>GYPSY_COURSE_DBUS_INTERFACE</h3>
<pre class="programlisting">#define GYPSY_COURSE_DBUS_INTERFACE "org.freedesktop.Gypsy.Course"
</pre>
<p>
A define containing the name of the Course interface
</p>
</div>
<hr>
<div class="refsect2" title="GYPSY_COURSE_DBUS_SERVICE">
<a name="GYPSY-COURSE-DBUS-SERVICE:CAPS"></a><h3>GYPSY_COURSE_DBUS_SERVICE</h3>
<pre class="programlisting">#define GYPSY_COURSE_DBUS_SERVICE "org.freedesktop.Gypsy"
</pre>
<p>
A define containing the address of the Course service
</p>
</div>
<hr>
<div class="refsect2" title="enum GypsyCourseFields">
<a name="GypsyCourseFields"></a><h3>enum GypsyCourseFields</h3>
<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>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><a name="GYPSY-COURSE-FIELDS-NONE:CAPS"></a><span class="term"><code class="literal">GYPSY_COURSE_FIELDS_NONE</code></span></p></td>
<td>None of the fields are valid
</td>
</tr>
<tr>
<td><p><a name="GYPSY-COURSE-FIELDS-SPEED:CAPS"></a><span class="term"><code class="literal">GYPSY_COURSE_FIELDS_SPEED</code></span></p></td>
<td>The speed field is valid
</td>
</tr>
<tr>
<td><p><a name="GYPSY-COURSE-FIELDS-DIRECTION:CAPS"></a><span class="term"><code class="literal">GYPSY_COURSE_FIELDS_DIRECTION</code></span></p></td>
<td>The direction field is valid
</td>
</tr>
<tr>
<td><p><a name="GYPSY-COURSE-FIELDS-CLIMB:CAPS"></a><span class="term"><code class="literal">GYPSY_COURSE_FIELDS_CLIMB</code></span></p></td>
<td>The climb field is valid
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="gypsy_course_new ()">
<a name="gypsy-course-new"></a><h3>gypsy_course_new ()</h3>
<pre class="programlisting"><a class="link" href="gypsy-gypsy-course.html#GypsyCourse"><span class="returnvalue">GypsyCourse</span></a> * gypsy_course_new (<em class="parameter"><code>const <span class="type">char</span> *object_path</code></em>);</pre>
<p>
Creates a new <a class="link" href="gypsy-gypsy-course.html#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>
<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="gypsy-gypsy-course.html#GypsyCourse"><span class="type">GypsyCourse</span></a> object
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="gypsy_course_get_course ()">
<a name="gypsy-course-get-course"></a><h3>gypsy_course_get_course ()</h3>
<pre class="programlisting"><a class="link" href="gypsy-gypsy-course.html#GypsyCourseFields" title="enum GypsyCourseFields"><span class="returnvalue">GypsyCourseFields</span></a> gypsy_course_get_course (<em class="parameter"><code><a class="link" href="gypsy-gypsy-course.html#GypsyCourse"><span class="type">GypsyCourse</span></a> *course</code></em>,
<em class="parameter"><code><span class="type">int</span> *timestamp</code></em>,
<em class="parameter"><code><span class="type">double</span> *speed</code></em>,
<em class="parameter"><code><span class="type">double</span> *direction</code></em>,
<em class="parameter"><code><span class="type">double</span> *climb</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>
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 <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><span class="type">NULL</span></a> if that detail is not required.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>course</code></em> :</span></p></td>
<td>A <a class="link" href="gypsy-gypsy-course.html#GypsyCourse"><span class="type">GypsyCourse</span></a> object
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>timestamp</code></em> :</span></p></td>
<td>Pointer for the timestamp to be returned
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>speed</code></em> :</span></p></td>
<td>Pointer for the speed to be returned
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>direction</code></em> :</span></p></td>
<td>Pointer for the direction to be returned
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>climb</code></em> :</span></p></td>
<td>Pointer for the climb to be returned
</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 bitmask of the fields that are set.
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1" title="Property Details">
<a name="gypsy-gypsy-course.property-details"></a><h2>Property Details</h2>
<div class="refsect2" title='The "object-path" property'>
<a name="GypsyCourse--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 path of the Gypsy GPS object
</p>
<p>Default value: ""</p>
</div>
</div>
<div class="refsect1" title="Signal Details">
<a name="gypsy-gypsy-course.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2" title='The "course-changed" signal'>
<a name="GypsyCourse-course-changed"></a><h3>The <code class="literal">"course-changed"</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="gypsy-gypsy-course.html#GypsyCourse"><span class="type">GypsyCourse</span></a> *fields,
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> timestamp,
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> speed,
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> direction,
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> climb,
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> arg5,
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> 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>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>fields</code></em> :</span></p></td>
<td>A bitmask of <a class="link" href="gypsy-gypsy-course.html#GypsyCourseFields" title="enum GypsyCourseFields"><span class="type">GypsyCourseFields</span></a> indicating which of the following fields are valid
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>timestamp</code></em> :</span></p></td>
<td>The time this change occurred
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>speed</code></em> :</span></p></td>
<td>The new speed
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>direction</code></em> :</span></p></td>
<td>The new direction
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>climb</code></em> :</span></p></td>
<td>The new rate of climb
</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>
|