source: ntrip/trunk/BNC/src/RTCM3/clock_and_orbit/clock_orbit_rtcm.h@ 8409

Last change on this file since 8409 was 8409, checked in by stuerze, 6 years ago

updated SSR obs codes
  • Property svn:executable set to *
  • Property svn:keywords set to Id
File size: 12.2 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 8409 2018-07-06 09:06:31Z 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=8192,
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_L2C_M = 7,
151 CODETYPEGPS_L2C_L = 8,
152 CODETYPEGPS_L2C_ML = 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_L1a_OCd = 4,
169 CODETYPEGLONASS_L1a_OCp = 5,
170 CODETYPEGLONASS_L1a_OCdp = 6,
171 CODETYPEGLONASS_L2a_CSI = 7,
172 CODETYPEGLONASS_L2a_OCp = 8,
173 CODETYPEGLONASS_L2a_CSIOCp = 9,
174 CODETYPEGLONASS_L3_I = 10,
175 CODETYPEGLONASS_L3_Q = 11,
176 CODETYPEGLONASS_L3_IQ = 12,
177
178
179 CODETYPEGALILEO_E1_A = 0,
180 CODETYPEGALILEO_E1_B = 1,
181 CODETYPEGALILEO_E1_C = 2,
182 CODETYPEGALILEO_E1_BC = 3,
183 CODETYPEGALILEO_E1_ABC = 4,
184 CODETYPEGALILEO_E5A_I = 5,
185 CODETYPEGALILEO_E5A_Q = 6,
186 CODETYPEGALILEO_E5A_IQ = 7,
187 CODETYPEGALILEO_E5B_I = 8,
188 CODETYPEGALILEO_E5B_Q = 9,
189 CODETYPEGALILEO_E5B_IQ = 10,
190 CODETYPEGALILEO_E5_I = 11,
191 CODETYPEGALILEO_E5_Q = 12,
192 CODETYPEGALILEO_E5_IQ = 13,
193 CODETYPEGALILEO_E6_A = 14,
194 CODETYPEGALILEO_E6_B = 15,
195 CODETYPEGALILEO_E6_C = 16,
196 CODETYPEGALILEO_E6_BC = 17,
197 CODETYPEGALILEO_E6_ABC = 18,
198
199 CODETYPEQZSS_L1_CA = 0,
200 CODETYPEQZSS_L1C_D = 1,
201 CODETYPEQZSS_L1C_P = 2,
202 CODETYPEQZSS_L2C_M = 3,
203 CODETYPEQZSS_L2C_L = 4,
204 CODETYPEQZSS_L2C_ML = 5,
205 CODETYPEQZSS_L5_I = 6,
206 CODETYPEQZSS_L5_Q = 7,
207 CODETYPEQZSS_L5_IQ = 8,
208 CODETYPEQZSS_L6_D = 9,
209 CODETYPEQZSS_L6_P = 10,
210 CODETYPEQZSS_L6_DP = 11,
211 CODETYPEQZSS_L1C_DP = 12,
212 CODETYPEQZSS_L1S = 13,
213 CODETYPEQZSS_L5_D = 14,
214 CODETYPEQZSS_L5_P = 15,
215 CODETYPEQZSS_L5_DP = 16,
216 CODETYPEQZSS_L6E = 17,
217 CODETYPEQZSS_L6_DE = 18,
218
219 CODETYPE_SBAS_L1_CA = 0,
220 CODETYPE_SBAS_L5_I = 1,
221 CODETYPE_SBAS_L5_Q = 2,
222 CODETYPE_SBAS_L5_IQ = 3,
223
224 CODETYPE_BDS_B1_I = 0,
225 CODETYPE_BDS_B1_Q = 1,
226 CODETYPE_BDS_B1_IQ = 2,
227 CODETYPE_BDS_B3_I = 3,
228 CODETYPE_BDS_B3_Q = 4,
229 CODETYPE_BDS_B3_IQ = 5,
230 CODETYPE_BDS_B2_I = 6,
231 CODETYPE_BDS_B2_Q = 7,
232 CODETYPE_BDS_B2_IQ = 8,
233 CODETYPE_BDS_B1a_D = 9,
234 CODETYPE_BDS_B1a_P = 10,
235 CODETYPE_BDS_B1a_DP = 11,
236 CODETYPE_BDS_B2a_D = 12,
237 CODETYPE_BDS_B2a_P = 13,
238 CODETYPE_BDS_B2a_DP = 14
239};
240
241#define SSR_MAXURA 5.5 /* > 5466.5mm in meter */
242
243/* satellite system data is stored with offset CLOCKORBIT_OFFSET...
244in the data structures. So first GLONASS satellite is at
245xxx->Sat[CLOCKORBIT_OFFSETGLONASS], first GPS satellite is
246xxx->Sat[CLOCKORBIT_OFFSETGPS]. */
247
248#ifdef COR_LEGACY
249/* old names */
250#define NumberOfGPSSat NumberOfSat[CLOCKORBIT_SATGPS]
251#define NumberOfGLONASSSat NumberOfSat[CLOCKORBIT_SATGLONASS]
252#define GPSEpochTime EpochTime[CLOCKORBIT_SATGPS] /* 0 .. 604799 s */
253#define GLONASSEpochTime EpochTime[CLOCKORBIT_SATGLONASS] /* 0 .. 86399 s (86400 for leap second) */
254#define ClockDataSupplied Supplied[COBOFS_CLOCK]
255#define HRDataSupplied Supplied[COBOFS_HR]
256#define OrbitDataSupplied Supplied[COBOFS_ORBIT]
257#define URADataSupplied Supplied[COBOFS_URA]
258#define GetClockOrbitBias(a,b,c,d,e) GetSSR(a,b,0,0,c,d,e)
259#endif /* COR_LEGACY */
260
261/* latency check code, disabled by default */
262#ifdef COR_LATENCY
263#define COR_LATENCYCOUNT 100
264#endif
265
266struct ClockOrbit
267{
268 enum ClockOrbitType messageType;
269 unsigned int EpochTime[CLOCKORBIT_SATNUM]; /* 0 .. system specific maximum */
270 unsigned int NumberOfSat[CLOCKORBIT_SATNUM]; /* 0 .. CLOCKORBIT_NUM... */
271
272 unsigned int Supplied[COBOFS_NUM]; /* boolean */
273#ifdef COR_LATENCY
274 unsigned int epochGPS[COR_LATENCYCOUNT+1]; /* Weber, for latency */
275 unsigned int epochSize; /* Weber, for latency */
276#endif
277 unsigned int SSRIOD;
278 unsigned int SSRProviderID;
279 unsigned int SSRSolutionID;
280 unsigned int UpdateInterval;
281 enum SatelliteReferenceDatum SatRefDatum;
282 struct SatData {
283 unsigned int ID; /* all */
284 unsigned int IOD; /* all */
285 unsigned int toe; /* SBAS, BDS */
286 double UserRangeAccuracy; /* accuracy values in [m] */
287 double hrclock;
288 struct OrbitPart
289 {
290 double DeltaRadial; /* m */
291 double DeltaAlongTrack; /* m */
292 double DeltaCrossTrack; /* m */
293 double DotDeltaRadial; /* m/s */
294 double DotDeltaAlongTrack; /* m/s */
295 double DotDeltaCrossTrack; /* m/s */
296 } Orbit;
297 struct ClockPart
298 {
299 double DeltaA0; /* m */
300 double DeltaA1; /* m/s */
301 double DeltaA2; /* m/ss */
302 } Clock;
303 } Sat[CLOCKORBIT_COUNTSAT];
304};
305
306struct CodeBias
307{
308 enum CodeBiasType messageType;
309 unsigned int EpochTime[CLOCKORBIT_SATNUM]; /* 0 .. system specific maximum */
310 unsigned int NumberOfSat[CLOCKORBIT_SATNUM]; /* 0 .. CLOCKORBIT_NUM... */
311 unsigned int UpdateInterval;
312 unsigned int SSRIOD;
313 unsigned int SSRProviderID;
314 unsigned int SSRSolutionID;
315 struct BiasSat
316 {
317 unsigned int ID; /* all */
318 unsigned int NumberOfCodeBiases;
319 struct CodeBiasEntry
320 {
321 enum CodeType Type;
322 float Bias; /* m */
323 } Biases[CLOCKORBIT_NUMBIAS];
324 } Sat[CLOCKORBIT_COUNTSAT];
325};
326
327struct PhaseBias
328{
329 enum PhaseBiasType messageType;
330 unsigned int EpochTime[CLOCKORBIT_SATNUM]; /* 0 .. system specific maximum */
331 unsigned int NumberOfSat[CLOCKORBIT_SATNUM]; /* 0 .. CLOCKORBIT_NUM... */
332 unsigned int UpdateInterval;
333 unsigned int SSRIOD;
334 unsigned int SSRProviderID;
335 unsigned int SSRSolutionID;
336 unsigned int DispersiveBiasConsistencyIndicator;
337 unsigned int MWConsistencyIndicator;
338 struct PhaseBiasSat
339 {
340 unsigned int ID; /* all */
341 unsigned int NumberOfPhaseBiases;
342 double YawAngle; /* radiant */
343 double YawRate; /* radiant/s */
344 struct PhaseBiasEntry
345 {
346 enum CodeType Type;
347 unsigned int SignalIntegerIndicator;
348 unsigned int SignalsWideLaneIntegerIndicator;
349 unsigned int SignalDiscontinuityCounter;
350 float Bias; /* m */
351 } Biases[CLOCKORBIT_NUMBIAS];
352 } Sat[CLOCKORBIT_COUNTSAT];
353};
354
355struct VTEC
356{
357 unsigned int EpochTime; /* GPS */
358 unsigned int UpdateInterval;
359 unsigned int SSRIOD;
360 unsigned int SSRProviderID;
361 unsigned int SSRSolutionID;
362 unsigned int NumLayers; /* 1-4 */
363 double Quality;
364 struct IonoLayers {
365 double Height; /* m */
366 unsigned int Degree; /* 1-16 */
367 unsigned int Order; /* 1-16 */
368 double Sinus[CLOCKORBIT_MAXIONODEGREE][CLOCKORBIT_MAXIONOORDER];
369 double Cosinus[CLOCKORBIT_MAXIONODEGREE][CLOCKORBIT_MAXIONOORDER];
370 } Layers[CLOCKORBIT_NUMIONOLAYERS];
371};
372
373/* return size of resulting data or 0 in case of an error */
374size_t MakeClockOrbit(const struct ClockOrbit *co, enum ClockOrbitType type,
375 int moremessagesfollow, char *buffer, size_t size);
376size_t MakeCodeBias(const struct CodeBias *b, enum CodeBiasType type,
377 int moremessagesfollow, char *buffer, size_t size);
378size_t MakePhaseBias(const struct PhaseBias *b, enum PhaseBiasType type,
379 int moremessagesfollow, char *buffer, size_t size);
380size_t MakeVTEC(const struct VTEC *b, int moremessagesfollow, char *buffer,
381 size_t size);
382
383enum GCOB_RETURN {
384 /* all well */
385 GCOBR_MESSAGEFOLLOWS = 1,
386 GCOBR_OK = 0,
387 /* unknown data, a warning */
388 GCOBR_UNKNOWNTYPE = -1,
389 GCOBR_UNKNOWNDATA = -2,
390 GCOBR_CRCMISMATCH = -3,
391 GCOBR_SHORTMESSAGE = -4,
392 /* failed to do the work */
393 GCOBR_NOCLOCKORBITPARAMETER = -10,
394 GCOBR_NOCODEBIASPARAMETER = -11,
395 GCOBR_NOPHASEBIASPARAMETER = -12,
396 GCOBR_NOVTECPARAMETER = -13,
397 /* data mismatch - data in storage does not match new data */
398 GCOBR_TIMEMISMATCH = -20,
399 GCOBR_DATAMISMATCH = -21,
400 /* not enough data - can decode the block completely */
401 GCOBR_SHORTBUFFER = -30,
402 GCOBR_MESSAGEEXCEEDSBUFFER = -31};
403
404/* 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
405function to have a clean state. */
406
407/* buffer should point to a RTCM3 block */
408enum GCOB_RETURN GetSSR(struct ClockOrbit *co, struct CodeBias *b, struct VTEC *v,
409 struct PhaseBias *pb, const char *buffer, size_t size, int *bytesused);
410
411#endif /* RTCM3_CLOCK_ORBIT_RTCM_H */
Note: See TracBrowser for help on using the repository browser.