ObjectArray.h File Reference

Detailed Description

NVIDIA DriveWorks API: World Module

Description: This file defines the world module data structures and APIs.

Note

SW Release Applicability: These APIs are available in NVIDIA DRIVE Software releases.

Definition in file ObjectArray.h.

Go to the source code of this file.

Data Structures
struct	dwObjectArray
	Homogeneous array of structs. More...

Enumerations
enum	dwObjectType {   DW_OBJECT_TYPE_CAMERA = 0,   DW_OBJECT_TYPE_LIDAR = 1,   DW_OBJECT_TYPE_RADAR = 2,   DW_OBJECT_TYPE_FUSED = 3,   DW_OBJECT_TYPE_FREESPACE = 4,   DW_OBJECT_TYPE_TRAFFICSIGNAL = 5,   DW_OBJECT_TYPE_MAX_COUNT = 6 }
	List of object types known to dwObjectArray. More...

Functions
DW_API_PUBLIC dwStatus	dwObjectArray_copyDetailsToObstacle (dwObjectArray *inout)
	Copy object details field to obstacle field in each of the elements of the array. More...
DW_API_PUBLIC dwStatus	dwObjectArray_create (dwObjectArray *array, uint32_t maxObjectCount, dwObjectType objectType)
	Populate a dwObjectArray struct. More...
DW_API_PUBLIC dwStatus	dwObjectArray_destroy (dwObjectArray *array)
	Destroy memory in a dwObjectArray struct. More...
DW_API_PUBLIC dwStatus	dwObjectArray_fromLaneAssignmentArray (dwObjectArray *out, const dwLaneAssignmentArray *assignments)
	Copy lane assignment array into object array. More...
DW_API_PUBLIC dwStatus	dwObjectArray_fromObstacleArray (dwObjectArray *out, const dwObstacleArray *obstacles, const dwLaneAssignmentArray *assignments)
	Copy obstacle array and lane assignment array into object array. More...
DW_API_PUBLIC dwStatus	dwObjectArray_toObstacleArray (dwObstacleArray *outObstacles, dwLaneAssignmentArray *outAssignments, const dwObjectArray *in)
	Copy object array to obstacle array and lane assignment array. More...

---

Data Structure Documentation

dwObjectArray

struct dwObjectArray

Data Fields
uint32_t	count
uint32_t	maxCount
void *	objects
dwObjectType	objectType

Enumeration Type Documentation

dwObjectType

enum dwObjectType

List of object types known to dwObjectArray.

Enumerator
DW_OBJECT_TYPE_CAMERA	Camera object.
DW_OBJECT_TYPE_LIDAR	Lidar object.
DW_OBJECT_TYPE_RADAR	Radar object.
DW_OBJECT_TYPE_FUSED	Fused object.
DW_OBJECT_TYPE_FREESPACE	Freespace object.
DW_OBJECT_TYPE_TRAFFICSIGNAL	Traffic signal object.
DW_OBJECT_TYPE_MAX_COUNT	Max number of object types.

Definition at line 55 of file ObjectArray.h.

Function Documentation

dwObjectArray_copyDetailsToObstacle()

DW_API_PUBLIC dwStatus dwObjectArray_copyDetailsToObstacle

(

dwObjectArray *

inout

)

Copy object details field to obstacle field in each of the elements of the array.

Parameters

[in,out]

inout

The object array.

Returns

DW_INVALID_ARGUMENT
DW_SUCCESS

dwObjectArray_create()

DW_API_PUBLIC dwStatus dwObjectArray_create	(	dwObjectArray *	array,
		uint32_t	maxObjectCount,
		dwObjectType	objectType
	)

Populate a dwObjectArray struct.

Parameters

[in,out]	array	The object array.
[in]	maxObjectCount	The max amount of objects to create.
[in]	objectType	The type of object to create in the array.

Returns

DW_SUCCESS
DW_INVALID_ARGUMENT

dwObjectArray_destroy()

DW_API_PUBLIC dwStatus dwObjectArray_destroy

(

dwObjectArray *

array

)

Destroy memory in a dwObjectArray struct.

Parameters

[in,out]

array

The object array.

Returns

DW_SUCCESS
DW_INVALID_ARGUMENT

dwObjectArray_fromLaneAssignmentArray()

DW_API_PUBLIC dwStatus dwObjectArray_fromLaneAssignmentArray	(	dwObjectArray *	out,
		const dwLaneAssignmentArray *	assignments
	)

Copy lane assignment array into object array.

Parameters

[out]	out	The object array.
[in]	assignments	The lane assignment array.

Returns

DW_INVALID_ARGUMENT
DW_SUCCESS

dwObjectArray_fromObstacleArray()

DW_API_PUBLIC dwStatus dwObjectArray_fromObstacleArray	(	dwObjectArray *	out,
		const dwObstacleArray *	obstacles,
		const dwLaneAssignmentArray *	assignments
	)

Copy obstacle array and lane assignment array into object array.

Parameters

[out]	out	The object array.
[in]	obstacles	The obstacle array.
[in]	assignments	The lane assignment array.

Returns

DW_INVALID_ARGUMENT
DW_SUCCESS

dwObjectArray_toObstacleArray()

DW_API_PUBLIC dwStatus dwObjectArray_toObstacleArray	(	dwObstacleArray *	outObstacles,
		dwLaneAssignmentArray *	outAssignments,
		const dwObjectArray *	in
	)

Copy object array to obstacle array and lane assignment array.

Parameters

[out]	outObstacles	The obstacle array.
[out]	outAssignments	The lane assignment array.
[in]	in	The object array.

Returns

DW_INVALID_ARGUMENT
DW_SUCCESS