DriveWorks SDK Reference
5.12.103 Release
For Test and Development only

RadarDecoder.h
Go to the documentation of this file.
1
2//
3// Notice
4// ALL NVIDIA DESIGN SPECIFICATIONS AND CODE ("MATERIALS") ARE PROVIDED "AS IS" NVIDIA MAKES
5// NO REPRESENTATIONS, WARRANTIES, EXPRESSED, IMPLIED, STATUTORY, OR OTHERWISE WITH RESPECT TO
6// THE MATERIALS, AND EXPRESSLY DISCLAIMS ANY IMPLIED WARRANTIES OF NONINFRINGEMENT,
7// MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE.
8//
9// NVIDIA CORPORATION & AFFILIATES assumes no responsibility for the consequences of use of such
10// information or for any infringement of patents or other rights of third parties that may
11// result from its use. No license is granted by implication or otherwise under any patent
12// or patent rights of NVIDIA CORPORATION & AFFILIATES. No third party distribution is allowed unless
13// expressly authorized by NVIDIA. Details are subject to change without notice.
14// This code supersedes and replaces all information previously supplied.
15// NVIDIA CORPORATION & AFFILIATES products are not authorized for use as critical
16// components in life support devices or systems without express written approval of
17// NVIDIA CORPORATION & AFFILIATES.
18//
19// SPDX-FileCopyrightText: Copyright (c) 2017-2021 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
20// SPDX-License-Identifier: LicenseRef-NvidiaProprietary
21//
22// NVIDIA CORPORATION, its affiliates and licensors retain all intellectual
23// property and proprietary rights in and to this material, related
24// documentation and any modifications thereto. Any use, reproduction,
25// disclosure or distribution of this material and related documentation
26// without an express license agreement from NVIDIA CORPORATION or
27// its affiliates is 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>
51
52#ifdef __cplusplus
53extern "C" {
54#endif
55
57typedef 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
129 const size_t length,
130 size_t* remaining);
131
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
dwStatus
Status definition.
Definition: ErrorDefs.h:45
Defines the structure for reporting sensor mount position.
Definition: RadarTypes.h:291
Defines the properties of the radar.
Definition: RadarTypes.h:310
Defines the type of scan (combination of return type & range)
Definition: RadarTypes.h:101
Defines the structure for reporting current vehicle dynamics state.
Definition: RadarTypes.h:275
NVIDIA DriveWorks API: Radar
NVIDIA DriveWorks API: Core Types
Defines the structure for a complete radar scan.
Definition: Radar.h:66
dwRadarProperties properties
Radar properties.
Definition: RadarDecoder.h:60
size_t headerSize
Packet header size (in bytes).
Definition: RadarDecoder.h:63
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
size_t mountSize
Size of the mount poisition message to be sent to the radar.
Definition: RadarDecoder.h:72
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.
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.
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_initialize()
Initializes the radar decoder.
dwStatus _dwRadarDecoder_getConstants(_dwRadarDecoder_constants *constants)
Gets constants associated with this radar sensor.
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.
bool _dwRadarDecoder_isScanComplete(dwRadarScanType scanType, const uint8_t **buffer, size_t *length, size_t numPackets)
Returns the status of the scan.
dwStatus _dwRadarDecoder_validatePacket(const uint8_t *buffer, const size_t length, dwRadarScanType *scanType)
Determines whether a byte array of packet data is valid.
Holds constants for a given radar.
Definition: RadarDecoder.h:58