MDL SDK API nvidia_logo_transpbg.gif Up
mi::neuraylib::IMdl_compatibility_api Class Referenceabstract

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

#include <imdl_compatibility_api.h>

Inheritance diagram for mi::neuraylib::IMdl_compatibility_api:

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...
 
- Public Member Functions inherited from mi::base::IInterface
virtual Uint32 retain () const =0
 Increments the reference count. More...
 
virtual Uint32 release () const =0
 Decrements the reference count. More...
 
virtual const IInterfaceget_interface (const Uuid &interface_id) const =0
 Acquires a const interface from another. More...
 
template<class T>
const T * get_interface () const
 Acquires a const interface from another. More...
 
virtual IInterfaceget_interface (const Uuid &interface_id)=0
 Acquires a mutable interface from another. More...
 
template<class T>
T * get_interface ()
 Acquires a mutable interface from another. More...
 
virtual Uuid get_iid () const =0
 Returns the interface ID of the most derived interface. More...
 

Additional Inherited Members

- Public Types inherited from mi::base::Interface_declare< 0x5f094722, ... >
typedef Interface_declare< id1, ... > Self
 Own type. More...
 
typedef Uuid_t< id1, ... > IID
 Declares the interface ID (IID) of this interface. More...
 
- Public Types inherited from mi::base::IInterface
typedef Uuid_t<0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0> IID
 Declares the interface ID (IID) of this interface. More...
 
- Static Public Member Functions inherited from mi::base::Interface_declare< 0x5f094722, ... >
static bool compare_iid (const Uuid &iid)
 Compares the interface ID iid against the interface ID of this interface and of its ancestors. More...
 
- Static Public Member Functions inherited from mi::base::IInterface
static bool compare_iid (const Uuid &iid)
 Compares the interface ID iid against the interface ID of this interface. More...
 

Detailed Description

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

Member Function Documentation

 compare_archives()

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.

 compare_modules()

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.