Devuan fork of gpsd
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 

84 lines
3.2 KiB

  1. <?xml version="1.0" encoding="ISO-8859-1"?>
  2. <!--
  3. This file is Copyright (c) 2010 by the GPSD project
  4. SPDX-License-Identifier: BSD-2-clause
  5. -->
  6. <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
  7. "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
  8. <refentry>
  9. <refentryinfo><date>13 May 2005</date></refentryinfo>
  10. <refmeta>
  11. <refentrytitle>libgpsmm</refentrytitle>
  12. <manvolnum>3</manvolnum>
  13. <refmiscinfo class="source">The GPSD Project</refmiscinfo>
  14. <refmiscinfo class="manual">GPSD Documentation</refmiscinfo>
  15. </refmeta>
  16. <refnamediv id='name'>
  17. <refname>libgpsmm</refname>
  18. <refname>libQgpsmm</refname>
  19. <refpurpose>C++ and QT class wrapper for the GPS daemon</refpurpose>
  20. </refnamediv>
  21. <refsynopsisdiv id='synopsis'>
  22. <funcsynopsis>
  23. <funcsynopsisinfo>
  24. C++:
  25. #include &lt;libgpsmm&gt;
  26. </funcsynopsisinfo>
  27. <funcprototype>
  28. <funcdef>struct gps_data_t *<function>open</function></funcdef>
  29. <paramdef>char *<parameter>host</parameter></paramdef>
  30. <paramdef>char *<parameter>port</parameter></paramdef>
  31. </funcprototype>
  32. <funcprototype>
  33. <funcdef>struct gps_data_t *<function>open</function></funcdef>
  34. <paramdef>void</paramdef>
  35. </funcprototype>
  36. <funcprototype>
  37. <funcdef>struct gps_data_t *<function>send</function></funcdef>
  38. <paramdef>char *<parameter>request</parameter></paramdef>
  39. </funcprototype>
  40. <funcprototype>
  41. <funcdef>struct gps_data_t *<function>read</function></funcdef>
  42. <paramdef>void</paramdef>
  43. </funcprototype>
  44. <funcprototype>
  45. <funcdef>struct gps_data_t *<function>waiting</function></funcdef>
  46. <paramdef>int</paramdef>
  47. </funcprototype>
  48. <funcprototype>
  49. <funcdef>struct gps_data_t *<function>stream</function></funcdef>
  50. <paramdef>unsigned int<parameter>flags</parameter></paramdef>
  51. </funcprototype>
  52. </funcsynopsis>
  53. </refsynopsisdiv>
  54. <refsect1 id='description'><title>DESCRIPTION</title>
  55. <para><emphasis remap='B'>libgpsmm and libQgpsmm</emphasis> are mere wrappers over
  56. <emphasis remap='B'>libgps</emphasis>. The important difference between the libraries is that libgpsmm is targeted at C++ applications and contained in <emphasis remap='B'>libgps</emphasis>, while libQgpsmm is platform independent by using QTcpSocket to connect to <emphasis remap='B'>gpsd</emphasis> and shipped as an additional library due to the necessary linking to QT.
  57. Method names are the same as
  58. the analogue C functions. For a detailed description of the functions
  59. please read
  60. <citerefentry><refentrytitle>libgps</refentrytitle><manvolnum>3</manvolnum></citerefentry>.
  61. <function>open()</function> must be called after class constructor and before any other method
  62. (<function>open()</function> is not inside the constructor since it may fail, however constructors have no return value).
  63. The analogue of the C function <function>gps_close()</function> is in the destructor.</para>
  64. </refsect1>
  65. <refsect1 id='see_also'><title>SEE ALSO</title>
  66. <para>
  67. <citerefentry><refentrytitle>gpsd</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
  68. <citerefentry><refentrytitle>gps</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
  69. <citerefentry><refentrytitle>libgps</refentrytitle><manvolnum>3</manvolnum></citerefentry>.
  70. </para>
  71. </refsect1>
  72. <refsect1 id='author'><title>AUTHOR</title>
  73. <para>Alfredo Pironti &lt;alfredio@users.sourceforge.net&gt;.</para>
  74. </refsect1>
  75. </refentry>