NVIDIA IndeX API nvidia_logo_transpbg.gif Up
nv::index::IError_set Class Referenceabstract

This class serves as a collection of runtime errors potentially generated during the execution of distributed NVIDIA IndeX processes such as multi-GPU or cluster-based rendering. More...

#include <ierror.h>

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

Public Member Functions

virtual bool any_errors () const =0
 This method allows for an quick and easy check if the returning NVIDIA IndeX call was successful or failed with the error set containing generated errors. More...
 
virtual mi::Uint32 get_nb_errors () const =0
 Returns the number of error interface instances contained in the error set. More...
 
virtual IErrorget_error (mi::Uint32 idx) const =0
 Allows access to single instances of IError interfaces contained in the error set. More...
 

Detailed Description

This class serves as a collection of runtime errors potentially generated during the execution of distributed NVIDIA IndeX processes such as multi-GPU or cluster-based rendering.

Member Function Documentation

 any_errors()

virtual bool nv::index::IError_set::any_errors ( ) const
pure virtual

This method allows for an quick and easy check if the returning NVIDIA IndeX call was successful or failed with the error set containing generated errors.

Returns
Returns true if the error set is containing errors, false otherwise.

 get_error()

virtual IError * nv::index::IError_set::get_error ( mi::Uint32  idx) const
pure virtual

Allows access to single instances of IError interfaces contained in the error set.

Note
Use the mi::base::Handle template to store the returned interface pointer in order to guarantee the correct destruction of the returned interface.
Parameters
[in]idxIndex of the requested IError interface instance.
Returns
Returns interface pointer to the requested error instance or a null-pointer to indicate an invalid access index.

 get_nb_errors()

virtual mi::Uint32 nv::index::IError_set::get_nb_errors ( ) const
pure virtual

Returns the number of error interface instances contained in the error set.

Returns
Returns the number of the contained runtime error instances.

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