NVIDIA DriveOS Linux NSR SDK API Reference

7.0.3.0 Release
dwGPSFrame Struct Reference

Detailed Description

A GPS packet containing localization information.

Flags are used to define information available in this frame.

Definition at line 284 of file GPSFrame.h.

Collaboration diagram for dwGPSFrame:

Data Fields

dwGPSSignalValidityInfo validityInfo
 Signal validity information. More...
 
dwTime_t timestamp_us
 
float64_t latitude
 
float64_t longitude
 
float64_t altitude
 
float64_t course
 
float64_t speed
 
float64_t climb
 
float64_t hdop
 
float64_t vdop
 
float64_t pdop
 
float64_t hacc
 
float64_t vacc
 
dwTime_t utcTimeUs
 
uint8_t satelliteCount
 
dwGPSFixStatus fixStatus
 
dwGPSTimestampQuality timestampQuality
 
dwGPSMode mode
 
char8_t utcTime [16]
 UTC time as provided in the GPS package [hhmmss.sss] (null terminated). More...
 
char8_t utcDate [16]
 UTC date as provided in the GPS package [ddmmyy] (null terminated). More...
 
uint32_t flags
 The flags to show which values are valid in this GPS frame. More...
 
dwGPSMode gpsMode
 GPS mode. More...
 
uint64_t errors
 GPS Error IDs. It's internally used by SAL sensors. VAL and partners are not intended to use this field. More...
 
float64_t courseAccuracy
 
float64_t speedAccuracy
 
dwGPSJamState jamState
 
dwGPSSpoofState spoofState
 
dwTime_t sensorTimestamp
 
dwTime_t hostTimestamp
 
dwGPSTimestampFormat sensorTimestampFormat
 
uint8_t reserved [416]
 Reserved space. More...
 

Field Documentation

◆ altitude

float64_t dwGPSFrame::altitude
Note
ID VS-91040
description Altitude over WGS-84 ellipsoid.
min nan max nan
freq 4 unit m

Definition at line 315 of file GPSFrame.h.

◆ climb

float64_t dwGPSFrame::climb
Note
ID VS-91070
description Vertical speed.
min nan max nan
freq 4 unit m/s

Definition at line 333 of file GPSFrame.h.

◆ course

float64_t dwGPSFrame::course
Note
ID VS-91050
description Course relative to true north.
min nan max nan
freq 4 unit deg

Definition at line 321 of file GPSFrame.h.

◆ courseAccuracy

float64_t dwGPSFrame::courseAccuracy
Note
ID VS-91180
description Accuracy of GNSS-course estimated by GNSS-receiver.
FUTURE_IMPLEMENTED_POST_24_06 - This signal is not implemented and is effectively ignored by NDAS. It will be implemented in a future release. Implementation tracking ticket [DWVAL-3070]
min 0 max 359.9985
freq 4 unit deg

Definition at line 448 of file GPSFrame.h.

◆ errors

uint64_t dwGPSFrame::errors

GPS Error IDs. It's internally used by SAL sensors. VAL and partners are not intended to use this field.

Definition at line 441 of file GPSFrame.h.

◆ fixStatus

dwGPSFixStatus dwGPSFrame::fixStatus
Note
ID VS-91150
description 2D or 3D fix.
min nan max nan
freq 4 unit unitless
*** valid values**: { DW_GPS_FIX_STATUS_NO_FIX, DW_GPS_FIX_STATUS_2D_FIX, DW_GPS_FIX_STATUS_3D_FIX }

Definition at line 387 of file GPSFrame.h.

◆ flags

uint32_t dwGPSFrame::flags

The flags to show which values are valid in this GPS frame.

Deprecated:
flags is deprecated and will be removed soon. Please use struct validityInfo and APIs introduced in GPSGetterSetter.h instead

Definition at line 433 of file GPSFrame.h.

◆ gpsMode

dwGPSMode dwGPSFrame::gpsMode

GPS mode.

Deprecated:
gpsMode is deprecated and will be removed soon.

Please use mode instead

Definition at line 438 of file GPSFrame.h.

◆ hacc

float64_t dwGPSFrame::hacc
Note
ID VS-91110
description Horizontal Accuracy of Solution.
min nan max nan
freq 4 unit m

