nv::index::IIndex_loader_configuration Class Reference

Optional configuration for how the NVIDIA IndeX library loads its dependeny shared libraries, such as DiCE. More...

#include <iindex.h>

Inherits mi::base::Interface_declare< 0x48c60a29, ... >.

Public Member Functions
virtual void	clear ()=0
	Resets the loader configuration to the defaults. More...
virtual void	add_library_search_path (const char *directory)=0
	Adds a directory to the library search list. More...
virtual void	add_library_search_origin (const char *path=0)=0
	Adds a path relative to the location of the NVIDIA IndeX shared library file to the library search list. More...
virtual void	add_library_search_default ()=0
	Adds the system's standard library search mechanism to the library search list. More...

Detailed Description

Optional configuration for how the NVIDIA IndeX library loads its dependeny shared libraries, such as DiCE.

An instance of this interface can only be retrieved from nv_factory() and configured before IIndex is first accessed.

By default the system's standard shared library search mechanism will be used, which may be affected by environment variables such as LD_LIBRARY_PATH or PATH. Alternatively, a fixed path can be specified, which may also be relative to the position of the NVIDIA IndeX shared library file. When multiple search paths/mechanism (e.g. fixed path and default) are added, then they will be tried in order.

Member Function Documentation

add_library_search_default()

virtual void nv::index::IIndex_loader_configuration::add_library_search_default ( )

pure virtual

Adds the system's standard library search mechanism to the library search list.

This will include default library search paths as well as additional paths defined, for example, by environment variables such as LD_LIBRARY_PATH or PATH.

add_library_search_origin()

virtual void nv::index::IIndex_loader_configuration::add_library_search_origin ( const char *  path = 0 )

pure virtual

Adds a path relative to the location of the NVIDIA IndeX shared library file to the library search list.

Parameters

[in]

path

Path relative to the directory containing the NVIDIA IndeX shared library. If null or empty string, the directory itself will be used.

add_library_search_path()

virtual void nv::index::IIndex_loader_configuration::add_library_search_path ( const char *  directory )

pure virtual

Adds a directory to the library search list.

Parameters

[in]

directory

Path of a directory, ignored if null or empty string.

clear()

virtual void nv::index::IIndex_loader_configuration::clear ( )

pure virtual

Resets the loader configuration to the defaults.

---

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

• iindex.h