source: ntrip/branches/BNC_2.12/src/RTCM3/clock_and_orbit/clock_orbit_rtcm.h @ 8029

Last change on this file since 8029 was 8029, checked in by stuerze, 4 years ago

number of allowed biases is enlarged and some future GLONASS signal and tracking mode identifier are added

  • Property svn:executable set to *
  • Property svn:keywords set to Id
File size: 11.6 KB
Line 
1#ifndef RTCM3_CLOCK_ORBIT_RTCM_H
2#define RTCM3_CLOCK_ORBIT_RTCM_H
3
4/* Programheader
5
6        Name:           clock_orbit_rtcm.h
7        Project:        RTCM3
8        Version:        $Id: clock_orbit_rtcm.h 8029 2016-09-01 19:18:10Z stuerze $
9        Authors:        Dirk Stöcker
10        Description:    state space approach for RTCM3
11*/
12
13#include <string.h>
14
15enum SatelliteReferenceDatum { DATUM_ITRF=0, DATUM_LOCAL=1 };
16
17enum COR_BASE {
18  COBBASE_GPS = 1057,
19  COBBASE_GLONASS = 1063,
20  COBBASE_GALILEO = 1240,
21  COBBASE_QZSS = 1246,
22  COBBASE_SBAS = 1252,
23  COBBASE_BDS = 1258,
24};
25
26enum COR_OFFSET {
27  COBOFS_ORBIT = 0,
28  COBOFS_CLOCK,
29  COBOFS_BIAS,
30  COBOFS_COMBINED,
31  COBOFS_URA,
32  COBOFS_HR,
33  COBOFS_NUM
34};
35
36enum ClockOrbitType {
37  COTYPE_GPSORBIT = COBBASE_GPS + COBOFS_ORBIT,
38  COTYPE_GPSCLOCK,
39  COTYPE_GPSCOMBINED = COBBASE_GPS + COBOFS_COMBINED,
40  COTYPE_GPSURA,
41  COTYPE_GPSHR,
42
43  COTYPE_GLONASSORBIT = COBBASE_GLONASS + COBOFS_ORBIT,
44  COTYPE_GLONASSCLOCK,
45  COTYPE_GLONASSCOMBINED = COBBASE_GLONASS + COBOFS_COMBINED,
46  COTYPE_GLONASSURA,
47  COTYPE_GLONASSHR,
48
49  COTYPE_GALILEOORBIT = COBBASE_GALILEO + COBOFS_ORBIT,
50  COTYPE_GALILEOCLOCK,
51  COTYPE_GALILEOCOMBINED = COBBASE_GALILEO + COBOFS_COMBINED,
52  COTYPE_GALILEOURA,
53  COTYPE_GALILEOHR,
54
55  COTYPE_QZSSORBIT = COBBASE_QZSS + COBOFS_ORBIT,
56  COTYPE_QZSSCLOCK,
57  COTYPE_QZSSCOMBINED = COBBASE_QZSS + COBOFS_COMBINED,
58  COTYPE_QZSSURA,
59  COTYPE_QZSSHR,
60
61  COTYPE_SBASORBIT = COBBASE_SBAS + COBOFS_ORBIT,
62  COTYPE_SBASCLOCK,
63  COTYPE_SBASCOMBINED = COBBASE_SBAS + COBOFS_COMBINED,
64  COTYPE_SBASURA,
65  COTYPE_SBASHR,
66
67  COTYPE_BDSORBIT = COBBASE_BDS + COBOFS_ORBIT,
68  COTYPE_BDSCLOCK,
69  COTYPE_BDSCOMBINED = COBBASE_BDS + COBOFS_COMBINED,
70  COTYPE_BDSURA,
71  COTYPE_BDSHR,
72
73  COTYPE_AUTO = 0,
74};
75
76enum CodeBiasType {
77  BTYPE_GPS = COBBASE_GPS + COBOFS_BIAS,
78  BTYPE_GLONASS = COBBASE_GLONASS + COBOFS_BIAS,
79  BTYPE_GALILEO = COBBASE_GALILEO + COBOFS_BIAS,
80  BTYPE_QZSS = COBBASE_QZSS + COBOFS_BIAS,
81  BTYPE_SBAS = COBBASE_SBAS + COBOFS_BIAS,
82  BTYPE_BDS = COBBASE_BDS + COBOFS_BIAS,
83  BTYPE_AUTO = 0
84};
85
86enum PhaseBiasType {
87  PBTYPE_BASE = 1265,
88  PBTYPE_GPS = PBTYPE_BASE,
89  PBTYPE_GLONASS,
90  PBTYPE_GALILEO,
91  PBTYPE_QZSS,
92  PBTYPE_SBAS,
93  PBTYPE_BDS,
94  PBTYPE_AUTO = 0
95};
96
97enum VTECType {
98  VTEC_BASE = 1264
99};
100
101/* if some systems aren't supported at all, change the following numbers to zero
102for these systems to save space */
103enum COR_CONSTANTS {
104  CLOCKORBIT_BUFFERSIZE=2048,
105  CLOCKORBIT_NUMGPS=32,
106  CLOCKORBIT_NUMGLONASS=26,
107  CLOCKORBIT_NUMGALILEO=36,
108  CLOCKORBIT_NUMQZSS=10,
109  CLOCKORBIT_NUMSBAS=38,
110  CLOCKORBIT_NUMBDS=37,
111  CLOCKORBIT_NUMBIAS=72,
112  CLOCKORBIT_NUMIONOLAYERS=4,
113  CLOCKORBIT_MAXIONOORDER=16,
114  CLOCKORBIT_MAXIONODEGREE=16
115};
116
117enum COR_SATSYSTEM {
118  CLOCKORBIT_SATGPS=0,
119  CLOCKORBIT_SATGLONASS,
120  CLOCKORBIT_SATGALILEO,
121  CLOCKORBIT_SATQZSS,
122  CLOCKORBIT_SATSBAS,
123  CLOCKORBIT_SATBDS,
124  CLOCKORBIT_SATNUM
125};
126
127enum COR_OFFSETS {
128  CLOCKORBIT_OFFSETGPS=0,
129  CLOCKORBIT_OFFSETGLONASS=CLOCKORBIT_NUMGPS,
130  CLOCKORBIT_OFFSETGALILEO=CLOCKORBIT_NUMGPS+CLOCKORBIT_NUMGLONASS,
131  CLOCKORBIT_OFFSETQZSS=CLOCKORBIT_NUMGPS+CLOCKORBIT_NUMGLONASS
132  +CLOCKORBIT_NUMGALILEO,
133  CLOCKORBIT_OFFSETSBAS=CLOCKORBIT_NUMGPS+CLOCKORBIT_NUMGLONASS
134  +CLOCKORBIT_NUMGALILEO+CLOCKORBIT_NUMQZSS,
135  CLOCKORBIT_OFFSETBDS=CLOCKORBIT_NUMGPS+CLOCKORBIT_NUMGLONASS
136  +CLOCKORBIT_NUMGALILEO+CLOCKORBIT_NUMQZSS+CLOCKORBIT_NUMSBAS,
137  CLOCKORBIT_COUNTSAT=CLOCKORBIT_NUMGPS+CLOCKORBIT_NUMGLONASS
138  +CLOCKORBIT_NUMGALILEO+CLOCKORBIT_NUMQZSS+CLOCKORBIT_NUMSBAS
139  +CLOCKORBIT_NUMBDS
140};
141
142enum CodeType {
143  CODETYPEGPS_L1_CA          = 0,
144  CODETYPEGPS_L1_P           = 1,
145  CODETYPEGPS_L1_Z           = 2,
146  /*CODETYPEGPS_L1_Y         = 3,
147  CODETYPEGPS_L1_M           = 4,*/
148  CODETYPEGPS_L2_CA          = 5,
149  CODETYPEGPS_SEMI_CODELESS  = 6,
150  CODETYPEGPS_L2_CM          = 7,
151  CODETYPEGPS_L2_CL          = 8,
152  CODETYPEGPS_L2_CML         = 9,
153  CODETYPEGPS_L2_P           = 10,
154  CODETYPEGPS_L2_Z           = 11,
155  /*CODETYPEGPS_L2_Y         = 12,
156  CODETYPEGPS_L2_M           = 13,*/
157  CODETYPEGPS_L5_I           = 14,
158  CODETYPEGPS_L5_Q           = 15,
159  CODETYPEGPS_L5_IQ          = 16,
160  CODETYPEGPS_L1C_D          = 17,
161  CODETYPEGPS_L1C_P          = 18,
162  CODETYPEGPS_L1C_DP         = 19,
163
164  CODETYPEGLONASS_L1_CA      = 0,
165  CODETYPEGLONASS_L1_P       = 1,
166  CODETYPEGLONASS_L2_CA      = 2,
167  CODETYPEGLONASS_L2_P       = 3,
168  CODETYPEGLONASS_L3_I       = 4,
169  CODETYPEGLONASS_L3_Q       = 5,
170  CODETYPEGLONASS_L3_IQ      = 6, 
171
172  CODETYPEGALILEO_E1_A       = 0,
173  CODETYPEGALILEO_E1_B       = 1,
174  CODETYPEGALILEO_E1_C       = 2,
175  CODETYPEGALILEO_E1_BC      = 3,
176  CODETYPEGALILEO_E1_ABC     = 4,
177  CODETYPEGALILEO_E5A_I      = 5,
178  CODETYPEGALILEO_E5A_Q      = 6,
179  CODETYPEGALILEO_E5A_IQ     = 7,
180  CODETYPEGALILEO_E5B_I      = 8,
181  CODETYPEGALILEO_E5B_Q      = 9,
182  CODETYPEGALILEO_E5B_IQ     = 10,
183  CODETYPEGALILEO_E5_I       = 11,
184  CODETYPEGALILEO_E5_Q       = 12,
185  CODETYPEGALILEO_E5_IQ      = 13,
186  CODETYPEGALILEO_E6_A       = 14,
187  CODETYPEGALILEO_E6_B       = 15,
188  CODETYPEGALILEO_E6_C       = 16,
189  CODETYPEGALILEO_E6_BC      = 17,
190  CODETYPEGALILEO_E6_ABC     = 18,
191
192  CODETYPEQZSS_L1_CA         = 0,
193  CODETYPEQZSS_L1C_D         = 1,
194  CODETYPEQZSS_L1C_P         = 2,
195  CODETYPEQZSS_L2C_M         = 3,
196  CODETYPEQZSS_L2C_L         = 4,
197  CODETYPEQZSS_L2C_ML        = 5,
198  CODETYPEQZSS_L5_I          = 6,
199  CODETYPEQZSS_L5_Q          = 7,
200  CODETYPEQZSS_L5_IQ         = 8,
201  CODETYPEQZSS_LEX_S         = 9,
202  CODETYPEQZSS_LEX_L         = 10,
203  CODETYPEQZSS_LEX_SL        = 11,
204  CODETYPEQZSS_L1C_DP        = 12,
205
206  CODETYPE_SBAS_L1_CA        = 0,
207  CODETYPE_SBAS_L5_I         = 1,
208  CODETYPE_SBAS_L5_Q         = 2,
209  CODETYPE_SBAS_L5_IQ        = 3,
210
211  CODETYPE_BDS_B1_I          = 0,
212  CODETYPE_BDS_B1_Q          = 1,
213  CODETYPE_BDS_B1_IQ         = 2,
214  CODETYPE_BDS_B3_I          = 3,
215  CODETYPE_BDS_B3_Q          = 4,
216  CODETYPE_BDS_B3_IQ         = 5,
217  CODETYPE_BDS_B2_I          = 6,
218  CODETYPE_BDS_B2_Q          = 7,
219  CODETYPE_BDS_B2_IQ         = 8,
220};
221
222#define SSR_MAXURA 5.5 /* > 5466.5mm in meter */
223
224/* satellite system data is stored with offset CLOCKORBIT_OFFSET...
225in the data structures. So first GLONASS satellite is at
226xxx->Sat[CLOCKORBIT_OFFSETGLONASS], first GPS satellite is
227xxx->Sat[CLOCKORBIT_OFFSETGPS]. */
228
229#ifdef COR_LEGACY
230/* old names */
231#define NumberOfGPSSat     NumberOfSat[CLOCKORBIT_SATGPS]
232#define NumberOfGLONASSSat NumberOfSat[CLOCKORBIT_SATGLONASS]
233#define GPSEpochTime       EpochTime[CLOCKORBIT_SATGPS] /* 0 .. 604799 s */
234#define GLONASSEpochTime   EpochTime[CLOCKORBIT_SATGLONASS] /* 0 .. 86399 s (86400 for leap second) */
235#define ClockDataSupplied  Supplied[COBOFS_CLOCK]
236#define HRDataSupplied     Supplied[COBOFS_HR]
237#define OrbitDataSupplied  Supplied[COBOFS_ORBIT]
238#define URADataSupplied    Supplied[COBOFS_URA]
239#define GetClockOrbitBias(a,b,c,d,e) GetSSR(a,b,0,0,c,d,e)
240#endif /* COR_LEGACY */
241
242/* latency check code, disabled by default */
243#ifdef COR_LATENCY
244#define COR_LATENCYCOUNT 100
245#endif
246
247struct ClockOrbit
248{
249  enum ClockOrbitType messageType;
250  unsigned int EpochTime[CLOCKORBIT_SATNUM];   /* 0 .. system specific maximum */
251  unsigned int NumberOfSat[CLOCKORBIT_SATNUM]; /* 0 .. CLOCKORBIT_NUM... */
252
253  unsigned int Supplied[COBOFS_NUM];           /* boolean */
254#ifdef COR_LATENCY
255  unsigned int epochGPS[COR_LATENCYCOUNT+1];   /* Weber, for latency */
256  unsigned int epochSize;                      /* Weber, for latency */
257#endif
258  unsigned int SSRIOD;
259  unsigned int SSRProviderID;
260  unsigned int SSRSolutionID;
261  unsigned int UpdateInterval;
262  enum SatelliteReferenceDatum SatRefDatum;
263  struct SatData {
264    unsigned int ID; /* all */
265    unsigned int IOD; /* all */
266    unsigned int toe; /* SBAS, BDS */
267    double UserRangeAccuracy; /* accuracy values in [m] */
268    double hrclock;
269    struct OrbitPart
270    {
271      double DeltaRadial;           /* m */
272      double DeltaAlongTrack;       /* m */
273      double DeltaCrossTrack;       /* m */
274      double DotDeltaRadial;        /* m/s */
275      double DotDeltaAlongTrack;    /* m/s */
276      double DotDeltaCrossTrack;    /* m/s */
277    } Orbit;
278    struct ClockPart
279    {
280      double DeltaA0;               /* m */
281      double DeltaA1;               /* m/s */
282      double DeltaA2;               /* m/ss */
283    } Clock;
284  } Sat[CLOCKORBIT_COUNTSAT];
285};
286
287struct CodeBias
288{
289  enum CodeBiasType messageType;
290  unsigned int EpochTime[CLOCKORBIT_SATNUM];   /* 0 .. system specific maximum */
291  unsigned int NumberOfSat[CLOCKORBIT_SATNUM]; /* 0 .. CLOCKORBIT_NUM... */
292  unsigned int UpdateInterval;
293  unsigned int SSRIOD;
294  unsigned int SSRProviderID;
295  unsigned int SSRSolutionID;
296  struct BiasSat
297  {
298    unsigned int ID; /* all */
299    unsigned int NumberOfCodeBiases;
300    struct CodeBiasEntry
301    {
302      enum CodeType Type;
303      float         Bias;           /* m */
304    } Biases[CLOCKORBIT_NUMBIAS];
305  } Sat[CLOCKORBIT_COUNTSAT];
306};
307
308struct PhaseBias
309{
310  enum PhaseBiasType messageType;
311  unsigned int EpochTime[CLOCKORBIT_SATNUM];   /* 0 .. system specific maximum */
312  unsigned int NumberOfSat[CLOCKORBIT_SATNUM]; /* 0 .. CLOCKORBIT_NUM... */
313  unsigned int UpdateInterval;
314  unsigned int SSRIOD;
315  unsigned int SSRProviderID;
316  unsigned int SSRSolutionID;
317  unsigned int DispersiveBiasConsistencyIndicator;
318  unsigned int MWConsistencyIndicator;
319  struct PhaseBiasSat
320  {
321    unsigned int ID; /* all */
322    unsigned int NumberOfPhaseBiases;
323    double YawAngle; /* radiant */
324    double YawRate;  /* radiant/s */
325    struct PhaseBiasEntry
326    {
327      enum CodeType Type;
328      unsigned int  SignalIntegerIndicator;
329      unsigned int  SignalsWideLaneIntegerIndicator;
330      unsigned int  SignalDiscontinuityCounter;
331      float         Bias;           /* m */
332    } Biases[CLOCKORBIT_NUMBIAS];
333  } Sat[CLOCKORBIT_COUNTSAT];
334};
335
336struct VTEC
337{
338  unsigned int EpochTime; /* GPS */
339  unsigned int UpdateInterval;
340  unsigned int SSRIOD;
341  unsigned int SSRProviderID;
342  unsigned int SSRSolutionID;
343  unsigned int NumLayers; /* 1-4 */
344  double Quality;
345  struct IonoLayers {
346    double       Height; /* m */
347    unsigned int Degree; /* 1-16 */
348    unsigned int Order; /* 1-16 */
349    double       Sinus[CLOCKORBIT_MAXIONODEGREE][CLOCKORBIT_MAXIONOORDER];
350    double       Cosinus[CLOCKORBIT_MAXIONODEGREE][CLOCKORBIT_MAXIONOORDER];
351  } Layers[CLOCKORBIT_NUMIONOLAYERS];
352};
353
354/* return size of resulting data or 0 in case of an error */
355size_t MakeClockOrbit(const struct ClockOrbit *co, enum ClockOrbitType type,
356       int moremessagesfollow, char *buffer, size_t size);
357size_t MakeCodeBias(const struct CodeBias *b, enum CodeBiasType type,
358       int moremessagesfollow, char *buffer, size_t size);
359size_t MakePhaseBias(const struct PhaseBias *b, enum PhaseBiasType type,
360       int moremessagesfollow, char *buffer, size_t size);
361size_t MakeVTEC(const struct VTEC *b, int moremessagesfollow, char *buffer,
362       size_t size);
363
364enum GCOB_RETURN {
365  /* all well */
366  GCOBR_MESSAGEFOLLOWS = 1,
367  GCOBR_OK = 0,
368  /* unknown data, a warning */
369  GCOBR_UNKNOWNTYPE = -1,
370  GCOBR_UNKNOWNDATA = -2,
371  GCOBR_CRCMISMATCH = -3,
372  GCOBR_SHORTMESSAGE = -4,
373  /* failed to do the work */
374  GCOBR_NOCLOCKORBITPARAMETER = -10,
375  GCOBR_NOCODEBIASPARAMETER = -11,
376  GCOBR_NOPHASEBIASPARAMETER = -12,
377  GCOBR_NOVTECPARAMETER = -13,
378  /* data mismatch - data in storage does not match new data */
379  GCOBR_TIMEMISMATCH = -20,
380  GCOBR_DATAMISMATCH = -21,
381  /* not enough data - can decode the block completely */
382  GCOBR_SHORTBUFFER = -30,
383  GCOBR_MESSAGEEXCEEDSBUFFER = -31};
384
385/* NOTE: When an error message has been emitted, the output structures may have been modified. Make a copy of the previous variant before calling the
386function to have a clean state. */
387
388/* buffer should point to a RTCM3 block */
389enum GCOB_RETURN GetSSR(struct ClockOrbit *co, struct CodeBias *b, struct VTEC *v,
390       struct PhaseBias *pb, const char *buffer, size_t size, int *bytesused);
391
392#endif /* RTCM3_CLOCK_ORBIT_RTCM_H */
Note: See TracBrowser for help on using the repository browser.