Definition at line 357 of file GPSFrame.h.

◆ hdop

float64_t dwGPSFrame::hdop
Note
ID VS-91080
description Horizontal Dilution of Precision.
min nan max nan
freq 4 unit unitless

Definition at line 339 of file GPSFrame.h.

◆ hostTimestamp

dwTime_t dwGPSFrame::hostTimestamp
Note
ID VS-91230
Timestamp of message when first received by NDAS. Partner should not fill this field.
unit us

Definition at line 494 of file GPSFrame.h.

◆ jamState

dwGPSJamState dwGPSFrame::jamState
Note
ID VS-91200
description GPS Jamming state detected by the GNSS-receiver.
FUTURE_IMPLEMENTED_POST_24_06 - This signal is not implemented and is effectively ignored by NDAS. It will be implemented in a future release. Implementation tracking ticket [DWVAL-3070]
min nan max nan
freq 4 unit unitless
*** valid values**: { GPS_JAM_STATE_UNSPECIFIED, GPS_JAM_STATE_OK, GPS_JAM_STATE_WARN, GPS_JAM_STATE_CRITICAL, GPS_JAM_STATE_INIT }

Definition at line 469 of file GPSFrame.h.

◆ latitude

float64_t dwGPSFrame::latitude
Note
ID VS-91020
description Latitude in WGS-84.
min nan max nan
freq 4 unit deg

Definition at line 303 of file GPSFrame.h.

◆ longitude

float64_t dwGPSFrame::longitude
Note
ID VS-91030
description Longitude in WGS-84.
min nan max nan
freq 4 unit deg

Definition at line 309 of file GPSFrame.h.

◆ mode

dwGPSMode dwGPSFrame::mode
Note
ID VS-91175
description GPS mode.
FUTURE_IMPLEMENTED_POST_24_06 - This signal is not implemented and is effectively ignored by NDAS. It will be implemented in a future release. Implementation tracking ticket [DWVAL-3070]
min nan max nan
freq 4 unit unitless
*** valid values**: { DW_GPS_MODE_UNKNOWN, DW_GPS_MODE_INVALID_GPS, DW_GPS_MODE_DEAD_RECKONING, DW_GPS_MODE_STAND_ALONE, DW_GPS_MODE_PRECISE_POINT, DW_GPS_MODE_CODE_DIFFERENTIAL, DW_GPS_MODE_RTK_FLOAT, DW_GPS_MODE_RTK_FIXED, DW_GPS_MODE_PPP_CONVERGING, DW_GPS_MODE_PPP_CONVERGED }

Definition at line 418 of file GPSFrame.h.

◆ pdop

float64_t dwGPSFrame::pdop
Note
ID VS-91100
description Position Dilution of Precision.
min nan max nan
freq 4 unit unitless

Definition at line 351 of file GPSFrame.h.

◆ reserved

uint8_t dwGPSFrame::reserved[416]

Reserved space.

Definition at line 506 of file GPSFrame.h.

◆ satelliteCount

uint8_t dwGPSFrame::satelliteCount
Note
ID VS-91140
description Number of satellites in view.
FUTURE_IMPLEMENTED_POST_24_06 - This signal is not implemented and is effectively ignored by NDAS. It will be implemented in a future release. Implementation tracking ticket [DWVAL-3070]
min nan max nan
freq 4 unit unitless

Definition at line 376 of file GPSFrame.h.

◆ sensorTimestamp

dwTime_t dwGPSFrame::sensorTimestamp
Note
ID VS-91220
Timestamp of the message when sensor produced the data. If sensor does not support timestamping of data, data shall be timestamped by the first recipient of sensor data
unit us in all contexts except when sensorTimestampFormat is equal to dwGPSTimestampFormat::DW_GPS_TIMESTAMP_FORMAT_PTP16 in which case the smallest unit is 100us.

Definition at line 489 of file GPSFrame.h.

◆ sensorTimestampFormat

dwGPSTimestampFormat dwGPSFrame::sensorTimestampFormat
Note
format of sensorTimestamp in this structure
*** valid values**: { DW_GPS_TIMESTAMP_FORMAT_UNSPECIFIED, DW_GPS_TIMESTAMP_FORMAT_PTP64, DW_GPS_TIMESTAMP_FORMAT_PTP16, DW_GPS_TIMESTAMP_FORMAT_CCPLEX_TSC }

