PUD: cleanup includes
[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 an nmeaINFO entry, used in the averaging */
13 typedef struct _PositionUpdateEntry {
14                 nmeaINFO nmeaInfo; /**< the position information */
15 } PositionUpdateEntry;
16
17 /**
18  Counts the number of GPxxx based entries. Some parameters in nmeaINFO are
19  dependent on different GPxxx NMEA sentences. These counters are used to
20  determine which information would be valid for the average position.
21  Also counts the fix values.
22  */
23 typedef struct _PositionUpdateCounters {
24                 /* smask */
25                 unsigned long long gpgga; /**< the number of GPGGA based entries */
26                 unsigned long long gpgsa; /**< the number of GPGSA based entries */
27                 unsigned long long gpgsv; /**< the number of GPGSV based entries */
28                 unsigned long long gprmc; /**< the number of GPRMC based entries */
29                 unsigned long long gpvtg; /**< the number of GPVTG based entries */
30
31                 /* sig */
32                 unsigned long long sigBad; /**< the number of entries with a bad sig */
33                 unsigned long long sigLow; /**< the number of entries with a low sig */
34                 unsigned long long sigMid; /**< the number of entries with a mid sig */
35                 unsigned long long sigHigh; /**< the number of entries with a high sig */
36
37                 /* fix */
38                 unsigned long long fixBad; /**< the number of entries with a bad fix */
39                 unsigned long long fix2d; /**< the number of entries with a 2D fix */
40                 unsigned long long fix3d; /**< the number of entries with a 3D fix */
41 } PositionUpdateCounters;
42
43 /**
44  A list of position updates that are used to determine the average position.
45
46  The list uses 1 extra entry: when 5 entries have to be averaged then the list
47  will have 6 entries. The 6th entry is used for the incoming entry, so that
48  it is already in the list (together with the old entry that will be removed
49  from the average) and does not need to be copied into the list. This is for
50  better performance.
51
52  The list is a circular list.
53  This means that there is a gap/unused entry in the list between the
54  newest entry and the oldest entry, which is the 'incoming entry'.
55
56  Note that 'positionAverageCumulative' stores cumulative values for parameters
57  for which an average is calculated. The reason is to minimise the number of
58  calculations to be performed.
59  */
60 typedef struct _PositionAverageList {
61                 unsigned long long entriesMaxCount; /**< the maximum number of entries in the list */
62                 PositionUpdateEntry * entries; /**< the list entries */
63
64                 unsigned long long entriesCount; /**< the number of entries in the list */
65                 unsigned long long newestEntryIndex; /**< index of the newest entry in the list (zero-based) */
66                 PositionUpdateCounters counters; /**< the counters */
67
68                 PositionUpdateEntry positionAverageCumulative; /**< the average position with cumulative values */
69                 PositionUpdateEntry positionAverage; /**< the average position */
70 } PositionAverageList;
71
72 /**
73  Enumeration describing the type of an entry position in the average list
74  */
75 typedef enum _AverageEntryPositionType {
76         OLDEST, NEWEST, INCOMING, AVERAGECUMULATIVE, AVERAGE
77 } AverageEntryPositionType;
78
79 bool initPositionAverageList(PositionAverageList * positionAverageList,
80                 unsigned long long maxEntries);
81 void flushPositionAverageList(PositionAverageList * positionAverageList);
82 void destroyPositionAverageList(PositionAverageList * positionAverageList);
83
84 PositionUpdateEntry * getPositionAverageEntry(
85                 PositionAverageList * positionAverageList,
86                 AverageEntryPositionType positionType);
87
88 void addNewPositionToAverage(PositionAverageList * positionAverageList,
89                 PositionUpdateEntry * newEntry);
90
91 #endif /* _PUD_POSAVG_H_ */