LidarSensorPlugin.h File Reference

Detailed Description

NVIDIA DriveWorks: Lidar Sensor Plugin Interface to interact with live sensors

Description: This file defines the interfaces to be implemented for Lidar sensor plugins.

Definition in file LidarSensorPlugin.h.

Go to the source code of this file.

Data Structures
struct	dwLidarSensorPluginFunction
	Function Table exposing lidar sensor plugin functions. More...

Typedefs
typedef dwStatus(*	dwSensorLidarPlugin_sendMessage) (uint32_t const cmd, uint8_t const *const data, size_t const size, dwSensorPluginSensorHandle_t sensor)
	Send message to lidar sensor. More...
typedef dwStatus(*	dwSensorPlugin_initializeHandleEx) (dwSensorPluginSensorHandle_t *handle, char const *params, dwCodecHeaderPluginHandle_t codecHeader, dwContextHandle_t ctx)
	Initialize a new handle to the sensor managed by the plugin module, EX version which can receive codecheader as param. More...
typedef struct dwLidarSensorPluginFunction	dwLidarSensorPluginFunction
	Function Table exposing lidar sensor plugin functions. More...

Typedef Documentation

dwLidarSensorPluginFunction

typedef struct dwLidarSensorPluginFunction dwLidarSensorPluginFunction

Function Table exposing lidar sensor plugin functions.

dwSensorLidarPlugin_sendMessage

typedef dwStatus(* dwSensorLidarPlugin_sendMessage) (uint32_t const cmd, uint8_t const *const data, size_t const size, dwSensorPluginSensorHandle_t sensor)

Send message to lidar sensor.

Parameters

[in]	cmd	Identification of the message.
[in]	data	Raw payload of the message.
[in]	size	Raw payload size of the message.
[in]	sensor	Specifies the sensor to send the message data.

Returns

DW_INVALID_ARGUMENT - if the data is invalid
DW_NOT_SUPPORTED - if the sensor handle is NULL or invalid, or specified sensor doesn't support cmd or the output connection is not set
DW_FAILURE - if not able to send data out successfully
DW_SUCCESS - if send the message out to the sensor successfully

Definition at line 44 of file LidarSensorPlugin.h.

dwSensorPlugin_initializeHandleEx

typedef dwStatus(* dwSensorPlugin_initializeHandleEx) (dwSensorPluginSensorHandle_t *handle, char const *params, dwCodecHeaderPluginHandle_t codecHeader, dwContextHandle_t ctx)

Initialize a new handle to the sensor managed by the plugin module, EX version which can receive codecheader as param.

Parameters

[out]	handle	A pointer to sensor handle.
[in]	params	Specifies the parameters for the sensor.
[in]	codecHeader	A codecHeader which need to be updated in sensor init stage.
[in]	ctx	context handle.

Returns

DW_INVALID_ARGUMENT - if pointer to the sensor handle is NULL.
DW_SUCCESS

Definition at line 60 of file LidarSensorPlugin.h.