nv::index::IError Class Reference

The base class of all errors generated by NVIDIA IndeX. More...

#include <ierror.h>

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

Public Member Functions
virtual mi::base::Uuid	get_error_uuid () const =0
	Returns the interface ID corresponding to the actual derived error class. More...
virtual const char *	get_error_string () const =0
	Returns a descriptive string detailing the error type and possible causes for the failure. More...
virtual mi::Uint32	get_host_id () const =0
	Returns the host ID of the cluster machine causing the generation of the runtime error. More...
virtual mi::Uint32	get_device_id () const =0
	Returns the device ID of the GPU device on a specific cluster machine causing the generation of the runtime error. More...

Detailed Description

The base class of all errors generated by NVIDIA IndeX.

All errors contain information about the host and potentially the GPU device that caused the error. Additionally, each error provides a descriptive error string detailing the error type and possible causes for the failure.

Member Function Documentation

get_device_id()

virtual mi::Uint32 nv::index::IError::get_device_id ( ) const

pure virtual

Returns the device ID of the GPU device on a specific cluster machine causing the generation of the runtime error.

If the error is not related to a GPU-processing failure an invalid ID is returned with the value 0xffffffffu (or. ~0u);

Returns

The device ID of GPU-device causing the failure of a NVIDIA IndeX call or process (0xffffffffu marks an invalid device ID).

get_error_string()

virtual const char * nv::index::IError::get_error_string ( ) const

pure virtual

Returns a descriptive string detailing the error type and possible causes for the failure.

The string summarizes all available information including the host ID and possibly the GPU device ID causing the failure.

Returns

The error string describing the runtime failure.

get_error_uuid()

virtual mi::base::Uuid nv::index::IError::get_error_uuid ( ) const

pure virtual

Returns the interface ID corresponding to the actual derived error class.

This information allows for a straightforward conversion of a general IError interface instance to the specialized derived interface type.

Returns

The interface ID of the derived error class.

get_host_id()

virtual mi::Uint32 nv::index::IError::get_host_id ( ) const

pure virtual

Returns the host ID of the cluster machine causing the generation of the runtime error.

Returns

The host ID of the failing NVIDIA IndeX call or process.

---

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

• ierror.h