Definition at line 503 of file GPSFrame.h.

◆ speed

float64_t dwGPSFrame::speed
Note
ID VS-91060
description Horizontal speed.
min nan max nan
freq 4 unit m/s

Definition at line 327 of file GPSFrame.h.

◆ speedAccuracy

float64_t dwGPSFrame::speedAccuracy
Note
ID VS-91190
description Accuracy of GNSS-speed estimated by GNSS-receiver.
FUTURE_IMPLEMENTED_POST_24_06 - This signal is not implemented and is effectively ignored by NDAS. It will be implemented in a future release. Implementation tracking ticket [DWVAL-3070]
min 0 max 131.069
freq 4 unit m/s

Definition at line 455 of file GPSFrame.h.

◆ spoofState

dwGPSSpoofState dwGPSFrame::spoofState
Note
ID VS-91210
description GPS Spoofing-state detected by the GNSS-receiver.
FUTURE_IMPLEMENTED_POST_24_06 - This signal is not implemented and is effectively ignored by NDAS. It will be implemented in a future release. Implementation tracking ticket [DWVAL-3070]
min nan max nan
freq 4 unit unitless
*** valid values**: { GPS_SPOOF_STATE_UNSPECIFIED, GPS_SPOOF_STATE_NO, GPS_SPOOF_STATE_YES, GPS_SPOOF_STATE_MULTI, GPS_SPOOF_STATE_INIT }

Definition at line 483 of file GPSFrame.h.

◆ timestamp_us

dwTime_t dwGPSFrame::timestamp_us
Note
ID VS-91010
description Timestamp of the message when first received.
FUTURE_DEPRECATED_24_09 This field stores timestamp which GPS frame is decoded for legacy sensors, and it stores timestamp when this frame is produced by sensor side for vehicle GPS sensors. After 24_09, this field will be deprecated and replaced by field sensorTimestamp(vehicle GPS) and hostTimestamp(legacy GPS).
min nan max nan
freq 4 unit us

Definition at line 297 of file GPSFrame.h.

◆ timestampQuality

dwGPSTimestampQuality dwGPSFrame::timestampQuality
Note
ID VS-91170
description GNSS Timestamp Quality.
FUTURE_IMPLEMENTED_POST_24_06 - This signal is not implemented and is effectively ignored by NDAS. It will be implemented in a future release. Implementation tracking ticket [DWVAL-3070]
min nan max nan
freq 4 unit unitless
*** valid values**: { DW_GPS_TIMESTAMP_QUALITY_NOT_INIT, DW_GPS_TIMESTAMP_QUALITY_OK, DW_GPS_TIMESTAMP_QUALITY_SYNC_LOST, }

Definition at line 399 of file GPSFrame.h.

◆ utcDate

char8_t dwGPSFrame::utcDate[16]

UTC date as provided in the GPS package [ddmmyy] (null terminated).

Deprecated:
utcDate is deprecated and will be removed soon. Please use utcTimeUs instead

Definition at line 428 of file GPSFrame.h.

◆ utcTime

char8_t dwGPSFrame::utcTime[16]

UTC time as provided in the GPS package [hhmmss.sss] (null terminated).

Deprecated:
utcTime is deprecated and will be removed soon. Please use utcTimeUs instead

Definition at line 423 of file GPSFrame.h.

◆ utcTimeUs

dwTime_t dwGPSFrame::utcTimeUs
Note
ID VS-91130
description UTC time.
min nan max nan
freq 4 unit us

Definition at line 369 of file GPSFrame.h.

◆ vacc

float64_t dwGPSFrame::vacc
Note
ID VS-91120
description Vertical Accuracy of Solution.
min nan max nan
freq 4 unit m

Definition at line 363 of file GPSFrame.h.

◆ validityInfo

dwGPSSignalValidityInfo dwGPSFrame::validityInfo

Signal validity information.

Definition at line 288 of file GPSFrame.h.

◆ vdop

float64_t dwGPSFrame::vdop
Note
ID VS-91090
description Vertical Dilution of Precision.
min nan max nan
freq 4 unit unitless

Definition at line 345 of file GPSFrame.h.


The documentation for this struct was generated from the following file: