summaryrefslogtreecommitdiff
path: root/libgpsmm.3
blob: f62b7546f38ea4c2c4f409d637f62f4e2ebad700 (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
.\"Generated by db2man.xsl. Don't modify this, modify the source.
.de Sh \" Subsection
.br
.if t .Sp
.ne 5
.PP
\fB\\$1\fR
.PP
..
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Ip \" List item
.br
.ie \\n(.$>=3 .ne \\$3
.el .ne 3
.IP "\\$1" \\$2
..
.TH "LIBGPSMM" 3 "13 May 2005" "" ""
.SH NAME
libgpsmm \- C++ class wrapper for the GPS daemon
.SH "SYNOPSIS"
.ad l
.hy 0



C++:

#include <libgpsmm>


.sp
.HP 26
struct\ gps_data_t\ *\fBopen\fR\ (char\ *\fIhost\fR, char\ *\fIport\fR);
.HP 26
struct\ gps_data_t\ *\fBopen\fR\ (void);
.HP 27
struct\ gps_data_t\ *\fBquery\fR\ (char\ *\fIrequest\fR);
.HP 26
struct\ gps_data_t\ *\fBpoll\fR\ (void);
.HP 18
int\ \fBset_callback\fR\ (void\ (*\fIhook\fR)(struct\ gps_data_t\ *sentence,\ char\ *buf));
.HP 18
int\ \fBdel_callback\fR\ (void);
.ad
.hy

.SH "DESCRIPTION"

.PP
libgpsmm is a mere wrapper over libgps\&. Method names are the same as the analogue C functions\&. For a detailed description of the functions please read \fBlibgps\fR(3)\&. \fBopen()\fR must be called after class constructor and before any other method (\fBopen()\fR is not inside the constructor since it may fail, however constructors have no return value)\&. The analogue of the C function \fBgps_close()\fR is in the destructor\&.

.SH "SEE ALSO"

.PP
 \fBgpsd\fR(8), \fBxgps\fR(1), \fBlibgps\fR(3)\&.

.SH "AUTHOR"

.PP
Alfredo Pironti <alfredio@users\&.sourceforge\&.net>\&.