DriveWorks SDK Reference
5.12.103 Release
For Test and Development only

Vehicle.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) 2022-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_RIG_VEHICLE_H_
32#define DW_RIG_VEHICLE_H_
33// Generated by dwProto from vehicle.proto DO NOT EDIT BY HAND!
34// See //3rdparty/shared/dwproto/README.md for more information
35
51#include <dw/core/base/Types.h>
52
53#ifdef __cplusplus
54extern "C" {
55#endif
56
57#define DW_VEHICLE_STEER_MAP_POLY_DEGREE 5U
58#define DW_VEHICLE_STEER_MAP_POLY_DEGREE_PLUS_ONE (DW_VEHICLE_STEER_MAP_POLY_DEGREE + 1U)
59#define DW_VEHICLE_MAX_NUM_TRAILERS 1U
60#define DW_VEHICLE_THROTTLE_BRAKE_LUT_SIZE 15U
61
67
70typedef enum dwVehicleWheels {
75
79
83{
86
89
93
96
102
107
112
118
121{
126
129
133
137
141
143typedef struct dwVehicleTorqueLUT
144{
147
150
155
158
162
165{
168
172
175
178
181
184
187
190
193
196
199
202
208
211{
214
217
220
224
229
232{
235
238
242
245{
250
255
257typedef struct dwVehicleCabin
258{
262
264typedef struct dwVehicleTrailer
265{
268
271
277
280
284
286typedef struct dwGenericVehicle
287{
290
293
299
302
305
308
312
315
319 uint32_t numTrailers;
321
324typedef struct dwVehicle
325{
344
346 DW_DEPRECATED("Will be removed, unused")
348
350 DW_DEPRECATED("Will be removed, unused")
354
356 DW_DEPRECATED("Will be removed, unused")
358
360 DW_DEPRECATED("Will be removed, unused")
362
364 DW_DEPRECATED("Will be removed, unused")
370
375
381} dwVehicle;
382
383#ifdef __cplusplus
384}
385#endif
386
390#endif // DW_RIG_VEHICLE_H_
Defines a three-element floating-point vector.
Definition: MatrixTypes.h:79
NVIDIA DriveWorks API: Core Types
NVIDIA DriveWorks API: Core Exports
float float32_t
Specifies POD types.
Definition: BasicTypes.h:58
#define DW_DEPRECATED(msg)
Definition: Exports.h:66
dwVector3f inertia
Principal moments of inertia with respect to center of mass [kg m^2].
Definition: Vehicle.h:111
float32_t wheelRadius[DW_VEHICLE_NUM_WHEELS]
Radius of each individual wheel [m].
Definition: Vehicle.h:369
float32_t throttleSpeedInput[DW_VEHICLE_THROTTLE_BRAKE_LUT_SIZE]
1-d array of range of vehicle linear speed values (Throttle Look-up Table Input) [m/s]
Definition: Vehicle.h:149
float32_t height
Height of the bounding box (vertical dimension, along Z) [m].
Definition: Vehicle.h:95
float32_t maxSteeringWheelAngle
maximum steering wheel [radians]
Definition: Vehicle.h:374
float32_t axlebaseFront
Width of the front axle. [meters].
Definition: Vehicle.h:331
float32_t brakeActuatorTimeConstant
Time constant for first order + time delay brake system [s].
Definition: Vehicle.h:180
dwVector3f centerOfMass
Position of center of mass in body coordinate system [m].
Definition: Vehicle.h:106
dwVehicleAxleProperties axleFront
Properties of the front (steering) axle [m].
Definition: Vehicle.h:292
dwVehicleBodyProperties body
Properties of the cabin body.
Definition: Vehicle.h:260
float32_t centerOfMassToRearAxle
Distance between vehicle's CoM (center-of-mass) and center of the rear axle. [meters].
Definition: Vehicle.h:341
dwVehicleCabin cabin
Properties of an optional floating cabin attached to the base body.
Definition: Vehicle.h:311
float32_t frontSteeringOffset
front wheel steering offset [radians].
Definition: Vehicle.h:380
float32_t bumperRear
Distance rear axle to rear bumper. [meters].
Definition: Vehicle.h:333
int32_t ticksCountMin
Number below which counter rolls under. [-].
Definition: Vehicle.h:216
float32_t frontCorneringStiffness
front wheel cornering stiffness.
Definition: Vehicle.h:339
float32_t width
Width of the vehicle, without side mirrors. [meters].
Definition: Vehicle.h:328
float32_t throttlePedalInput[DW_VEHICLE_THROTTLE_BRAKE_LUT_SIZE]
1-d array of range of throttle pedal values (Throttle Look-up Table Input)
Definition: Vehicle.h:146
dwVehicleTorqueLUT torqueLUT
Torque lookup tables.
Definition: Vehicle.h:167
float32_t rearCorneringStiffness
rear wheel cornering stiffness.
Definition: Vehicle.h:340
float32_t driveByWireDampingRatio
Damping ratio for second order + time delay drive-by-wire / steer-by-wire [unitless].
Definition: Vehicle.h:195
float32_t centerOfMassHeight
Height of the CoM (m).
Definition: Vehicle.h:353
float32_t position
Position of axle midpoint along X-axis in corresponding vehicle coordinate system (DW_COORDINATE_SYST...
Definition: Vehicle.h:125
dwVehicleBodyProperties body
Properties of the base body (passenger car body, truck tractor chassis)
Definition: Vehicle.h:289
float32_t frontalArea
Vehicle Frontal area (m^2).
Definition: Vehicle.h:351
float32_t effectiveMass
effective mass due to vehicle rotational inertia (wheel rotation, engine, and other parts of the CVT ...
Definition: Vehicle.h:338
float32_t driveByWireTimeDelay
Drive-by-wire (steer-by-wire) time delay. [s].
Definition: Vehicle.h:342
dwVehicleAxleProperties axleFront
Properties of the front (steering) axle [m].
Definition: Vehicle.h:270
dwVector3f boundingBoxPosition
Position of bounding box origin in body coordinate system [m].
Definition: Vehicle.h:101
float32_t width
Width of the bounding box (lateral dimension, along Y) [m].
Definition: Vehicle.h:88
float32_t wheelRadiusLeft
Radius of left wheel, when facing towards the forward direction of the vehicle [m].
Definition: Vehicle.h:132
dwVehicleArticulationProperties articulation
Articulation linking trailer to leading vehicle unit.
Definition: Vehicle.h:282
dwVehicleAxleProperties axleRear
Properties of the rear axle group [m].
Definition: Vehicle.h:298
dwVehicleActuationProperties actuation
Vehicle actuation properties.
Definition: Vehicle.h:301
float32_t brakeTorqueOutput[DW_VEHICLE_THROTTLE_BRAKE_LUT_SIZE]
1-d torque Table, mapping a given brake pedal position to a torque value (Brake Look-up Table Output)
Definition: Vehicle.h:160
float32_t driveByWireTimeConstant
Drive-by-wire (steer-by-wire) time constant. [s].
Definition: Vehicle.h:343
float32_t steeringWheelToSteeringMap[DW_VEHICLE_STEER_MAP_POLY_DEGREE_PLUS_ONE]
polynomial coefficents of steering wheel angle to steering angle as given in c0 + c1*x + c2*x^2 + ....
Definition: Vehicle.h:373
int32_t ticksCountInvalid
Invalid tick count, optional value provided by vehicle in case of error, must be outside of [ticksCou...
Definition: Vehicle.h:223
float32_t corneringStiffness
Cornering stiffness for a single tire [N/rad].
Definition: Vehicle.h:139
float32_t length
Length of the vehicle. [meters].
Definition: Vehicle.h:327
float32_t mass
vehicle mass [kg].
Definition: Vehicle.h:336
float32_t widthWithMirrors
Width of the vehicle including side mirrors. [meters].
Definition: Vehicle.h:329
float32_t driveByWireTimeConstant
Time constant for first order + time delay drive-by-wire / steer-by-wire [s].
Definition: Vehicle.h:186
float32_t throttleActuatorTimeConstant
Time constant for first order + time delay throttle system [s].
Definition: Vehicle.h:174
dwVector3f inertia3D
vehicle inertia around each axis, w.r.t. its center of mass. [kg m^2]
Definition: Vehicle.h:337
float32_t axlebaseRear
Width of the rear axle. [meters].
Definition: Vehicle.h:332
float32_t speedQuantization
Wheel speed quantization.
Definition: Vehicle.h:227
float32_t height
Height of the vehicle. [meters].
Definition: Vehicle.h:326
float32_t effectiveMass
Effective mass due to rotational inertia (wheel, engine, and other parts of the CVT drivetrain) [kg].
Definition: Vehicle.h:171
float32_t aeroHeight
Equivalent height of aerodynamic force applied (m).
Definition: Vehicle.h:357
int32_t ticksPerTurn
Ticks per wheel turn. [-].
Definition: Vehicle.h:213
float32_t driveByWireNaturalFrequency
Natural frequency for second order + time delay drive-by-wire / steer-by-wire [hz].
Definition: Vehicle.h:192
float32_t track
Width of the axle, measured between center line of wheels [m].
Definition: Vehicle.h:128
float32_t brakeActuatorTimeDelay
Time delay for first order + time delay brake system [s].
Definition: Vehicle.h:183
float32_t throttleActuatorTimeDelay
Time delay for first order + time delay throttle system [s].
Definition: Vehicle.h:177
bool hasCabin
Indicates presence of a cabin.
Definition: Vehicle.h:314
dwVector3f leadingVehicleHingePosition
Position of leading vehicle hinge attach point in leading vehicle coordinate system (DW_COORDINATE_SY...
Definition: Vehicle.h:249
float32_t brakeActuatorTimeConstant
Time constant for first order lp brake system.
Definition: Vehicle.h:367
dwVehicleTorqueLUT torqueLUT
Lookup table mapping throttle and brake pedal position to torque.
Definition: Vehicle.h:368
float32_t mass
Mass [kg].
Definition: Vehicle.h:116
float32_t steeringWheelToSteeringMap[DW_VEHICLE_STEER_MAP_POLY_DEGREE_PLUS_ONE]
Polynomial relating steering wheel angle [rad] to steering angle [rad].
Definition: Vehicle.h:206
dwVehicleTrailerType type
Trailer type, either full or semi, indicates presence of front axle.
Definition: Vehicle.h:279
dwVehicleBodyProperties body
Properties of the trailer body.
Definition: Vehicle.h:267
float32_t pitchAngleGradientBrake
Suspension pitch angle gradient during braking. [deg s^2 / m].
Definition: Vehicle.h:240
float32_t driveByWireTimeDelay
Time delay for first order + time delay drive-by-wire / steer-by-wire [s].
Definition: Vehicle.h:189
float32_t throttleTorqueOutput[DW_VEHICLE_THROTTLE_BRAKE_LUT_SIZE][DW_VEHICLE_THROTTLE_BRAKE_LUT_SIZE]
2-d torque table, mapping a given throttle pedal position at a given speed to a torque value (Throttl...
Definition: Vehicle.h:154
dwVector3f trailingVehicleHingePosition
Position of trailing vehicle hinge attach point in trailer coordinate system (DW_COORDINATE_SYSTEM_VE...
Definition: Vehicle.h:253
float32_t aerodynamicDragCoeff
Aerodynamic drag coefficient.
Definition: Vehicle.h:347
float32_t wheelRadiusRight
Radius of right wheel, when facing towards the forward direction of the vehicle [m].
Definition: Vehicle.h:136
float32_t steeringCoefficient
Steering coefficient for trivial linear mapping between steering wheel and steering angle,...
Definition: Vehicle.h:335
dwVehicleSuspensionProperties suspension
Vehicle suspension properties.
Definition: Vehicle.h:304
float32_t rollAngleGradient
Suspension roll angle gradient. [deg s^2 / m].
Definition: Vehicle.h:234
dwVehicleWheelEncoderProperties wheelEncoder
Wheel encoder properties.
Definition: Vehicle.h:307
float32_t centerOfMassToFrontAxle
Distance from CoM to the front axle (m).
Definition: Vehicle.h:352
float32_t maxEnginePower
Maximum engine power in Watts.
Definition: Vehicle.h:365
int32_t ticksCountMax
Number above which counter rolls over. [-].
Definition: Vehicle.h:219
float32_t rollingResistanceCoeff
Rolling resistance coefficient.
Definition: Vehicle.h:361
float32_t wheelbase
Distance between the centers of the front and rear wheels. [meters].
Definition: Vehicle.h:330
dwVehicleTrailer trailers[DW_VEHICLE_MAX_NUM_TRAILERS]
Properties of trailer units.
Definition: Vehicle.h:318
float32_t bumperFront
Distance front axle to front bumper. [meters].
Definition: Vehicle.h:334
dwVehicleAxleProperties axleRear
Properties of the rear axle group [m].
Definition: Vehicle.h:276
bool isDriveByWireSecondOrder
Indicates whether the drive-by-wire / steer-by-wire is second-order or not.
Definition: Vehicle.h:198
float32_t widthWithoutMirrors
Width of the body without any side-mirrors, if applicable, otherwise same as width.
Definition: Vehicle.h:92
float32_t maxSteeringWheelAngle
Maximum steering wheel angle [rad].
Definition: Vehicle.h:201
uint32_t numTrailers
Stores the occupied/valid length of trailers.
Definition: Vehicle.h:319
float32_t pitchAngleGradientAccel
Suspension pitch angle gradient during acceleration. [deg s^2 / m].
Definition: Vehicle.h:237
float32_t length
Length of the bounding box (longitudinal dimension, along X) [m].
Definition: Vehicle.h:85
float32_t brakePedalInput[DW_VEHICLE_THROTTLE_BRAKE_LUT_SIZE]
1-d array of range of brake pedal values (Brake Look-up Table Input)
Definition: Vehicle.h:157
float32_t throttleActuatorTimeConstant
Time constant for first order lp throttle system.
Definition: Vehicle.h:366
dwVehicleTrailerType
Supported trailer types.
Definition: Vehicle.h:63
#define DW_VEHICLE_THROTTLE_BRAKE_LUT_SIZE
Definition: Vehicle.h:60
#define DW_VEHICLE_MAX_NUM_TRAILERS
Definition: Vehicle.h:59
#define DW_VEHICLE_STEER_MAP_POLY_DEGREE_PLUS_ONE
Definition: Vehicle.h:58
dwVehicleWheels
Define index for each of the wheels on a 4 wheeled vehicle.
Definition: Vehicle.h:70
@ DW_VEHICLE_TRAILER_TYPE_SEMI
Trailer that has both front and rear axles.
Definition: Vehicle.h:65
@ DW_VEHICLE_TRAILER_TYPE_FULL
Definition: Vehicle.h:64
@ DW_VEHICLE_WHEEL_REAR_LEFT
Definition: Vehicle.h:73
@ DW_VEHICLE_WHEEL_REAR_RIGHT
Definition: Vehicle.h:74
@ DW_VEHICLE_WHEEL_FRONT_LEFT
Definition: Vehicle.h:71
@ DW_VEHICLE_NUM_WHEELS
Number of wheels describing the vehicle.
Definition: Vehicle.h:77
@ DW_VEHICLE_WHEEL_FRONT_RIGHT
Definition: Vehicle.h:72
Vehicle description.
Definition: Vehicle.h:287
DEPRECATED: Properties of a passenger car vehicle.
Definition: Vehicle.h:325
Vehicle actuation properties.
Definition: Vehicle.h:165
Properties of an articulation linking two vehicle units.
Definition: Vehicle.h:245
Properties of an axle and its wheels.
Definition: Vehicle.h:121
Physical properties of a vehicle body.
Definition: Vehicle.h:83
Vehicle cabin description.
Definition: Vehicle.h:258
Suspension properties.
Definition: Vehicle.h:232
Throttle and brake state (input) to longitudinal force (output) lookup tables.
Definition: Vehicle.h:144
Vehicle trailer description.
Definition: Vehicle.h:265
Wheel encoder parameters.
Definition: Vehicle.h:211