explan_gps.h.xml 1.3 KB

12345678910111213141516171819202122232425262728293031323334353637383940
  1. <sect1 id="gps.h"><title><filename>gps.h</filename></title>
  2. <informaltable frame='all' pgwide='1'>
  3. <tgroup cols='2'>
  4. <colspec colname='c1'></colspec>
  5. <colspec colname='c2'></colspec>
  6. <spanspec spanname='s1' namest='c1' nameend='c2'></spanspec>
  7. <!-- Not documented: struct ais_t, struct rtcm3_t -->
  8. <thead>
  9. <row>
  10. <entry>Structures:-</entry><entry>The interface of the libgps library, provides data structures the library needs and that the daemon fills.</entry>
  11. </row>
  12. </thead>
  13. <tfoot>
  14. <row>
  15. <entry spanname='s1' align='left'>Notes based on code as of Mon Apr 5 21:38:06 2010 -0400</entry>
  16. </row>
  17. </tfoot>
  18. <tbody>
  19. <row>
  20. <entry><function>struct gps_fix_t {}</function></entry>
  21. <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>
  22. </row>
  23. <row>
  24. <entry><function>struct rtcm2_t {}</function></entry>
  25. <entry><para>This holds the data being processed by the rtcm functions.</para></entry>
  26. </row>
  27. <row>
  28. <entry><function>struct gps_data_t {}</function></entry>
  29. <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>
  30. </row>
  31. </tbody>
  32. </tgroup>
  33. </informaltable>
  34. </sect1>