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 |
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.
|
virtualdefault |
|
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.
| [in,out] | sysConfig | A reference to the sensor system configuration that is modified. |
| [in] | vMasks | A 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. |
Usage considerations
|
pure virtual |
Returns a list of camera configuration names.
|
pure virtual |
Returns a pointer to the list of all external image devices supported by NvSIPLCameraQuery API and SIPL Device Block drivers.
const pointer to CameraDeviceInfoList.
Usage considerations
|
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.
Usage considerations
|
pure virtual |
Returns a ModuleConfig object by name.
| [in] | name | Name of the module configuration to retrieve. |
| [out] | oConfig | A reference to the module configuration object. |
Usage considerations
|
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.
| [in] | name | Name of the module template to use. |
| [out] | oConfig | A reference to the sensor system configuration object. |
Usage considerations
|
pure virtual |
Returns transport settings by name.
| [in] | name | Name of the transport settings to retrieve. |
| [out] | oSettings | A reference to the transport configuration object. |
Usage considerations
|
static |
Returns the library version.
| [out] | version | A reference to the object containing the version information. |
Usage considerations
|
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.
Usage considerations
|
pure virtual |
Parses the input JSON file containing a list of user-specified camera configurations.
| [in] | fileName | Full 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. |
Usage considerations
|
staticconstexpr |
Definition at line 55 of file NvSIPLCameraQuery.hpp.
|
staticconstexpr |
Definition at line 56 of file NvSIPLCameraQuery.hpp.
|
staticconstexpr |
Definition at line 57 of file NvSIPLCameraQuery.hpp.