/usr/share/gtk-doc/html/gypsy/GypsyDevice.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 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GypsyDevice</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="ch03.html" title="GPS Data Objects">
<link rel="next" href="GypsyAccuracy.html" title="GypsyAccuracy">
<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="ch03.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="GypsyAccuracy.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#GypsyDevice.synopsis" class="shortcut">Top</a>
|
<a href="#GypsyDevice.description" class="shortcut">Description</a>
|
<a href="#GypsyDevice.object-hierarchy" class="shortcut">Object Hierarchy</a>
|
<a href="#GypsyDevice.properties" class="shortcut">Properties</a>
|
<a href="#GypsyDevice.signals" class="shortcut">Signals</a>
</td></tr>
</table>
<div class="refentry" title="GypsyDevice">
<a name="GypsyDevice"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GypsyDevice.top_of_page"></a>GypsyDevice</span></h2>
<p>GypsyDevice — Object for obtaining device information</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv" title="Synopsis">
<a name="GypsyDevice.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis"> <a class="link" href="GypsyDevice.html#GypsyDevice-struct" title="GypsyDevice">GypsyDevice</a>;
#define <a class="link" href="GypsyDevice.html#GYPSY-DEVICE-DBUS-SERVICE:CAPS" title="GYPSY_DEVICE_DBUS_SERVICE">GYPSY_DEVICE_DBUS_SERVICE</a>
#define <a class="link" href="GypsyDevice.html#GYPSY-DEVICE-DBUS-INTERFACE:CAPS" title="GYPSY_DEVICE_DBUS_INTERFACE">GYPSY_DEVICE_DBUS_INTERFACE</a>
enum <a class="link" href="GypsyDevice.html#GypsyDeviceFixStatus" title="enum GypsyDeviceFixStatus">GypsyDeviceFixStatus</a>;
<a class="link" href="GypsyDevice.html" title="GypsyDevice"><span class="returnvalue">GypsyDevice</span></a> * <a class="link" href="GypsyDevice.html#gypsy-device-new" title="gypsy_device_new ()">gypsy_device_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-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="GypsyDevice.html#gypsy-device-get-connection-status" title="gypsy_device_get_connection_status ()">gypsy_device_get_connection_status</a> (<em class="parameter"><code><a class="link" href="GypsyDevice.html" title="GypsyDevice"><span class="type">GypsyDevice</span></a> *device</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>);
<a class="link" href="GypsyDevice.html#GypsyDeviceFixStatus" title="enum GypsyDeviceFixStatus"><span class="returnvalue">GypsyDeviceFixStatus</span></a> <a class="link" href="GypsyDevice.html#gypsy-device-get-fix-status" title="gypsy_device_get_fix_status ()">gypsy_device_get_fix_status</a> (<em class="parameter"><code><a class="link" href="GypsyDevice.html" title="GypsyDevice"><span class="type">GypsyDevice</span></a> *device</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>);
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="GypsyDevice.html#gypsy-device-set-start-options" title="gypsy_device_set_start_options ()">gypsy_device_set_start_options</a> (<em class="parameter"><code><a class="link" href="GypsyDevice.html" title="GypsyDevice"><span class="type">GypsyDevice</span></a> *device</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Hash-Tables.html#GHashTable"><span class="type">GHashTable</span></a> *options</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>);
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="GypsyDevice.html#gypsy-device-start" title="gypsy_device_start ()">gypsy_device_start</a> (<em class="parameter"><code><a class="link" href="GypsyDevice.html" title="GypsyDevice"><span class="type">GypsyDevice</span></a> *device</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>);
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="GypsyDevice.html#gypsy-device-stop" title="gypsy_device_stop ()">gypsy_device_stop</a> (<em class="parameter"><code><a class="link" href="GypsyDevice.html" title="GypsyDevice"><span class="type">GypsyDevice</span></a> *device</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="GypsyDevice.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>
+----GypsyDevice
</pre>
</div>
<div class="refsect1" title="Properties">
<a name="GypsyDevice.properties"></a><h2>Properties</h2>
<pre class="synopsis">
"<a class="link" href="GypsyDevice.html#GypsyDevice--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="GypsyDevice.signals"></a><h2>Signals</h2>
<pre class="synopsis">
"<a class="link" href="GypsyDevice.html#GypsyDevice-connection-changed" title='The "connection-changed" signal'>connection-changed</a>" : Run First / No Recursion
"<a class="link" href="GypsyDevice.html#GypsyDevice-fix-status-changed" title='The "fix-status-changed" signal'>fix-status-changed</a>" : Run First / No Recursion
</pre>
</div>
<div class="refsect1" title="Description">
<a name="GypsyDevice.description"></a><h2>Description</h2>
<p>
<a class="link" href="GypsyDevice.html" title="GypsyDevice"><span class="type">GypsyDevice</span></a> is used whenever the client program wishes to know about
changes in the device's status. It has signals for connection status and
fix status. It can also be used to tell gypsy-daemon to start or stop parsing
sentences from the GPS device.
</p>
<p>
A <a class="link" href="GypsyDevice.html" title="GypsyDevice"><span class="type">GypsyDevice</span></a> object is created using <a class="link" href="GypsyDevice.html#gypsy-device-new" title="gypsy_device_new ()"><code class="function">gypsy_device_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 start the GPS data stream with <a class="link" href="GypsyDevice.html#gypsy-device-start" title="gypsy_device_start ()"><code class="function">gypsy_device_start()</code></a>,
stop it with <a class="link" href="GypsyDevice.html#gypsy-device-stop" title="gypsy_device_stop ()"><code class="function">gypsy_device_stop()</code></a>, or find out about the status with
<a class="link" href="GypsyDevice.html#gypsy-device-get-fix-status" title="gypsy_device_get_fix_status ()"><code class="function">gypsy_device_get_fix_status()</code></a> and <a class="link" href="GypsyDevice.html#gypsy-device-get-connection-status" title="gypsy_device_get_connection_status ()"><code class="function">gypsy_device_get_connection_status()</code></a>.
</p>
<p>
As the fix status and connection status change, <a class="link" href="GypsyDevice.html" title="GypsyDevice"><span class="type">GypsyDevice</span></a> will emit the
<a class="link" href="GypsyDevice.html#GypsyDevice-fix-status-changed" title='The "fix-status-changed" signal'><span class="type">"fix-status-changed"</span></a> and <a class="link" href="GypsyDevice.html#GypsyDevice-connection-changed" title='The "connection-changed" signal'><span class="type">"connection-changed"</span></a> signals
respectively.
</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</pre></td>
<td class="listing_code"><pre class="programlisting">GypsyDevice <span class="symbol">*</span>device<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="comment">/* path comes from the <a class="link" href="gypsy-gypsy-control.html#gypsy-control-create" title="gypsy_control_create ()">gypsy_control_create</a>() function */</span>
device <span class="symbol">= <</span>a <span class="gtkdoc kwc">class</span><span class="symbol">=</span><span class="string">"link"</span> href<span class="symbol">=</span><span class="string">"GypsyDevice.html#gypsy-device-new"</span> title<span class="symbol">=</span><span class="string">"gypsy_device_new ()"</span><span class="symbol">></span>gypsy_device_new<span class="symbol"></</span>a<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>device<span class="symbol">,</span> <span class="string">"connection-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>connection_changed<span class="symbol">),</span> NULL<span class="symbol">);</span>
<span class="symbol"><</span>a <span class="gtkdoc kwc">class</span><span class="symbol">=</span><span class="string">"link"</span> href<span class="symbol">=</span><span class="string">"GypsyDevice.html#gypsy-device-start"</span> title<span class="symbol">=</span><span class="string">"gypsy_device_start ()"</span><span class="symbol">></span>gypsy_device_start<span class="symbol"></</span>a<span class="symbol">> (</span>device<span class="symbol">, &</span>error<span class="symbol">);</span>
<span class="keyword">if</span> <span class="symbol">(</span>error <span class="symbol">!=</span> NULL<span class="symbol">) {</span>
<span class="function"><a href="/usr/share/gtk-doc/html/glib/glib-Message-Logging.html#g-warning">g_warning</a></span> <span class="symbol">(</span><span class="string">"Error starting GPS: %s"</span><span class="symbol">,</span> error<span class="symbol">-></span>message<span class="symbol">);</span>
<span class="function"><a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#g-error-free">g_error_free</a></span> <span class="symbol">(</span>error<span class="symbol">);</span>
<span class="symbol">}</span>
<span class="symbol">. . .</span>
<span class="gtkdoc kwb">static void</span> <span class="function">connection_changed</span> <span class="symbol">(</span>GypsyDevice <span class="symbol">*</span>device<span class="symbol">,</span> gboolean connected<span class="symbol">,</span> gpointer data<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">"Connection status: %s</span><span class="gtkdoc esc">\n</span><span class="string">"</span><span class="symbol">,</span> connected ? <span class="string">"Connected"</span> <span class="symbol">:</span> <span class="string">"Disconnected"</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="GypsyDevice.details"></a><h2>Details</h2>
<div class="refsect2" title="GypsyDevice">
<a name="GypsyDevice-struct"></a><h3>GypsyDevice</h3>
<pre class="programlisting">typedef struct _GypsyDevice GypsyDevice;</pre>
<p>
There are no public fields in <a class="link" href="GypsyDevice.html" title="GypsyDevice"><span class="type">GypsyDevice</span></a>.
</p>
</div>
<hr>
<div class="refsect2" title="GYPSY_DEVICE_DBUS_SERVICE">
<a name="GYPSY-DEVICE-DBUS-SERVICE:CAPS"></a><h3>GYPSY_DEVICE_DBUS_SERVICE</h3>
<pre class="programlisting">#define GYPSY_DEVICE_DBUS_SERVICE "org.freedesktop.Gypsy"
</pre>
<p>
A define containing the name of the Device service
</p>
</div>
<hr>
<div class="refsect2" title="GYPSY_DEVICE_DBUS_INTERFACE">
<a name="GYPSY-DEVICE-DBUS-INTERFACE:CAPS"></a><h3>GYPSY_DEVICE_DBUS_INTERFACE</h3>
<pre class="programlisting">#define GYPSY_DEVICE_DBUS_INTERFACE "org.freedesktop.Gypsy.Device"
</pre>
<p>
A define containing the name of the Device interface
</p>
</div>
<hr>
<div class="refsect2" title="enum GypsyDeviceFixStatus">
<a name="GypsyDeviceFixStatus"></a><h3>enum GypsyDeviceFixStatus</h3>
<pre class="programlisting">typedef enum {
GYPSY_DEVICE_FIX_STATUS_INVALID = 0,
GYPSY_DEVICE_FIX_STATUS_NONE,
GYPSY_DEVICE_FIX_STATUS_2D,
GYPSY_DEVICE_FIX_STATUS_3D
} GypsyDeviceFixStatus;
</pre>
<p>
An enumeration representing the various fix states that a GPS device can be in.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><a name="GYPSY-DEVICE-FIX-STATUS-INVALID:CAPS"></a><span class="term"><code class="literal">GYPSY_DEVICE_FIX_STATUS_INVALID</code></span></p></td>
<td>The fix is invalid
</td>
</tr>
<tr>
<td><p><a name="GYPSY-DEVICE-FIX-STATUS-NONE:CAPS"></a><span class="term"><code class="literal">GYPSY_DEVICE_FIX_STATUS_NONE</code></span></p></td>
<td>A fix has not yet been obtained
</td>
</tr>
<tr>
<td><p><a name="GYPSY-DEVICE-FIX-STATUS-2D:CAPS"></a><span class="term"><code class="literal">GYPSY_DEVICE_FIX_STATUS_2D</code></span></p></td>
<td>A fix with latitude and longitude has been obtained
</td>
</tr>
<tr>
<td><p><a name="GYPSY-DEVICE-FIX-STATUS-3D:CAPS"></a><span class="term"><code class="literal">GYPSY_DEVICE_FIX_STATUS_3D</code></span></p></td>
<td>A fix with latitude, longitude and altitude has been obtained
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="gypsy_device_new ()">
<a name="gypsy-device-new"></a><h3>gypsy_device_new ()</h3>
<pre class="programlisting"><a class="link" href="GypsyDevice.html" title="GypsyDevice"><span class="returnvalue">GypsyDevice</span></a> * gypsy_device_new (<em class="parameter"><code>const <span class="type">char</span> *object_path</code></em>);</pre>
<p>
Creates a new <a class="link" href="GypsyDevice.html" title="GypsyDevice"><span class="type">GypsyDevice</span></a> that points to <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 device
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> A pointer to a <a class="link" href="GypsyDevice.html" title="GypsyDevice"><span class="type">GypsyDevice</span></a>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="gypsy_device_get_connection_status ()">
<a name="gypsy-device-get-connection-status"></a><h3>gypsy_device_get_connection_status ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gypsy_device_get_connection_status (<em class="parameter"><code><a class="link" href="GypsyDevice.html" title="GypsyDevice"><span class="type">GypsyDevice</span></a> *device</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 connection status of <em class="parameter"><code>device</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>device</code></em> :</span></p></td>
<td>A <a class="link" href="GypsyDevice.html" title="GypsyDevice"><span class="type">GypsyDevice</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>A pointer to a <a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> to return an error in.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><span class="type">TRUE</span></a> if the device is connected, <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><span class="type">FALSE</span></a> otherwise.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="gypsy_device_get_fix_status ()">
<a name="gypsy-device-get-fix-status"></a><h3>gypsy_device_get_fix_status ()</h3>
<pre class="programlisting"><a class="link" href="GypsyDevice.html#GypsyDeviceFixStatus" title="enum GypsyDeviceFixStatus"><span class="returnvalue">GypsyDeviceFixStatus</span></a> gypsy_device_get_fix_status (<em class="parameter"><code><a class="link" href="GypsyDevice.html" title="GypsyDevice"><span class="type">GypsyDevice</span></a> *device</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 current fix status of <em class="parameter"><code>device</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>device</code></em> :</span></p></td>
<td>A <a class="link" href="GypsyDevice.html" title="GypsyDevice"><span class="type">GypsyDevice</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>A pointer to a <a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> to return a error in.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> A <a class="link" href="GypsyDevice.html#GypsyDeviceFixStatus" title="enum GypsyDeviceFixStatus"><span class="type">GypsyDeviceFixStatus</span></a>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="gypsy_device_set_start_options ()">
<a name="gypsy-device-set-start-options"></a><h3>gypsy_device_set_start_options ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gypsy_device_set_start_options (<em class="parameter"><code><a class="link" href="GypsyDevice.html" title="GypsyDevice"><span class="type">GypsyDevice</span></a> *device</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Hash-Tables.html#GHashTable"><span class="type">GHashTable</span></a> *options</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>
Sets options on the device before calling <a class="link" href="GypsyDevice.html#gypsy-device-start" title="gypsy_device_start ()"><span class="type">gypsy_device_start</span></a>.
The only valid option currently is "BaudRate", used for serial devices.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>device</code></em> :</span></p></td>
<td>
<a class="link" href="GypsyDevice.html" title="GypsyDevice"><span class="type">GypsyDevice</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>options</code></em> :</span></p></td>
<td>a <a href="/usr/share/gtk-doc/html/glib/glib-Hash-Tables.html#GHashTable"><span class="type">GHashTable</span></a> of string keys and <a href="/usr/share/gtk-doc/html/gobject/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> values
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>A pointer to a <a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> to return the error in
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><span class="type">TRUE</span></a> on success, <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><span class="type">FALSE</span></a> otherwise.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="gypsy_device_start ()">
<a name="gypsy-device-start"></a><h3>gypsy_device_start ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gypsy_device_start (<em class="parameter"><code><a class="link" href="GypsyDevice.html" title="GypsyDevice"><span class="type">GypsyDevice</span></a> *device</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>
Starts the connection to the physical device pointed to by <em class="parameter"><code>device</code></em>, and
listens for incoming messages.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>device</code></em> :</span></p></td>
<td>A <a class="link" href="GypsyDevice.html" title="GypsyDevice"><span class="type">GypsyDevice</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>A pointer to a <a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> to return the error in
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><span class="type">TRUE</span></a> on success, <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><span class="type">FALSE</span></a> otherwise.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="gypsy_device_stop ()">
<a name="gypsy-device-stop"></a><h3>gypsy_device_stop ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gypsy_device_stop (<em class="parameter"><code><a class="link" href="GypsyDevice.html" title="GypsyDevice"><span class="type">GypsyDevice</span></a> *device</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>
Stops the physical device pointed to by <em class="parameter"><code>device</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>device</code></em> :</span></p></td>
<td>A <a class="link" href="GypsyDevice.html" title="GypsyDevice"><span class="type">GypsyDevice</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>A pointer to a <a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> to return the error in
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><span class="type">TRUE</span></a> on success, <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><span class="type">FALSE</span></a> otherwise.
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1" title="Property Details">
<a name="GypsyDevice.property-details"></a><h2>Property Details</h2>
<div class="refsect2" title='The "object-path" property'>
<a name="GypsyDevice--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="GypsyDevice.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2" title='The "connection-changed" signal'>
<a name="GypsyDevice-connection-changed"></a><h3>The <code class="literal">"connection-changed"</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="GypsyDevice.html" title="GypsyDevice"><span class="type">GypsyDevice</span></a> *connected,
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</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 First / No Recursion</pre>
<p>
The ::connection-changed signal is emitted whenever the device
connection changes.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>connected</code></em> :</span></p></td>
<td>Whether or not the device is connected
</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>
<hr>
<div class="refsect2" title='The "fix-status-changed" signal'>
<a name="GypsyDevice-fix-status-changed"></a><h3>The <code class="literal">"fix-status-changed"</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="GypsyDevice.html" title="GypsyDevice"><span class="type">GypsyDevice</span></a> *fix_status,
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</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 First / No Recursion</pre>
<p>
The ::fix-status-changed signal is emitted whenever the GPS device
reports that its fix status has changed. <em class="parameter"><code>fix_status</code></em> is a
<a class="link" href="GypsyDevice.html#GypsyDeviceFixStatus" title="enum GypsyDeviceFixStatus"><span class="type">GypsyDeviceFixStatus</span></a>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>fix_status</code></em> :</span></p></td>
<td>The new fix status
</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>
|