DriveWorks SDK Reference
5.14.77 Release
For Test and Development only

GPSFrame.h
Go to the documentation of this file.
1
2// This code contains NVIDIA Confidential Information and is disclosed
3// under the Mutual Non-Disclosure Agreement.
4//
5// Notice
6// ALL NVIDIA DESIGN SPECIFICATIONS AND CODE ("MATERIALS") ARE PROVIDED "AS IS"
7// NVIDIA MAKES NO REPRESENTATIONS, WARRANTIES, EXPRESSED, IMPLIED, STATUTORY,
8// OR OTHERWISE WITH RESPECT TO THE MATERIALS, AND EXPRESSLY DISCLAIMS ANY
9// IMPLIED WARRANTIES OF NONINFRINGEMENT, MERCHANTABILITY, OR FITNESS FOR A
10// PARTICULAR PURPOSE.
11//
12// NVIDIA Corporation assumes no responsibility for the consequences of use of
13// such information or for any infringement of patents or other rights of third
14// parties that may result from its use. No license is granted by implication or
15// otherwise under any patent or patent rights of NVIDIA Corporation. No third
16// party distribution is allowed unless expressly authorized by NVIDIA. Details
17// are subject to change without notice. This code supersedes and replaces all
18// information previously supplied. NVIDIA Corporation products are not
19// authorized for use as critical components in life support devices or systems
20// without express written approval of NVIDIA Corporation.
21//
22// Copyright (c) 2016-2023 NVIDIA Corporation. All rights reserved.
23//
24// NVIDIA Corporation and its licensors retain all intellectual property and
25// proprietary rights in and to this software and related documentation and any
26// modifications thereto. Any use, reproduction, disclosure or distribution of
27// this software and related documentation without an express license agreement
28// from NVIDIA Corporation is strictly prohibited.
29//
31#ifndef DW_SENSORS_GPS_GPSFRAME_H_
32#define DW_SENSORS_GPS_GPSFRAME_H_
33// Generated by dwProto from gps_frame.proto DO NOT EDIT BY HAND!
34// See //3rdparty/shared/dwproto/README.md for more information
35
37#include <dw/core/base/Types.h>
38
40
41#ifdef __cplusplus
42extern "C" {
43#endif
44
46typedef enum dwGPSFlags {
48 DW_GPS_LAT DW_DEPRECATED_ENUM("Use dwGPSFrame.validityInfo.latitude instead") = 1 << 0,
49
51 DW_GPS_LON DW_DEPRECATED_ENUM("Use dwGPSFrame.validityInfo.longitude instead") = 1 << 1,
52
54 DW_GPS_ALT DW_DEPRECATED_ENUM("Use dwGPSFrame.validityInfo.altitude instead") = 1 << 2,
55
57 DW_GPS_COURSE DW_DEPRECATED_ENUM("Use dwGPSFrame.validityInfo.course instead") = 1 << 3,
58
60 DW_GPS_SPEED DW_DEPRECATED_ENUM("Use dwGPSFrame.validityInfo.speed instead") = 1 << 4,
61
63 DW_GPS_CLIMB DW_DEPRECATED_ENUM("Use dwGPSFrame.validityInfo.climb instead") = 1 << 5,
64
66 DW_GPS_HDOP DW_DEPRECATED_ENUM("Use dwGPSFrame.validityInfo.hdop instead") = 1 << 6,
67
69 DW_GPS_VDOP DW_DEPRECATED_ENUM("Use dwGPSFrame.validityInfo.vdop instead") = 1 << 7,
70
72 DW_GPS_HACC DW_DEPRECATED_ENUM("Use dwGPSFrame.validityInfo.hacc instead") = 1 << 8,
73
75 DW_GPS_VACC DW_DEPRECATED_ENUM("Use dwGPSFrame.validityInfo.vacc instead") = 1 << 9,
76
78 DW_GPS_MODE DW_DEPRECATED_ENUM("Use dwGPSFrame.validityInfo.mode instead") = 1 << 10,
81
84typedef enum dwGPSMode {
87
90
93
96
99
102
105
108
111
115} dwGPSMode;
116
118typedef enum dwGPSFixStatus {
121
124
129
134
137
142
146{
149
152
155
158
161
164
167
170
173
176
179
182
185
188
191
194
197
201
204typedef struct dwGPSFrame
205{
206
209
215
221
227
233
239
245
251
257
263
269
275
281
287
294
306
318
337
340 DW_DEPRECATED("utcTime is deprecated and will be removed soon. Please use utcTime instead")
342
345 DW_DEPRECATED("utcDate is deprecated and will be removed soon. Please use utcTime instead")
346 char8_t utcDate[16];
347
350 DW_DEPRECATED("flags is deprecated and will be removed soon. Please use struct validityInfo and APIs introduced in GPSGetterSetter.h instead")
351 uint32_t flags;
352
355 DW_DEPRECATED("gpsMode is deprecated and will be removed soon. Please use mode instead")
357
359 uint8_t reserved[468];
360} dwGPSFrame;
361
362#ifdef __cplusplus
363}
364#endif
365
366#endif // DW_SENSORS_GPS_GPSFRAME_H_
dwSignalValidity longitude
Validity of longitude signal.
Definition: GPSFrame.h:154
dwSignalValidity altitude
Validity of altitude signal.
Definition: GPSFrame.h:157
float64_t vacc
Definition: GPSFrame.h:280
dwGPSMode gpsMode
GPS mode.
Definition: GPSFrame.h:356
float64_t pdop
Definition: GPSFrame.h:268
dwGPSFlags
Each flag shows if that value is valid in this GPS frame.
Definition: GPSFrame.h:46
@ DW_GPS_FLAGS_FORCE32
Definition: GPSFrame.h:79
@ DW_DEPRECATED_ENUM
Value of dwGPSFrame.latitude is valid.
Definition: GPSFrame.h:48
char8_t utcTime[16]
UTC time as provided in the GPS package [hhmmss.sss] (null terminated).
Definition: GPSFrame.h:341
dwSignalValidity latitude
Validity of latitude signal.
Definition: GPSFrame.h:151
float64_t hacc
Definition: GPSFrame.h:274
dwGPSFixStatus fixStatus
Definition: GPSFrame.h:305
dwSignalValidity satelliteCount
Validity of satellite count signal.
Definition: GPSFrame.h:187
dwSignalValidity timestamp_us
Validity of timestamp signal.
Definition: GPSFrame.h:148
dwSignalValidity course
Validity of course signal.
Definition: GPSFrame.h:160
dwTime_t timestamp_us
Definition: GPSFrame.h:214
uint8_t reserved[468]
Reserved space.
Definition: GPSFrame.h:359
dwSignalValidity fixStatus
Validity of 2D or 3D fix status signal.
Definition: GPSFrame.h:190
float64_t latitude
Definition: GPSFrame.h:220
dwGPSFixStatus
GPS satellite fix status.
Definition: GPSFrame.h:118
@ DW_GPS_FIX_STATUS_2D_FIX
2D fix
Definition: GPSFrame.h:123
@ DW_GPS_FIX_STATUS_NO_FIX
No fix.
Definition: GPSFrame.h:120
@ DW_GPS_FIX_STATUS_3D_FIX
3D fix
Definition: GPSFrame.h:126
@ DW_GPS_FIX_STATUS_FORCE32
Definition: GPSFrame.h:127
dwSignalValidity climb
Validity of climb signal.
Definition: GPSFrame.h:166
float64_t vdop
Definition: GPSFrame.h:262
dwSignalValidity pdop
Validity of positional dilusion of precision signal.
Definition: GPSFrame.h:175
dwGPSMode mode
Definition: GPSFrame.h:336
dwSignalValidity vacc
Validity of vertical accuracy of solution signal.
Definition: GPSFrame.h:181
float64_t course
Definition: GPSFrame.h:238
float64_t altitude
Definition: GPSFrame.h:232
dwSignalValidity mode
Validity of GPS mode signal.
Definition: GPSFrame.h:196
dwSignalValidity hacc
Validity of horizontal accuracy of solution signal.
Definition: GPSFrame.h:178
dwSignalValidity vdop
Validity of vertical dilusion of precision signal.
Definition: GPSFrame.h:172
dwSignalValidity reserved[63]
Reserved space.
Definition: GPSFrame.h:199
dwSignalValidity speed
Validity of speed signal.
Definition: GPSFrame.h:163
float64_t longitude
Definition: GPSFrame.h:226
dwGPSTimestampQuality timestampQuality
Definition: GPSFrame.h:317
dwGPSMode
The GPS mode gives the status of the GNSS data.
Definition: GPSFrame.h:84
@ DW_GPS_MODE_STAND_ALONE
GPS mode stand alone. No RTK or PPP correction.
Definition: GPSFrame.h:95
@ DW_GPS_MODE_PPP_CONVERGING
GPS mode PPP converging. Using PPP, but solution has not finished converging, so the data is not yet ...
Definition: GPSFrame.h:110
@ DW_GPS_MODE_INVALID_GPS
GPS mode invalid. This GPS data cannot be used.
Definition: GPSFrame.h:89
@ DW_GPS_MODE_DEAD_RECKONING
GPS mode dead reckoning. Device relying on IMU alone for updates.
Definition: GPSFrame.h:92
@ DW_GPS_MODE_RTK_FLOAT
GPS mode RTK float.
Definition: GPSFrame.h:104
@ DW_GPS_MODE_CODE_DIFFERENTIAL
GPS mode code differential. No RTK or PPP correction.
Definition: GPSFrame.h:101
@ DW_GPS_MODE_FORCE32
Definition: GPSFrame.h:114
@ DW_GPS_MODE_RTK_FIXED
GPS mode RTK fixed. This is the highest accuracy mode.
Definition: GPSFrame.h:107
@ DW_GPS_MODE_UNKNOWN
GPS mode unknown. The device cannot or has not reported the mode.
Definition: GPSFrame.h:86
@ DW_GPS_MODE_PRECISE_POINT
GPS mode precise point. No RTK or PPP correction.
Definition: GPSFrame.h:98
@ DW_GPS_MODE_PPP_CONVERGED
GPS mode PPP converged. Most accurate mode for using PPP.
Definition: GPSFrame.h:113
char8_t utcDate[16]
UTC date as provided in the GPS package [ddmmyy] (null terminated).
Definition: GPSFrame.h:346
dwGPSSignalValidityInfo validityInfo
Signal validity information.
Definition: GPSFrame.h:208
dwSignalValidity utcTimeUs
Validity of UTC time signal.
Definition: GPSFrame.h:184
dwTime_t utcTimeUs
Definition: GPSFrame.h:286
uint8_t satelliteCount
Definition: GPSFrame.h:293
dwSignalValidity timestampQuality
Validity of timestamp quality signal.
Definition: GPSFrame.h:193
float64_t speed
Definition: GPSFrame.h:244
dwSignalValidity hdop
Validity of horizontal dilusion of precision signal.
Definition: GPSFrame.h:169
uint32_t flags
The flags to show which values are valid in this GPS frame.
Definition: GPSFrame.h:351
float64_t hdop
Definition: GPSFrame.h:256
float64_t climb
Definition: GPSFrame.h:250
dwGPSTimestampQuality
GPS timestamp quality.
Definition: GPSFrame.h:131
@ DW_GPS_TIMESTAMP_QUALITY_FORCE32
Definition: GPSFrame.h:140
@ DW_GPS_TIMESTAMP_QUALITY_SYNC_LOST
Synchronization lost.
Definition: GPSFrame.h:139
@ DW_GPS_TIMESTAMP_QUALITY_NOT_INIT
Not Initialized. still initializing.
Definition: GPSFrame.h:133
@ DW_GPS_TIMESTAMP_QUALITY_OK
Normal Operation. Functional and Electrical Checks Passed.
Definition: GPSFrame.h:136
A GPS packet containing localization information.
Definition: GPSFrame.h:205
This structure contains validity of each signal provided by GPS sensors.
Definition: GPSFrame.h:146
DriveWorks API: Signal Status Library
NVIDIA DriveWorks API: Core Types
NVIDIA DriveWorks API: Core Exports
char char8_t
Definition: BasicTypes.h:61
int64_t dwTime_t
Specifies a timestamp unit, in microseconds.
Definition: BasicTypes.h:65
double float64_t
Definition: BasicTypes.h:60
#define DW_DEPRECATED(msg)
Definition: Exports.h:66
uint8_t dwSignalValidity
The type of the encoded status field.
Definition: SignalStatus.h:57