Jetson Linux API Reference

39.2 Release
nvsipl::INvSIPLCameraQuery Class Referenceabstract

Detailed Description

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

Definition at line 52 of file NvSIPLCameraQuery.hpp.

Data Structures

struct  Version
 Holds version information for NvSIPLCameraQuery API. More...
 

Public Types

enum  EnableMask {
  LINK_0 = 0x0001,
  LINK_1 = 0x0010,
  LINK_2 = 0x0100,
  LINK_3 = 0x1000
}
 Defines link enable masks for deserializers/transports. 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 configurations. More...
 
virtual const CameraDeviceInfoList * GetDeviceInfoList () const =0
 Returns a pointer to the list of all external image devices supported by NvSIPLCameraQuery API and SIPL Device Block drivers. More...
 
virtual SIPLStatus GetModuleConfig (const std::string &name, sensorconfig::ModuleConfig &oConfig) const =0
 Returns a ModuleConfig object by name. More...
 
virtual SIPLStatus GetTransportSettings (const std::string &name, sensorconfig::TransportConfig &oSettings) const =0
 Returns transport settings by name. More...
 
virtual SIPLStatus GetSensorSystemConfig (const std::string &name, sensorconfig::SensorSystemConfig &oConfig) const =0
 Builds a complete sensor system configuration from module template. More...
 
virtual SIPLStatus ApplyMask (sensorconfig::SensorSystemConfig &sysConfig, const std::vector< uint32_t > &vMasks) const =0
 Applies masks to the input sensor system configuration. More...
 
virtual const std::vector< std::string > & GetCameraConfigNames () const =0
 Returns a list of camera configuration names. More...
 
virtual ~INvSIPLCameraQuery ()=default
 

Static Public Member Functions

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

Static Public Attributes

static constexpr uint32_t MAJOR_VER = 1u
 
static constexpr uint32_t MINOR_VER = 1u
 
static constexpr uint32_t PATCH_VER = 0u
 

Member Enumeration Documentation

◆ EnableMask

Defines link enable masks for deserializers/transports.

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 305 of file NvSIPLCameraQuery.hpp.

Constructor & Destructor Documentation

◆ ~INvSIPLCameraQuery()

virtual nvsipl::INvSIPLCameraQuery::~INvSIPLCameraQuery ( )
virtualdefault

Member Function Documentation

◆ ApplyMask()

virtual SIPLStatus nvsipl::INvSIPLCameraQuery::ApplyMask ( sensorconfig::SensorSystemConfig &  sysConfig,
const std::vector< uint32_t > &  vMasks 
) const
pure virtual

Applies masks to the input sensor system configuration.

Creates a custom configuration by modifying the input configuration object to enable only specific links of the transport using the input masks.

Precondition
This function must be called only after ParseDatabase().
Parameters
[in,out]sysConfigA reference to the sensor system configuration that is modified.
[in]vMasksA vector of integers describing the mask value for each transport in the sensor system configuration. The number of masks in the vector must be same as the number of transports in the 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
  • Allowed execution state
    • Initialization: Yes
    • Operational: No
    • Reinit/Deinit Preparation: No
    • Maturity: GA

◆ GetCameraConfigNames()

virtual const std::vector<std::string>& nvsipl::INvSIPLCameraQuery::GetCameraConfigNames ( ) const
pure virtual

Returns a list of camera configuration names.

Returns
A vector of strings containing the names of all camera configurations.

◆ GetDeviceInfoList()

virtual const CameraDeviceInfoList* nvsipl::INvSIPLCameraQuery::GetDeviceInfoList ( ) const
pure virtual

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

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


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
  • Allowed execution state
    • Initialization: Yes
    • Operational: No
    • Reinit/Deinit Preparation: No
    • Maturity: GA

◆ GetInstance()

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

Gets a handle to an instance of INvSIPLCameraQuery.

This static function creates an instance of INvSIPLCameraQuery 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 INvSIPLCameraQuery.


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
  • Allowed execution state
    • Initialization: Yes
    • Operational: No
    • Reinit/Deinit Preparation: No
    • Maturity: GA

◆ GetModuleConfig()

virtual SIPLStatus nvsipl::INvSIPLCameraQuery::GetModuleConfig ( const std::string &  name,
sensorconfig::ModuleConfig &  oConfig 
) const
pure virtual

Returns a ModuleConfig object by name.

Precondition
This function must be called only after ParseDatabase().
Parameters
[in]nameName of the module configuration to retrieve.
[out]oConfigA reference to the module configuration object.
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
  • Allowed execution state
    • Initialization: Yes
    • Operational: No
    • Reinit/Deinit Preparation: No
    • Maturity: GA

◆ GetSensorSystemConfig()

virtual SIPLStatus nvsipl::INvSIPLCameraQuery::GetSensorSystemConfig ( const std::string &  name,
sensorconfig::SensorSystemConfig &  oConfig 
) const
pure virtual

Builds a complete sensor system configuration from module template.

Creates a sensor system configuration by instantiating modules for each transport link and populating MIPI settings.

Precondition
This function must be called only after ParseDatabase().
Parameters
[in]nameName of the module template to use.
[out]oConfigA reference to the sensor system configuration object.
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
  • Allowed execution state
    • Initialization: Yes
    • Operational: No
    • Reinit/Deinit Preparation: No
    • Maturity: GA

◆ GetTransportSettings()

virtual SIPLStatus nvsipl::INvSIPLCameraQuery::GetTransportSettings ( const std::string &  name,
sensorconfig::TransportConfig &  oSettings 
) const
pure virtual

Returns transport settings by name.

Precondition
This function must be called only after ParseDatabase().
Parameters
[in]nameName of the transport settings to retrieve.
[out]oSettingsA reference to the transport configuration object.
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
  • Allowed execution state
    • Initialization: Yes
    • Operational: No
    • Reinit/Deinit Preparation: No
    • Maturity: GA

◆ GetVersion()

static void nvsipl::INvSIPLCameraQuery::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
  • Allowed execution state
    • Initialization: Yes
    • Operational: No
    • Reinit/Deinit Preparation: No
    • Maturity: GA

◆ ParseDatabase()

virtual SIPLStatus nvsipl::INvSIPLCameraQuery::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
  • Allowed execution state
    • Initialization: Yes
    • Operational: No
    • Reinit/Deinit Preparation: No
    • Maturity: GA

◆ ParseJsonFile()

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

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

Precondition
This function must be called only after ParseDatabase().
Parameters
[in]fileNameFull name, including the path, of the JSON file containing the camera configuration. The external devices referenced in the 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
  • Allowed execution state
    • Initialization: Yes
    • Operational: No
    • Reinit/Deinit Preparation: No
    • Maturity: GA

Field Documentation

◆ MAJOR_VER

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

Definition at line 55 of file NvSIPLCameraQuery.hpp.

◆ MINOR_VER

constexpr uint32_t nvsipl::INvSIPLCameraQuery::MINOR_VER = 1u
staticconstexpr

Definition at line 56 of file NvSIPLCameraQuery.hpp.

◆ PATCH_VER

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

Definition at line 57 of file NvSIPLCameraQuery.hpp.


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