summaryrefslogtreecommitdiff
path: root/doc/explan_gpsdclient.c.xml
blob: 4825fd3d2fb7b2fcf6bc27c63248c8af21beea1b (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
<sect1 id="libgps.c"><title><filename>libgps.c</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>

<thead>
<row>
  <entry>Functions:-</entry><entry>The client interface library for the <application>gpsd</application> daemon.</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>char *deg_to_str(enum deg_str_type type, double f)</function>
  </entry>
  <entry>
    <para>Convert the absolute value of double degrees to a static string
    and return a pointer to it.</para>
    <para>Makes a simple check on invalid degree values (not more
    than 360) and returns "nan" on error.</para>
    <para>For valid values, it generates the appropriate string according
    to the string type enumeration: dd, ddmm or ddmmss.</para>
    <para>Warning: not thread safe.</para>
  </entry>
</row>
<row>
  <entry>
    <function>char *deg_to_str2(enum deg_str_type type, double f, char *buf,
    unsigned int buf_size, const char *suffix_pos, const char *suffix_neg)
    </function>
  </entry>
  <entry>
    <para>Convert the absolute value of double degrees to a string
    and place in the buffer "buf".  Return a pointer to the buffer.
    "buf_size" is the size of the buffer.</para>
    <para>Makes a simple check on invalid degree values (not more
    than 360) and returns "nan" on error.</para>
    <para>For valid values, it generates the appropriate string according
    to the string type enumeration: dd, ddmm or ddmmss.  If the
    degrees are positive, append "suffix_pos", else append "suffix_neg".
    </para>
  </entry>
</row>
<row>
  <entry><function>enum unit gpsd_units(void)</function></entry>
  <entry><para>Simple check of the environment to determine what units are required. If all else fails, use compiled in units.</para></entry>
</row>
</tbody>

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