NVIDIA DRIVE OS Linux SDK API Reference

6.0.6 Release
nvsipl::INvSIPLQuery Class Referenceabstract

Detailed Description

Defines the public data structures and describes the interfaces for NvSIPLQuery.

Definition at line 50 of file NvSIPLQuery.hpp.

Data Structures

struct  Version
 Defines the version information for NvSIPLQuery_API. More...
 

Public Types

enum  EnableMask {
  LINK_0 = 0x0001,
  LINK_1 = 0x0010,
  LINK_2 = 0x0100,
  LINK_3 = 0x1000
}
 Defines link enable masks for deserializers. More...
 

Public Member Functions

virtual SIPLStatus ParseDatabase (void)=0
 Parses the built-in JSON database and updates the internal state of the implementation class. More...
 
virtual SIPLStatus ParseJsonFile (std::string fileName)=0
 Parses the input JSON file containing a list of user-specified camera platform configuration. More...
 
const virtual DeviceInfoListGetDeviceInfoList () const =0
 Returns a pointer to the list of all external image devices supported by NvSIPL Query and SIPL Device Block drivers. More...
 
virtual std::vector< const PlatformCfg * > GetPlatformCfgList () const =0
 Returns a list of camera platform configurations supported by NvSIPL Query and NvSIPL Camera. More...
 
virtual SIPLStatus GetPlatformCfg (std::string name, PlatformCfg &oConfig) const =0
 Returns a PlatformCfg object by name. More...
 
virtual SIPLStatus ApplyMask (PlatformCfg &platCfg, const std::vector< uint32_t > &vMasks) const =0
 Applies masks to the input platform configuration. More...
 
virtual ~INvSIPLQuery ()=default
 Default destructor. More...
 

Static Public Member Functions

static void GetVersion (Version &version)
 Returns the library version. More...
 
static std::unique_ptr< INvSIPLQueryGetInstance (void)
 Gets a handle to an instance of INvSIPLQuery. More...
 

Static Public Attributes

static constexpr uint32_t MAJOR_VER = 1u
 Indicates a major revision. More...
 
static constexpr uint32_t MINOR_VER = 0u
 Indicates a minor revision. More...
 
static constexpr uint32_t PATCH_VER = 0u
 Indicates a patch revision. More...
 

Member Enumeration Documentation

◆ EnableMask

Defines link enable masks for deserializers.

To construct a complete mask for a deserializer, perform an OR operation between the link mask values. For example, to enable link 0 and 3 of a deserializer, set the mask to LINK_0 | LINK_3.

Enumerator
LINK_0 

1st Link

LINK_1 

2nd Link

LINK_2 

3rd Link

LINK_3 

4th Link

Definition at line 241 of file NvSIPLQuery.hpp.

Constructor & Destructor Documentation

◆ ~INvSIPLQuery()

virtual nvsipl::INvSIPLQuery::~INvSIPLQuery ( )
virtualdefault

Default destructor.

Member Function Documentation

◆ ApplyMask()

virtual SIPLStatus nvsipl::INvSIPLQuery::ApplyMask ( PlatformCfg platCfg,
const std::vector< uint32_t > &  vMasks 
) const
pure virtual

Applies masks to the input platform configuration.

Creates a custom platform configuration by modifying the input platform configuration object to enable only specific links of the deserializer/deviceblock using the input masks.

Precondition
This function must be called only after ParseDatabase().
Parameters
[in,out]platCfgA reference to the platform configuration that is modified.
[in]vMasksA vector of integers describing the mask value for each deserializer in the platform configuration. The number of masks in the vector must be same as the number of deserializers in the platform configuration.
Returns
SIPLStatus The status of the operation.


Usage considerations

  • Allowed context for the API call
    • Interrupt handler: No
    • Signal handler: No
    • Thread-safe: No
    • Re-entrant: No
    • Async/Sync: Sync
  • Required privileges: No
  • API group
    • Init: Yes
    • Runtime: No
    • De-Init: No

◆ GetDeviceInfoList()

const virtual DeviceInfoList* nvsipl::INvSIPLQuery::GetDeviceInfoList ( ) const
pure virtual

Returns a pointer to the list of all external image devices supported by NvSIPL Query and SIPL Device Block drivers.

Precondition
This function must be called only after ParseDatabase().
Returns
A const pointer to DeviceInfoList.


Usage considerations

  • Allowed context for the API call
    • Interrupt handler: No
    • Signal handler: No
    • Thread-safe: No
    • Re-entrant: No
    • Async/Sync: Sync
  • Required privileges: No
  • API group
    • Init: Yes
    • Runtime: No
    • De-Init: No

