diff options
Diffstat (limited to 'docs/reference/html/GypsySatellite.html')
| -rw-r--r-- | docs/reference/html/GypsySatellite.html | 129 |
1 files changed, 93 insertions, 36 deletions
diff --git a/docs/reference/html/GypsySatellite.html b/docs/reference/html/GypsySatellite.html index 52c8f23..c7a22ef 100644 --- a/docs/reference/html/GypsySatellite.html +++ b/docs/reference/html/GypsySatellite.html @@ -5,37 +5,45 @@ <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="ch01.html" title="Gyspy"> +<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="chapter" href="ch01.html" title="Gyspy"> +<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="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></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> </td> +<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="#id2581596" class="shortcut">Top</a> +<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2561647" class="shortcut">Top</a>  |  - <a href="#id2579242" class="shortcut">Description</a> + <a href="#id2568401" class="shortcut">Description</a>  |  - <a href="#id2579164" class="shortcut">Object Hierarchy</a> + <a href="#id2568322" class="shortcut">Object Hierarchy</a>  |  - <a href="#id2579188" class="shortcut">Properties</a> + <a href="#id2568346" class="shortcut">Properties</a>  |  - <a href="#id2579218" class="shortcut">Signals</a></nobr></td></tr> + <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="id2581596"></a><span class="refentrytitle">GypsySatellite</span> +<a name="id2561647"></a><span class="refentrytitle">GypsySatellite</span> </h2> <p>GypsySatellite — Object for obtaining satellite information</p> </td> @@ -61,7 +69,7 @@ void <a href="GypsySatellite.html#gypsy-satellite-free-satellite- </pre> </div> <div class="refsect1" lang="en"> -<a name="id2579164"></a><h2>Object Hierarchy</h2> +<a name="id2568322"></a><h2>Object Hierarchy</h2> <pre class="synopsis"> GObject @@ -69,34 +77,83 @@ void <a href="GypsySatellite.html#gypsy-satellite-free-satellite- </pre> </div> <div class="refsect1" lang="en"> -<a name="id2579188"></a><h2>Properties</h2> +<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="id2579218"></a><h2>Signals</h2> +<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="id2579242"></a><h2>Description</h2> +<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.</p> +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="id2569352"></a><h2>Details</h2> +<a name="id2597278"></a><h2>Details</h2> <div class="refsect2" lang="en"> -<a name="id2569363"></a><h3> +<a name="id2560339"></a><h3> <a name="GypsySatellite-struct"></a>GypsySatellite</h3> -<a class="indexterm" name="id2569374"></a><pre class="programlisting">typedef struct _GypsySatellite GypsySatellite;</pre> +<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> @@ -105,9 +162,9 @@ There are no public fields in <a href="GypsySatellite.html" title="GypsySatellit </div> <hr> <div class="refsect2" lang="en"> -<a name="id2569402"></a><h3> +<a name="id2599941"></a><h3> <a name="GYPSY-SATELLITE-DBUS-INTERFACE:CAPS"></a>GYPSY_SATELLITE_DBUS_INTERFACE</h3> -<a class="indexterm" name="id2569413"></a><pre class="programlisting">#define GYPSY_SATELLITE_DBUS_INTERFACE "org.freedesktop.Gypsy.Satellite" +<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> @@ -117,9 +174,9 @@ A define containing the name of the Satellite interface</p> </div> <hr> <div class="refsect2" lang="en"> -<a name="id2569434"></a><h3> +<a name="id2604728"></a><h3> <a name="GYPSY-SATELLITE-DBUS-SERVICE:CAPS"></a>GYPSY_SATELLITE_DBUS_SERVICE</h3> -<a class="indexterm" name="id2569447"></a><pre class="programlisting">#define GYPSY_SATELLITE_DBUS_SERVICE "org.freedesktop.Gypsy" +<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> @@ -129,9 +186,9 @@ A define containing the address of the Satellite service.</p> </div> <hr> <div class="refsect2" lang="en"> -<a name="id2569468"></a><h3> +<a name="id2604763"></a><h3> <a name="GypsySatelliteDetails"></a>GypsySatelliteDetails</h3> -<a class="indexterm" name="id2569480"></a><pre class="programlisting">typedef struct { +<a class="indexterm" name="id2604774"></a><pre class="programlisting">typedef struct { int satellite_id; gboolean in_use; guint elevation; @@ -177,9 +234,9 @@ A structure defining a satellite</p> </div> <hr> <div class="refsect2" lang="en"> -<a name="id2594435"></a><h3> +<a name="id2604904"></a><h3> <a name="gypsy-satellite-new"></a>gypsy_satellite_new ()</h3> -<a class="indexterm" name="id2594448"></a><pre class="programlisting"><a href="GypsySatellite.html" title="GypsySatellite">GypsySatellite</a>* gypsy_satellite_new (const char *object_path);</pre> +<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> @@ -204,9 +261,9 @@ from the GPS found at <em class="parameter"><code>object_path</code></em>.</p> </div> <hr> <div class="refsect2" lang="en"> -<a name="id2594530"></a><h3> +<a name="id2603957"></a><h3> <a name="gypsy-satellite-get-satellites"></a>gypsy_satellite_get_satellites ()</h3> -<a class="indexterm" name="id2594543"></a><pre class="programlisting">GPtrArray* gypsy_satellite_get_satellites (<a href="GypsySatellite.html" title="GypsySatellite">GypsySatellite</a> *satellite, +<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 @@ -238,9 +295,9 @@ Should be freed using <a href="GypsySatellite.html#gypsy-satellite-free-satellit </div> <hr> <div class="refsect2" lang="en"> -<a name="id2561055"></a><h3> +<a name="id2604106"></a><h3> <a name="gypsy-satellite-free-satellite-array"></a>gypsy_satellite_free_satellite_array ()</h3> -<a class="indexterm" name="id2561068"></a><pre class="programlisting">void gypsy_satellite_free_satellite_array +<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> @@ -258,21 +315,21 @@ Frees all resources used in the array.</p> </div> </div> <div class="refsect1" lang="en"> -<a name="id2561135"></a><h2>Property Details</h2> +<a name="id2604186"></a><h2>Property Details</h2> <div class="refsect2" lang="en"> -<a name="id2561146"></a><h3> +<a name="id2606733"></a><h3> <a name="GypsySatellite--object-path"></a>The "<code class="literal">object-path</code>" property</h3> -<a class="indexterm" name="id2561160"></a><pre class="programlisting"> "object-path" gchararray : Write / Construct Only</pre> +<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="id2561188"></a><h2>Signal Details</h2> +<a name="id2606770"></a><h2>Signal Details</h2> <div class="refsect2" lang="en"> -<a name="id2561198"></a><h3> +<a name="id2606779"></a><h3> <a name="GypsySatellite-satellites-changed"></a>The "satellites-changed" signal</h3> -<a class="indexterm" name="id2561208"></a><pre class="programlisting">void user_function (<a href="GypsySatellite.html" title="GypsySatellite">GypsySatellite</a> *satellites, +<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> |