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

User-defined progress callback for querying the progress of the distributed rendering or computing task. More...

#include <iprogress_callback.h>

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

Public Member Functions

virtual void set_progress (mi::Float32 progress_values)=0
 The updates to the progress will be passed to the present interface method (i.e., callback) to be processed. More...
 
virtual mi::Float32 get_progress () const =0
 The current progress of a tasks given in percent can be queried at any time. More...
 

Detailed Description

User-defined progress callback for querying the progress of the distributed rendering or computing task.

The progress of a tasks, e.g., the uploading and rendering of the data, is measured in percent in the range from 0 to 100.

IIndex_rendering::render() provides means to register a progress callback that monitors the progress for uploading and rendering the data in the cluster.

Compute tasks may benefit from the present interface class as well but need to implement their own means for monitoring the progress of the user-defined process.

Member Function Documentation

 get_progress()

virtual mi::Float32 nv::index::IProgress_callback::get_progress ( ) const
pure virtual

The current progress of a tasks given in percent can be queried at any time.

Returns
current The current progress returned in the range from 0 to 100.

 set_progress()

virtual void nv::index::IProgress_callback::set_progress ( mi::Float32  progress_values)
pure virtual

The updates to the progress will be passed to the present interface method (i.e., callback) to be processed.

A user-defined implementation of the interface class may, for instance, update the user-interface to ensure user response on the progress.

Parameters
[in]progress_valuesThe progress is updated in percent with values in the range [0, 100]. If the task is completed then 100% will be passed to the interface method.

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