summaryrefslogtreecommitdiff
path: root/docs/reference/html/Position.html
blob: 126002ff1c4366bc42be37cc6f57c6402653c92b (plain)
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
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>org.freedesktop.Gypsy.Position</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="gypsy-client-interfaces.html" title="Gypsy Client Interface">
<link rel="prev" href="Device.html" title="org.freedesktop.Gypsy.Device">
<link rel="next" href="Satellite.html" title="org.freedesktop.Gypsy.Satellite">
<meta name="generator" content="GTK-Doc V1.11 (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="Device.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="gypsy-client-interfaces.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="Satellite.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#Position.synopsis" class="shortcut">Top</a>
                 | 
                <a href="#Position.description" class="shortcut">Description</a>
                 | 
                <a href="#Position.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
                 | 
                <a href="#Position.properties" class="shortcut">Properties</a>
                 | 
                <a href="#Position.signals" class="shortcut">Signals</a>
</td></tr>
</table>
<div class="refentry" title="org.freedesktop.Gypsy.Position">
<a name="Position"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle">org.freedesktop.Gypsy.Position</span></h2>
<p>org.freedesktop.Gypsy.Position — Position interface</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv" title="Methods">
<h2>Methods</h2>
<pre class="synopsis"><a
href="/usr/share/gtk-doc/html/gypsy/Position.html#Position.GetPosition"
>GetPosition</a> (out 'i'fields,
             out 'i'timestamp,
             out 'd'latitude,
             out 'd'longitude,
             out 'd'altitude)
</pre>
</div>
<div class="refsect1" title="Signals">
<a name="id564629"></a><h2>Signals</h2>
<pre class="synopsis"><a
href="/usr/share/gtk-doc/html/gypsy/Position.html#Position::PositionChanged"
>PositionChanged</a> ('i'fields,
                 'i'timestamp,
                 'd'latitude,
                 'd'longitude,
                 'd'altitude)
</pre>
</div>
<div class="refsect1" title="Implemented Interfaces">
<a name="id564650"></a><h2>Implemented Interfaces</h2>
<p>org.freedesktop.Gypsy.Position implements
    org.freedesktop.DBus.Introspectable,
    org.freedesktop.DBus.Properties
    </p>
</div>
<div class="refsect1" title="Properties">
<a name="id564667"></a><h2>Properties</h2>
<pre class="synopsis"></pre>
</div>
<div class="refsect1" title="Description">
<a name="id564682"></a><h2>Description</h2>
<p>
      </p>
<p>
        Position objects are used to obtain the current position (longitude,
        latitude, altitude) of the GPS.  The current position can be obtained
        with <a
href="/usr/share/gtk-doc/html/gypsy/Position.html#Position.GetPosition"
><code class="function">GetPosition()</code></a>, and <a
href="/usr/share/gtk-doc/html/gypsy/Position.html#Position::PositionChanged"
><code class="literal">PositionChanged</code></a>
        signals are emitted when the position changes.
      </p>
<p>
    </p>
</div>
<div class="refsect1" title="Details">
<a name="id564716"></a><h2>Details</h2>
<div class="refsect2" title="GetPosition ()">
<a name="id564727"></a><h3>
<a name="Position.GetPosition"></a>GetPosition ()</h3>
<pre class="programlisting">GetPosition (out 'i' fields,
             out 'i' timestamp,
             out 'd' latitude,
             out 'd' longitude,
             out 'd' altitude)</pre>
<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><p>Bitfield specifying what fields are set.  1: None, 2:
          Longitude, 4: Latitude, 8: Altitude.</p></td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>timestamp</code></em>:</span></p></td>
<td><p>The timestamp that this position was
          determined.</p></td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>latitude</code></em>:</span></p></td>
<td><p>The latitude in fractional degrees.</p></td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>longitude</code></em>:</span></p></td>
<td><p>The longitude in fractional degrees.</p></td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>altitude</code></em>:</span></p></td>
<td><p>The altitude in metres.</p></td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1" title="Signal Details">
<a name="id554494"></a><h2>Signal Details</h2>
<div class="refsect2" title="The PositionChanged signal">
<a name="id554504"></a><h3>
<a name="Position::PositionChanged"></a>The PositionChanged signal</h3>
<pre class="programlisting">PositionChanged ('i' fields,
                 'i' timestamp,
                 'd' latitude,
                 'd' longitude,
                 'd' altitude)</pre>
<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>Bitfield specifying what fields are set.  1: None, 2:
          Longitude, 4: Latitude, 8: Altitude.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>timestamp</code></em>:</span></p></td>
<td>The timestamp that this position was determined.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>latitude</code></em>:</span></p></td>
<td>The latitude in fractional degrees.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>longitude</code></em>:</span></p></td>
<td>The longitude in fractional degrees.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>altitude</code></em>:</span></p></td>
<td>The altitude in metres.</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1" title="Property Details">
<a name="id554628"></a><h2>Property Details</h2>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.11</div>
</body>
</html>