NVIDIA DRIVE OS Linux API Reference

5.1.6.1 Release
For Test and Development only

 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
nvsipl::INvSIPLDeviceBlock Class Referenceabstract

Detailed Description

Defines the public data structures and interfaces for NvSIPL DeviceBlock.

Definition at line 232 of file NvSIPLDeviceBlock.hpp.

Data Structures

struct  CameraModuleProperty
 Defines camera module properties. More...
 
struct  DeviceBlockProperty
 Defines DeviceBlock properties. More...
 
struct  Version
 Defines NvSIPL DeviceBlock (libnvsipl_devblk.so) version information. More...
 

Public Member Functions

virtual SIPLStatus SetConfig (const DeviceBlockInfo *deviceBlockInfo)=0
 Sets the configuration for DeviceBlockInfo. More...
 
virtual SIPLStatus Init (void)=0
 Initializes NvSIPL DeviceBlock (libnvsipl_devblk.so) for the selected configuration. More...
 
virtual SIPLStatus Start (void)=0
 Starts streaming from the sensors. More...
 
virtual SIPLStatus Stop (void)=0
 Stops streaming from the sensors. More...
 
virtual SIPLStatus Deinit (void)=0
 Deinitializes NvSIPL DeviceBlock (libnvsipl_devblk.so). More...
 
virtual SIPLStatus GetProperty (DeviceBlockProperty &property) const =0
 Gets the properties of the NvSIPL DeviceBlock (libnvsipl_devblk.so) after initializing with a specific DeviceBlockInfo configuration. More...
 
virtual SIPLStatus WaitForError (void)=0
 Waits for an error to occur. More...
 
virtual SIPLStatus DetectErrors (std::uint8_t &cameraModules)=0
 Detects errors on the cameras device(s). More...
 
virtual SIPLStatus ReconfigureModule (std::uint8_t cameraModules)=0
 Recovers from a camera module error. More...
 
virtual ~INvSIPLDeviceBlock ()=default
 Default destructor. More...
 

Static Public Member Functions

static void GetVersion (Version &version)
 Gets the version of the library. More...
 
static std::unique_ptr
< INvSIPLDeviceBlock
Create (void)
 Creates an instance of INvSIPLDeviceBlock implementation and returns a handle. More...
 

Static Public Attributes

static constexpr std::uint32_t MAJOR_VER = 0U
 Indicates a major revision. More...
 
static constexpr std::uint32_t MINOR_VER = 0U
 Indicates a minor revision. More...
 
static constexpr std::uint32_t PATCH_VER = 0U
 Indicates a patch revision. More...
 

Constructor & Destructor Documentation

virtual nvsipl::INvSIPLDeviceBlock::~INvSIPLDeviceBlock ( )
virtualdefault

Default destructor.

Member Function Documentation

static std::unique_ptr<INvSIPLDeviceBlock> nvsipl::INvSIPLDeviceBlock::Create ( void  )
static

Creates an instance of INvSIPLDeviceBlock implementation and returns a handle.

Static function to create an instance of the implementation class and return a handle. The object is automatically destroyed when the variable holding the return value goes out of scope.

Returns
unique_ptr A pointer to the INvSIPLDeviceBlock instance.
virtual SIPLStatus nvsipl::INvSIPLDeviceBlock::Deinit ( void  )
pure virtual

Deinitializes NvSIPL DeviceBlock (libnvsipl_devblk.so).

Returns
The completion status of the operation.
virtual SIPLStatus nvsipl::INvSIPLDeviceBlock::DetectErrors ( std::uint8_t &  cameraModules)
pure virtual

Detects errors on the cameras device(s).

The output can be used to recover from an error on the camera module(s).

Parameters
[out]cameraModulesCamera module(s) that have an error.
Returns
The completion status of the operation.
virtual SIPLStatus nvsipl::INvSIPLDeviceBlock::GetProperty ( DeviceBlockProperty property) const
pure virtual

Gets the properties of the NvSIPL DeviceBlock (libnvsipl_devblk.so) after initializing with a specific DeviceBlockInfo configuration.

The output properties can be used to create and manage image processing pipelines.

Parameters
[out]propertyA reference to a DeviceBlockProperty.
Returns
The completion status of the operation.
static void nvsipl::INvSIPLDeviceBlock::GetVersion ( Version version)
static

Gets the version of the library.

Parameters
[out]versionA reference to the object containing the version information.
virtual SIPLStatus nvsipl::INvSIPLDeviceBlock::Init ( void  )
pure virtual

Initializes NvSIPL DeviceBlock (libnvsipl_devblk.so) for the selected configuration.

This function must be called after SetConfig().

Returns
The completion status of the operation.
virtual SIPLStatus nvsipl::INvSIPLDeviceBlock::ReconfigureModule ( std::uint8_t  cameraModules)
pure virtual

Recovers from a camera module error.

Must be called after DetectErrors().

Parameters
[in]cameraModulesCamera module(s) to reocver from an error.
Returns
The completion status of the operation.
virtual SIPLStatus nvsipl::INvSIPLDeviceBlock::SetConfig ( const DeviceBlockInfo deviceBlockInfo)
pure virtual

Sets the configuration for DeviceBlockInfo.

Parameters
[in]deviceBlockInfoA const pointer to a DeviceBlockInfo object.
Returns
The completion status of the operation.
virtual SIPLStatus nvsipl::INvSIPLDeviceBlock::Start ( void  )
pure virtual

Starts streaming from the sensors.

This function must be called after Init().

Returns
The completion status of the operation.
virtual SIPLStatus nvsipl::INvSIPLDeviceBlock::Stop ( void  )
pure virtual

Stops streaming from the sensors.

Returns
The completion status of the operation.
virtual SIPLStatus nvsipl::INvSIPLDeviceBlock::WaitForError ( void  )
pure virtual

Waits for an error to occur.

A blocking function call that waits for an error to occur on the camera modules.

Returns
The completion status of the operation.

Field Documentation

constexpr std::uint32_t nvsipl::INvSIPLDeviceBlock::MAJOR_VER = 0U
static

Indicates a major revision.

Definition at line 303 of file NvSIPLDeviceBlock.hpp.

constexpr std::uint32_t nvsipl::INvSIPLDeviceBlock::MINOR_VER = 0U
static

Indicates a minor revision.

Definition at line 305 of file NvSIPLDeviceBlock.hpp.

constexpr std::uint32_t nvsipl::INvSIPLDeviceBlock::PATCH_VER = 0U
static

Indicates a patch revision.

Definition at line 307 of file NvSIPLDeviceBlock.hpp.


The documentation for this class was generated from the following file: