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
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>GypsyTime</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="GypsySatellite.html" title="GypsySatellite">
<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="GypsySatellite.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> </td>
</tr>
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2566220" class="shortcut">Top</a>
 | 
<a href="#id2565431" class="shortcut">Description</a></nobr></td></tr>
</table>
<div class="refentry" lang="en">
<a name="gypsy-GypsyTime"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2>
<a name="id2566220"></a><span class="refentrytitle">GypsyTime</span>
</h2>
<p>GypsyTime — Object for obtaining GPS time from gypsy-daemon</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<h2>Synopsis</h2>
<pre class="synopsis">
<a href="gypsy-GypsyTime.html#GypsyTime">GypsyTime</a>;
#define <a href="gypsy-GypsyTime.html#GYPSY-TIME-DBUS-SERVICE:CAPS">GYPSY_TIME_DBUS_SERVICE</a>
#define <a href="gypsy-GypsyTime.html#GYPSY-TIME-DBUS-INTERFACE:CAPS">GYPSY_TIME_DBUS_INTERFACE</a>
<a href="gypsy-GypsyTime.html#GypsyTime">GypsyTime</a>* <a href="gypsy-GypsyTime.html#gypsy-time-new">gypsy_time_new</a> (const char *object_path);
gboolean <a href="gypsy-GypsyTime.html#gypsy-time-get-time">gypsy_time_get_time</a> (<a href="gypsy-GypsyTime.html#GypsyTime">GypsyTime</a> *gps_time,
int *timestamp,
GError **error);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2565431"></a><h2>Description</h2>
<p>
<a href="gypsy-GypsyTime.html#GypsyTime"><span class="type">GypsyTime</span></a> is used whenever the client program wishes to know about
GPS time changes. It can report the current GPS time, and has a signal
to notify listeners of changes.
</p>
<p>
A <a href="gypsy-GypsyTime.html#GypsyTime"><span class="type">GypsyTime</span></a> object is created with <a href="gypsy-GypsyTime.html#gypsy-time-new"><code class="function">gypsy_time_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
GPS time with <a href="gypsy-GypsyTime.html#gypsy-time-get-time"><code class="function">gypsy_time_get_time()</code></a>.
</p>
<p>
As the GPS time information changes <a href="gypsy-GypsyTime.html#GypsyTime"><span class="type">GypsyTime</span></a> will emit the
time-changed signal. This signal contains the GPS time of the most recent
GPS update that it received.
</p>
<p>
</p>
<div class="informalexample"><pre class="programlisting">
GypsyTime *gps_time;
GError *error = NULL;
. . .
/* path comes from the gypsy_control_create() function */
gps_time = gypsy_time_new (path);
g_signal_connect (gps_time, "time-changed", G_CALLBACK (time_changed), NULL);
. . .
static void position_changed (GypsyTime *gps_time,
int timestamp,
gpointer userdata)
{
  g_print ("timestamp: %d\n", timestamp);
}
</pre></div>
<p>
</p>
</div>
<div class="refsect1" lang="en">
<a name="id2565535"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id2565546"></a><h3>
<a name="GypsyTime"></a>GypsyTime</h3>
<a class="indexterm" name="id2565558"></a><pre class="programlisting">typedef struct {
GObject parent_object;
} GypsyTime;
</pre>
<p>
There are no public fields in <a href="gypsy-GypsyTime.html#GypsyTime"><span class="type">GypsyTime</span></a>.</p>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2580464"></a><h3>
<a name="GYPSY-TIME-DBUS-SERVICE:CAPS"></a>GYPSY_TIME_DBUS_SERVICE</h3>
<a class="indexterm" name="id2580476"></a><pre class="programlisting">#define GYPSY_TIME_DBUS_SERVICE "org.freedesktop.Gypsy"
</pre>
<p>
A define containing the address of the Time service</p>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2580496"></a><h3>
<a name="GYPSY-TIME-DBUS-INTERFACE:CAPS"></a>GYPSY_TIME_DBUS_INTERFACE</h3>
<a class="indexterm" name="id2580507"></a><pre class="programlisting">#define GYPSY_TIME_DBUS_INTERFACE "org.freedesktop.Gypsy.Time"
</pre>
<p>
A define containing the name of the Time interface</p>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2580528"></a><h3>
<a name="gypsy-time-new"></a>gypsy_time_new ()</h3>
<a class="indexterm" name="id2580540"></a><pre class="programlisting"><a href="gypsy-GypsyTime.html#GypsyTime">GypsyTime</a>* gypsy_time_new (const char *object_path);</pre>
<p>
Creates a new <a href="gypsy-GypsyTime.html#GypsyTime"><span class="type">GypsyTime</span></a> object that listens for time 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="gypsy-GypsyTime.html#GypsyTime"><span class="type">GypsyTime</span></a> object
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2509827"></a><h3>
<a name="gypsy-time-get-time"></a>gypsy_time_get_time ()</h3>
<a class="indexterm" name="id2509840"></a><pre class="programlisting">gboolean gypsy_time_get_time (<a href="gypsy-GypsyTime.html#GypsyTime">GypsyTime</a> *gps_time,
int *timestamp,
GError **error);</pre>
<p>
Obtains the current time, if known, from the GPS device.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>gps_time</code></em> :</span></td>
<td> A <a href="gypsy-GypsyTime.html#GypsyTime"><span class="type">GypsyTime</span></a>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>timestamp</code></em> :</span></td>
<td> Pointer to store the timestamp
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>error</code></em> :</span></td>
<td> Pointer to store a <span class="type">GError</span>
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> TRUE on success, FALSE on error.
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
</body>
</html>
|
