PUD: include nmealib v0.6.7
[olsrd.git] / lib / pud / nmealib / include / nmea / generator.h
1 /*
2  * This file is part of nmealib.
3  *
4  * Copyright (c) 2008 Timur Sinitsyn
5  * Copyright (c) 2011 Ferry Huberts
6  *
7  * This library is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU Lesser General Public
9  * License as published by the Free Software Foundation; either
10  * version 2.1 of the License, or (at your option) any later version.
11  *
12  * This library is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15  * Lesser General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program. If not, see <http://www.gnu.org/licenses/>.
19  */
20
21 #ifndef __NMEA_GENERATOR_H__
22 #define __NMEA_GENERATOR_H__
23
24 #include <nmea/info.h>
25
26 #ifdef  __cplusplus
27 extern "C" {
28 #endif
29
30 /*
31  * high level
32  */
33
34 struct _nmeaGENERATOR;
35
36 enum nmeaGENTYPE
37 {
38     NMEA_GEN_NOISE = 0,
39     NMEA_GEN_STATIC,
40     NMEA_GEN_ROTATE,
41
42     NMEA_GEN_SAT_STATIC,
43     NMEA_GEN_SAT_ROTATE,
44     NMEA_GEN_POS_RANDMOVE,
45
46     NMEA_GEN_LAST
47 };
48
49 struct _nmeaGENERATOR * nmea_create_generator(int type, nmeaINFO *info);
50 void    nmea_destroy_generator(struct _nmeaGENERATOR *gen);
51
52 int     nmea_generate_from(
53         char *buff, int buff_sz,    /* buffer */
54         nmeaINFO *info,             /* source info */
55         struct _nmeaGENERATOR *gen, /* generator */
56         int generate_mask           /* mask of sentence`s (e.g. GPGGA | GPGSA) */
57         );
58
59 /*
60  * low level
61  */
62
63 typedef int (*nmeaNMEA_GEN_INIT)(struct _nmeaGENERATOR *gen, nmeaINFO *info);
64 typedef int (*nmeaNMEA_GEN_LOOP)(struct _nmeaGENERATOR *gen, nmeaINFO *info);
65 typedef int (*nmeaNMEA_GEN_RESET)(struct _nmeaGENERATOR *gen, nmeaINFO *info);
66 typedef int (*nmeaNMEA_GEN_DESTROY)(struct _nmeaGENERATOR *gen);
67
68 typedef struct _nmeaGENERATOR
69 {
70     void                *gen_data;
71     nmeaNMEA_GEN_INIT    init_call;
72     nmeaNMEA_GEN_LOOP    loop_call;
73     nmeaNMEA_GEN_RESET   reset_call;
74     nmeaNMEA_GEN_DESTROY destroy_call;
75     struct _nmeaGENERATOR *next;
76
77 } nmeaGENERATOR;
78
79 int     nmea_gen_init(nmeaGENERATOR *gen, nmeaINFO *info);
80 int     nmea_gen_loop(nmeaGENERATOR *gen, nmeaINFO *info);
81 int     nmea_gen_reset(nmeaGENERATOR *gen, nmeaINFO *info);
82 void    nmea_gen_destroy(nmeaGENERATOR *gen);
83 void    nmea_gen_add(nmeaGENERATOR *to, nmeaGENERATOR *gen);
84
85 #ifdef  __cplusplus
86 }
87 #endif
88
89 #endif /* __NMEA_GENERATOR_H__ */