◆ GetInstance()

static std::unique_ptr<INvSIPLQuery> nvsipl::INvSIPLQuery::GetInstance ( void  )
static

Gets a handle to an instance of INvSIPLQuery.

This static function creates an instance of INvSIPLQuery and returns a handle to the object. The object is automatically destroyed when the variable holding the return value goes out of scope.

Precondition
None.
Returns
unique_ptr A pointer to an instance of INvSIPLQuery.


Usage considerations

  • Allowed context for the API call
    • Interrupt handler: No
    • Signal handler: No
    • Thread-safe: No
    • Re-entrant: No
    • Async/Sync: Sync
  • Required privileges: No
  • API group
    • Init: Yes
    • Runtime: No
    • De-Init: No

◆ GetPlatformCfg()

virtual SIPLStatus nvsipl::INvSIPLQuery::GetPlatformCfg ( std::string  name,
PlatformCfg oConfig 
) const
pure virtual

Returns a PlatformCfg object by name.

Precondition
This function must be called only after ParseDatabase().
Returns
SIPLStatus The status of the operation.


Usage considerations

  • Allowed context for the API call
    • Interrupt handler: No
    • Signal handler: No
    • Thread-safe: No
    • Re-entrant: No
    • Async/Sync: Sync
  • Required privileges: No
  • API group
    • Init: Yes
    • Runtime: No
    • De-Init: No

◆ GetPlatformCfgList()

virtual std::vector<const PlatformCfg*> nvsipl::INvSIPLQuery::GetPlatformCfgList ( ) const
pure virtual

Returns a list of camera platform configurations supported by NvSIPL Query and NvSIPL Camera.

Precondition
This function must be called only after ParseDatabase().
Returns
A vector of const pointers to PlatformCfg.


Usage considerations

  • Allowed context for the API call
    • Interrupt handler: No
    • Signal handler: No
    • Thread-safe: No
    • Re-entrant: No
    • Async/Sync: Sync
  • Required privileges: No
  • API group
    • Init: Yes
    • Runtime: No
    • De-Init: No

◆ GetVersion()

static void nvsipl::INvSIPLQuery::GetVersion ( Version version)
static

Returns the library version.

Parameters
[out]versionA reference to the object containing the version information.
Precondition
None.


Usage considerations

  • Allowed context for the API call
    • Interrupt handler: No
    • Signal handler: No
    • Thread-safe: No
    • Re-entrant: No
    • Async/Sync: Sync
  • Required privileges: No
  • API group
    • Init: Yes
    • Runtime: No
    • De-Init: No

◆ ParseDatabase()

virtual SIPLStatus nvsipl::INvSIPLQuery::ParseDatabase ( void  )
pure virtual

Parses the built-in JSON database and updates the internal state of the implementation class.

This function must be called before any other non-static functions.

Precondition
None.
Returns
SIPLStatus The status of the operation.


Usage considerations

  • Allowed context for the API call
    • Interrupt handler: No
    • Signal handler: No
    • Thread-safe: No
    • Re-entrant: No
    • Async/Sync: Sync
  • Required privileges: No
  • API group
    • Init: Yes
    • Runtime: No
    • De-Init: No

◆ ParseJsonFile()

virtual SIPLStatus nvsipl::INvSIPLQuery::ParseJsonFile ( std::string  fileName)
pure virtual

Parses the input JSON file containing a list of user-specified camera platform configuration.

Precondition
This function must be called only after ParseDatabase().
Parameters
[in]fileNameFull name, including the path, of the JSON file containing the platform configuration. The external devices referenced in the platform configuration must be supported by the library.
Returns
SIPLStatus The status of the operation.


Usage considerations

  • Allowed context for the API call
    • Interrupt handler: No
    • Signal handler: No
    • Thread-safe: No
    • Re-entrant: No
    • Async/Sync: Sync
  • Required privileges: No
  • API group
    • Init: Yes
    • Runtime: No
    • De-Init: No

Field Documentation

◆ MAJOR_VER

constexpr uint32_t nvsipl::INvSIPLQuery::MAJOR_VER = 1u
staticconstexpr

Indicates a major revision.

Definition at line 54 of file NvSIPLQuery.hpp.

◆ MINOR_VER

constexpr uint32_t nvsipl::INvSIPLQuery::MINOR_VER = 0u
staticconstexpr

Indicates a minor revision.

Definition at line 55 of file NvSIPLQuery.hpp.

◆ PATCH_VER

constexpr uint32_t nvsipl::INvSIPLQuery::PATCH_VER = 0u
staticconstexpr

Indicates a patch revision.

Definition at line 56 of file NvSIPLQuery.hpp.


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