pud: fix angle averaging
[olsrd.git] / lib / pud / src / posAvg.h
1 #ifndef _PUD_POSAVG_H_
2 #define _PUD_POSAVG_H_
3
4 /* Plugin includes */
5
6 /* OLSR includes */
7
8 /* System includes */
9 #include <nmea/info.h>
10 #include <stdbool.h>
11
12 /** Stores angle components */
13 typedef struct _AngleComponents {
14                 double x; /**< cos of the angle (in radians) */
15                 double y; /**< sin of the angle (in radians) */
16 } AngleComponents;
17
18 /** Stores an nmeaINFO entry, used in the averaging */
19 typedef struct _PositionUpdateEntry {
20                 nmeaINFO nmeaInfo; /**< the position information */
21
22                 /* used for averaging of angles */
23                 AngleComponents track; /**< the track angle components */
24                 AngleComponents mtrack; /**< the mtrack angle components */
25                 AngleComponents magvar; /**< the magvar angle components */
26 } PositionUpdateEntry;
27
28 /**
29  Counts the number of GPxxx based entries. Some parameters in nmeaINFO are
30  dependent on different GPxxx NMEA sentences. These counters are used to
31  determine which information would be valid for the average position.
32  Also counts the fix values.
33  */
34 typedef struct _PositionUpdateCounters {
35                 /* present */
36                 unsigned long long smask; /**< the number of entries with SMASK present */
37                 unsigned long long utcdate; /**< the number of entries with UTCDATE present */
38                 unsigned long long utctime; /**< the number of entries with UTCTIME present */
39                 unsigned long long sig; /**< the number of entries with SIG present */
40                 unsigned long long fix; /**< the number of entries with FIX present */
41                 unsigned long long pdop; /**< the number of entries with PDOP present */
42                 unsigned long long hdop; /**< the number of entries with HDOP present */
43                 unsigned long long vdop; /**< the number of entries with VDOP present */
44                 unsigned long long lat; /**< the number of entries with LAT present */
45                 unsigned long long lon; /**< the number of entries with LON present */
46                 unsigned long long elv; /**< the number of entries with ELV present */
47                 unsigned long long speed; /**< the number of entries with SPEED present */
48                 unsigned long long track; /**< the number of entries with TRACK present */
49                 unsigned long long mtrack; /**< the number of entries with MTRACK present */
50                 unsigned long long magvar; /**< the number of entries with MAGVAR present */
51                 unsigned long long satinusecount; /**< the number of entries with SATINUSECOUNT present */
52                 unsigned long long satinuse; /**< the number of entries with SATINUSE present */
53                 unsigned long long satinview; /**< the number of entries with SATINVIEW present */
54
55                 /* smask */
56                 unsigned long long gpgga; /**< the number of GPGGA based entries */
57                 unsigned long long gpgsa; /**< the number of GPGSA based entries */
58                 unsigned long long gpgsv; /**< the number of GPGSV based entries */
59                 unsigned long long gprmc; /**< the number of GPRMC based entries */
60                 unsigned long long gpvtg; /**< the number of GPVTG based entries */
61
62                 /* sig */
63                 unsigned long long sigBad; /**< the number of entries with a bad sig */
64                 unsigned long long sigLow; /**< the number of entries with a low sig */
65                 unsigned long long sigMid; /**< the number of entries with a mid sig */
66                 unsigned long long sigHigh; /**< the number of entries with a high sig */
67
68                 /* fix */
69                 unsigned long long fixBad; /**< the number of entries with a bad fix */
70                 unsigned long long fix2d; /**< the number of entries with a 2D fix */
71                 unsigned long long fix3d; /**< the number of entries with a 3D fix */
72 } PositionUpdateCounters;
73
74 /**
75  A list of position updates that are used to determine the average position.
76
77  The list uses 1 extra entry: when 5 entries have to be averaged then the list
78  will have 6 entries. The 6th entry is used for the incoming entry, so that
79  it is already in the list (together with the old entry that will be removed
80  from the average) and does not need to be copied into the list. This is for
81  better performance.
82
83  The list is a circular list.
84  This means that there is a gap/unused entry in the list between the
85  newest entry and the oldest entry, which is the 'incoming entry'.
86
87  Note that 'positionAverageCumulative' stores cumulative values for parameters
88  for which an average is calculated. The reason is to minimise the number of
89  calculations to be performed.
90  */
91 typedef struct _PositionAverageList {
92                 unsigned long long entriesMaxCount; /**< the maximum number of entries in the list */
93                 PositionUpdateEntry * entries; /**< the list entries */
94
95                 unsigned long long entriesCount; /**< the number of entries in the list */
96                 unsigned long long newestEntryIndex; /**< index of the newest entry in the list (zero-based) */
97                 PositionUpdateCounters counters; /**< the counters */
98
99                 PositionUpdateEntry positionAverageCumulative; /**< the average position with cumulative values */
100                 PositionUpdateEntry positionAverage; /**< the average position */
101 } PositionAverageList;
102
103 /**
104  Enumeration describing the type of an entry position in the average list
105  */
106 typedef enum _AverageEntryPositionType {
107         OLDEST, NEWEST, INCOMING, AVERAGECUMULATIVE, AVERAGE
108 } AverageEntryPositionType;
109
110 bool initPositionAverageList(PositionAverageList * positionAverageList,
111                 unsigned long long maxEntries);
112 void flushPositionAverageList(PositionAverageList * positionAverageList);
113 void destroyPositionAverageList(PositionAverageList * positionAverageList);
114
115 PositionUpdateEntry * getPositionAverageEntry(
116                 PositionAverageList * positionAverageList,
117                 AverageEntryPositionType positionType);
118
119 void addNewPositionToAverage(PositionAverageList * positionAverageList,
120                 PositionUpdateEntry * newEntry);
121
122 #endif /* _PUD_POSAVG_H_ */