summaryrefslogtreecommitdiff
path: root/doc/explan_gps.h.xml
blob: 8bebee9c45213867152ec1330a4c306be8c7673c (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
<sect1 id="gps.h"><title><filename>gps.h</filename></title>
<informaltable frame='all' pgwide='1'>
<tgroup cols='2'>
<colspec colname='c1'></colspec>
<colspec colname='c2'></colspec>
<spanspec spanname='s1' namest='c1' nameend='c2'></spanspec>

<!-- Not documented: struct ais_t, struct rtcm3_t -->

<thead>
<row>
  <entry>Structures:-</entry><entry>The interface of the libgps library, provides data structures the library needs and that the daemon fills.</entry>
</row>
</thead>

<tfoot>
<row>
  <entry spanname='s1' align='left'>Notes based on code as of Mon Apr 5 21:38:06 2010 -0400</entry>
</row>
</tfoot>

<tbody>
<row>
  <entry><function>struct gps_fix_t {}</function></entry>
  <entry><para>This is the fix related data gathered from the gps device. Each client session has 2, the current fix and the previous fix.</para></entry>
</row>
<row>
  <entry><function>struct rtcm2_t {}</function></entry>
  <entry><para>This holds the data being processed by the rtcm functions.</para></entry>
</row>
<row>
  <entry><function>struct gps_data_t {}</function></entry>
  <entry><para>This contains ALL the data available from the daemon; the actual fix, status flags, headings etc. Basically any good stuff that we might want goes here.</para></entry>
</row>
</tbody>

</tgroup>
</informaltable>
</sect1>