Material Definition Language API nvidia_logo_transpbg.gif Up
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
mi::neuraylib::IMdl_compatibility_api Class Referenceabstract

Provides access to various functions to inspect the compatibility between MDL modules and archives. More...

Inheritance diagram for mi::neuraylib::IMdl_compatibility_api:
mi::base::Interface_declare< 0x5f094722, 0xfe19, 0x4372, 0x92, 0xcf, 0x5d, 0x9f, 0x57, 0xa7, 0x6, 0x98 > mi::base::IInterface

Public Member Functions

virtual Sint32 compare_modules (const char *module_name, const char *repl_file_name, const IArray *search_paths, IMdl_execution_context *context) const =0
 Compares one original module with an replacement module for compatibility. More...
 
virtual Sint32 compare_archives (const char *archive_fname1, const char *archive_fname2, const IArray *search_paths, IMdl_execution_context *context) const =0
 Compares two archives for compatibility. More...
 

Additional Inherited Members

- Public Types inherited from mi::base::Interface_declare< 0x5f094722, 0xfe19, 0x4372, 0x92, 0xcf, 0x5d, 0x9f, 0x57, 0xa7, 0x6, 0x98 >
typedef Interface_declare< id1,
id2, id3, id4, id5, id6, id7,
id8, id9, id10, id11,
IInterface
Self
 Own type. More...
 
typedef Uuid_t< id1, id2, id3,
id4, id5, id6, id7, id8, id9,
id10, id11 > 
IID
 Declares the interface ID (IID) of this interface. More...
 
- Static Public Member Functions inherited from mi::base::Interface_declare< 0x5f094722, 0xfe19, 0x4372, 0x92, 0xcf, 0x5d, 0x9f, 0x57, 0xa7, 0x6, 0x98 >
static bool compare_iid (const Uuid &iid)
 Compares the interface ID iid against the interface ID of this interface and of its ancestors. More...
 

Detailed Description

Provides access to various functions to inspect the compatibility between MDL modules and archives.

Member Function Documentation

virtual Sint32 mi::neuraylib::IMdl_compatibility_api::compare_archives ( const char *  archive_fname1,
const char *  archive_fname2,
const IArray search_paths,
IMdl_execution_context context 
) const
pure virtual

Compares two archives for compatibility.

Parameters
[in]archive_fname1Path to first archive.
[in]archive_fname2Path to second archive.
[in]search_pathsAn optional array of additional search paths to consider for archive_fname2.
[out]contextAn execution context. If non-null, the context can be queried for messages after the comparison operation has finished.
Returns
  • 0: The archives are compatible.
  • -1: Invalid parameters (NULL pointer).
  • -2: An error occurred during archive comparison. Please check the context for details.
virtual Sint32 mi::neuraylib::IMdl_compatibility_api::compare_modules ( const char *  module_name,
const char *  repl_file_name,
const IArray search_paths,
IMdl_execution_context context 
) const
pure virtual

Compares one original module with an replacement module for compatibility.

Parameters
[in]module_nameThe absolute name of the original module.
[in]repl_file_namePath to the replacement module.
[in]search_pathsAn optional array of additional search paths to consider for repl_file_name.
[out]contextAn execution context. If non-null, the context can be queried for messages after the comparison operation has finished.
Returns
  • 0: The modules are compatible.
  • -1: Invalid parameters (NULL pointer).
  • -2: An error occurred during module comparison. Please check the context for details.