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

Interface class that exposes the performance values and statistics of a single horizontal span. More...

#include <iperformance_values.h>

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

Public Member Functions

virtual mi::Uint32 get_span_id () const =0
 Returns the id of the span for which the present performance values have been gathered. More...
 
virtual mi::Uint32 get_cluster_node_id () const =0
 Returns the id of the cluster node that was responsible for the span compositing. More...
 
virtual mi::Uint32 get_nb_type_names () const =0
 Returns the number of type names for performance values. More...
 
virtual const char * get_type_name (mi::Uint32 index) const =0
 Returns type name string by the given index. More...
 
virtual mi::Uint64 get (const char *type_name) const =0
 Returns the value of the given performance counter. More...
 
virtual mi::Float32 get_time (const char *type_name) const =0
 Returns the value of the given performance value, interpreted as time in milliseconds. More...
 

Detailed Description

Interface class that exposes the performance values and statistics of a single horizontal span.

For each span, detailed information about the compositing time, the transferred image data (memory), the number of subcubes considered, etc. are gathered.

Member Function Documentation

 get()

virtual mi::Uint64 nv::index::IPer_span_statistics::get ( const char *  type_name) const
pure virtual

Returns the value of the given performance counter.

Parameters
[in]type_nametype name
Returns
value

 get_cluster_node_id()

virtual mi::Uint32 nv::index::IPer_span_statistics::get_cluster_node_id ( ) const
pure virtual

Returns the id of the cluster node that was responsible for the span compositing.

Returns
cluster node id

 get_nb_type_names()

virtual mi::Uint32 nv::index::IPer_span_statistics::get_nb_type_names ( ) const
pure virtual

Returns the number of type names for performance values.

Returns
number of type names

 get_span_id()

virtual mi::Uint32 nv::index::IPer_span_statistics::get_span_id ( ) const
pure virtual

Returns the id of the span for which the present performance values have been gathered.

Returns
span id

 get_time()

virtual mi::Float32 nv::index::IPer_span_statistics::get_time ( const char *  type_name) const
pure virtual

Returns the value of the given performance value, interpreted as time in milliseconds.

Parameters
[in]type_nametype name
Returns
time in milliseconds

 get_type_name()

virtual const char * nv::index::IPer_span_statistics::get_type_name ( mi::Uint32  index) const
pure virtual

Returns type name string by the given index.

Parameters
[in]indexindex of type name
Returns
statistics type name, or 0 when an invalid index is given.

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