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

This class serves as a collection of all workload balancing operations that occurred and the NVIDIA IndeX produced when redistributing workload for scalable rendering and data processing. More...

#include <ibalancing_operations.h>

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

Public Member Functions

virtual const char * get_event_description () const =0
 Returns a descriptive string detailing the balancing operation. More...
 
virtual mi::Uint32 get_nb_operation () const =0
 Returns the number of workload balancing operations. More...
 
virtual const IBalancing_operationget_operation (mi::Uint32 idx) const =0
 Allows accessing each instances of IBalancing_operation interfaces that are exposed. More...
 

Detailed Description

This class serves as a collection of all workload balancing operations that occurred and the NVIDIA IndeX produced when redistributing workload for scalable rendering and data processing.

Member Function Documentation

 get_event_description()

virtual const char * nv::index::IBalancing_operations::get_event_description ( ) const
pure virtual

Returns a descriptive string detailing the balancing operation.

Returns
The description of the operation in textual form.

 get_nb_operation()

virtual mi::Uint32 nv::index::IBalancing_operations::get_nb_operation ( ) const
pure virtual

Returns the number of workload balancing operations.

Returns
Returns the number of the contained workload balancing operations.

 get_operation()

virtual const IBalancing_operation * nv::index::IBalancing_operations::get_operation ( mi::Uint32  idx) const
pure virtual

Allows accessing each instances of IBalancing_operation interfaces that are exposed.

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]idxThe index of the requested IBalancing_operation interface instance.
Returns
Returns interface pointer to the requested error instance or a null-pointer to indicate an invalid access index.

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