DriveWorks SDK Reference
4.0.0 Release
For Test and Development only

RadarDecoder.h
Go to the documentation of this file.
1 // 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" NVIDIA MAKES
7 // NO REPRESENTATIONS, WARRANTIES, EXPRESSED, IMPLIED, STATUTORY, OR OTHERWISE WITH RESPECT TO
8 // THE MATERIALS, AND EXPRESSLY DISCLAIMS ANY IMPLIED WARRANTIES OF NONINFRINGEMENT,
9 // MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE.
10 //
11 // NVIDIA Corporation assumes no responsibility for the consequences of use of such
12 // information or for any infringement of patents or other rights of third parties that may
13 // result from its use. No license is granted by implication or otherwise under any patent
14 // or patent rights of NVIDIA Corporation. No third party distribution is allowed unless
15 // expressly authorized by NVIDIA. Details are subject to change without notice.
16 // This code supersedes and replaces all information previously supplied.
17 // NVIDIA Corporation products are not authorized for use as critical
18 // components in life support devices or systems without express written approval of
19 // NVIDIA Corporation.
20 //
21 // Copyright (c) 2017 NVIDIA Corporation. All rights reserved.
22 //
23 // NVIDIA Corporation and its licensors retain all intellectual property and proprietary
24 // rights in and to this software and related documentation and any modifications thereto.
25 // Any use, reproduction, disclosure or distribution of this software and related
26 // documentation without an express license agreement from NVIDIA Corporation is
27 // strictly prohibited.
28 //
30 
38 #ifndef DW_SENSORS_PLUGINS_RADAR_DECODER_H_
39 #define DW_SENSORS_PLUGINS_RADAR_DECODER_H_
40 
49 #include <dw/core/base/Types.h>
50 #include <dw/sensors/radar/Radar.h>
51 
52 #ifdef __cplusplus
53 extern "C" {
54 #endif
55 
57 typedef struct
58 {
61 
63  size_t headerSize;
64 
67 
70 
72  size_t mountSize;
74 
82 
90 
100 
114  const uint8_t* buffer,
115  const size_t length,
116  const dwRadarScanType scanType);
117 
128 dwStatus _dwRadarDecoder_synchronize(const uint8_t* buffer,
129  const size_t length,
130  size_t* remaining);
131 
143 dwStatus _dwRadarDecoder_validatePacket(const uint8_t* buffer,
144  const size_t length,
145  dwRadarScanType* scanType);
146 
160  const uint8_t** buffer,
161  size_t* length,
162  size_t numPackets);
163 
178  const size_t maxOutputSize,
179  const dwRadarVehicleState* packet);
180 
195  const size_t maxOutputSize,
196  const dwRadarMountPosition* packet);
197 
200 #ifdef __cplusplus
201 }
202 #endif
203 
204 #endif
NVIDIA DriveWorks API: Core Types
Defines the structure for reporting sensor mount position.
Definition: Radar.h:320
Defines the structure for a complete radar scan.
Definition: Radar.h:229
NVIDIA DriveWorks API: Radar
dwStatus _dwRadarDecoder_synchronize(const uint8_t *buffer, const size_t length, size_t *remaining)
Determines whether a byte array of packet data has a valid radar signature.
size_t mountSize
Size of the mount poisition message to be sent to the radar.
Definition: RadarDecoder.h:72
dwRadarProperties properties
Radar properties.
Definition: RadarDecoder.h:60
dwStatus _dwRadarDecoder_initialize()
Initializes the radar decoder.
dwStatus
Status definition.
Definition: Status.h:180
size_t headerSize
Packet header size (in bytes).
Definition: RadarDecoder.h:63
Defines the type of scan (combination of return type & range)
Definition: Radar.h:110
size_t maxPayloadSize
Packet max payload size (in bytes).
Definition: RadarDecoder.h:66
size_t vehicleStateSize
Size of the vehicle state message to be sent to the radar.
Definition: RadarDecoder.h:69
dwStatus _dwRadarDecoder_decodePacket(dwRadarScan *output, const uint8_t *buffer, const size_t length, const dwRadarScanType scanType)
Decodes a packet from the radar, given a raw byte array and a specified decoding format.
Defines the properties of the radar.
Definition: Radar.h:339
dwStatus _dwRadarDecoder_validatePacket(const uint8_t *buffer, const size_t length, dwRadarScanType *scanType)
Determines whether a byte array of packet data is valid.
dwStatus _dwRadarDecoder_encodeMountPosition(uint8_t *buffer, const size_t maxOutputSize, const dwRadarMountPosition *packet)
Encodes data from a /ref dwRadarMountPosition into a raw byte array.
dwStatus _dwRadarDecoder_getConstants(_dwRadarDecoder_constants *constants)
Gets constants associated with this radar sensor.
Holds constants for a given radar.
Definition: RadarDecoder.h:57
Defines the structure for reporting current vehicle dynamics state.
Definition: Radar.h:304
dwStatus _dwRadarDecoder_encodeVehicleState(uint8_t *buffer, const size_t maxOutputSize, const dwRadarVehicleState *packet)
Encodes data from a /ref dwRadarVehicleState into a raw byte array.
bool _dwRadarDecoder_isScanComplete(dwRadarScanType scanType, const uint8_t **buffer, size_t *length, size_t numPackets)
Returns the status of the scan.
dwStatus _dwRadarDecoder_release()
Releases the radar decoder.