DriveWorks SDK Reference

| 0.6.67 Release

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 
46 #ifndef DW_SENSORS_PLUGINS_RADAR_DECODER_H__
47 #define DW_SENSORS_PLUGINS_RADAR_DECODER_H__
48 
49 #include <dw/core/Types.h>
50 #include <dw/sensors/radar/Radar.h>
51 
52 #ifdef __cplusplus
53 extern "C" {
54 #endif
55 
57 typedef struct {
60 
62  size_t headerSize;
63 
66 
69 
71  size_t mountSize;
73 
81 
89 
99 
113  const uint8_t *buffer,
114  const size_t length,
115  const dwRadarScanType scanType);
116 
127 dwStatus _dwRadarDecoder_synchronize(const uint8_t *buffer,
128  const size_t length,
129  size_t *remaining);
130 
142 dwStatus _dwRadarDecoder_validatePacket(const uint8_t *buffer,
143  const size_t length,
144  dwRadarScanType *scanType);
145 
159  const uint8_t **buffer,
160  size_t *length,
161  size_t numPackets);
162 
177  const size_t maxOutputSize,
178  const dwRadarVehicleState *packet);
179 
194  const size_t maxOutputSize,
195  const dwRadarMountPosition *packet);
196 
199 #ifdef __cplusplus
200 }
201 #endif
202 
203 #endif
NVIDIA DriveWorks API: Core Types
Defines the structure for reporting sensor mount position.
Definition: Radar.h:301
Defines the structure for a complete radar scan.
Definition: Radar.h:263
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:71
dwRadarProperties properties
Radar properties.
Definition: RadarDecoder.h:59
dwBool _dwRadarDecoder_isScanComplete(dwRadarScanType scanType, const uint8_t **buffer, size_t *length, size_t numPackets)
Returns the status of the scan.
dwStatus _dwRadarDecoder_initialize()
Initializes the radar decoder.
dwStatus
Status definition.
Definition: Status.h:167
size_t headerSize
Packet header size (in bytes).
Definition: RadarDecoder.h:62
Defines the type of scan (combination of return type & range)
Definition: Radar.h:111
size_t maxPayloadSize
Packet max payload size (in bytes).
Definition: RadarDecoder.h:65
size_t vehicleStateSize
Size of the vehicle state message to be sent to the radar.
Definition: RadarDecoder.h:68
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:322
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.
uint8_t dwBool
Definition: Types.h:79
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:285
dwStatus _dwRadarDecoder_encodeVehicleState(uint8_t *buffer, const size_t maxOutputSize, const dwRadarVehicleState *packet)
Encodes data from a /ref dwRadarVehicleState into a raw byte array.
dwStatus _dwRadarDecoder_release()
Releases the radar decoder.