Iray SDK API nvidia_logo_transpbg.gif Up
mi::neuraylib::ICluster_manager_node Class Referenceabstract

Provides information about a node which is part of a node pool or reserved cluster. More...

#include <icluster_manager_configuration.h>

Inheritance diagram for mi::neuraylib::ICluster_manager_node:

Public Member Functions

virtual const char * get_node_name ()=0
 Returns the node name of the node. More...
 
virtual const char * get_ip_address ()=0
 Returns the IP address of the node. More...
 
virtual const char * get_user_name ()=0
 Returns the name of a user which has currently reserved the node, or NULL if the node is free. More...
 
virtual Size get_cpu_count ()=0
 Returns the number of CPU cores installed in the node. More...
 
virtual Float32 get_cpu_load ()=0
 Returns the current CPU load on the node in percent. More...
 
virtual Size get_total_main_memory ()=0
 Returns the total amount of main memory in bytes on the node. More...
 
virtual Size get_free_main_memory ()=0
 Returns the amount of free main memory in bytes on the node. More...
 
virtual Size get_gpu_count ()=0
 Returns the number of GPUs installed in the node. More...
 
virtual Float32 get_gpu_load ()=0
 Returns the current GPU load on the node in percent. More...
 
virtual Size get_total_gpu_memory ()=0
 Returns the total amount of GPU memory (per GPU). More...
 
virtual Size get_free_gpu_memory ()=0
 Returns the amount of free GPU memory (per GPU). More...
 
- Public Member Functions inherited from mi::base::IInterface
virtual Uint32 retain () const =0
 Increments the reference count. More...
 
virtual Uint32 release () const =0
 Decrements the reference count. More...
 
virtual const IInterfaceget_interface (const Uuid &interface_id) const =0
 Acquires a const interface from another. More...
 
template<class T>
const T * get_interface () const
 Acquires a const interface from another. More...
 
virtual IInterfaceget_interface (const Uuid &interface_id)=0
 Acquires a mutable interface from another. More...
 
template<class T>
T * get_interface ()
 Acquires a mutable interface from another. More...
 
virtual Uuid get_iid () const =0
 Returns the interface ID of the most derived interface. More...
 

Additional Inherited Members

- Public Types inherited from mi::base::Interface_declare< 0x6b1cbc68, ... >
typedef Interface_declare< id1, ... > Self
 Own type. More...
 
typedef Uuid_t< id1, ... > IID
 Declares the interface ID (IID) of this interface. More...
 
- Public Types inherited from mi::base::IInterface
typedef Uuid_t<0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0> IID
 Declares the interface ID (IID) of this interface. More...
 
- Static Public Member Functions inherited from mi::base::Interface_declare< 0x6b1cbc68, ... >
static bool compare_iid (const Uuid &iid)
 Compares the interface ID iid against the interface ID of this interface and of its ancestors. More...
 
- Static Public Member Functions inherited from mi::base::IInterface
static bool compare_iid (const Uuid &iid)
 Compares the interface ID iid against the interface ID of this interface. More...
 

Detailed Description

Provides information about a node which is part of a node pool or reserved cluster.

See also
mi::neuraylib::ICluster_manager_cluster::get_cluster_node(), mi::neuraylib::ICluster_pool_information::get_node()

Member Function Documentation

 get_cpu_count()

virtual Size mi::neuraylib::ICluster_manager_node::get_cpu_count ( )
pure virtual

Returns the number of CPU cores installed in the node.

 get_cpu_load()

virtual Float32 mi::neuraylib::ICluster_manager_node::get_cpu_load ( )
pure virtual

Returns the current CPU load on the node in percent.

 get_free_gpu_memory()

virtual Size mi::neuraylib::ICluster_manager_node::get_free_gpu_memory ( )
pure virtual

Returns the amount of free GPU memory (per GPU).

This is an average over all installed GPUs. The assumption is that all GPUs have the same amount of memory and GPU memory usage is equal on all GPUs.

 get_free_main_memory()

virtual Size mi::neuraylib::ICluster_manager_node::get_free_main_memory ( )
pure virtual

Returns the amount of free main memory in bytes on the node.

 get_gpu_count()

virtual Size mi::neuraylib::ICluster_manager_node::get_gpu_count ( )
pure virtual

Returns the number of GPUs installed in the node.

 get_gpu_load()

virtual Float32 mi::neuraylib::ICluster_manager_node::get_gpu_load ( )
pure virtual

Returns the current GPU load on the node in percent.

This is an average over all installed GPUs.

 get_ip_address()

virtual const char * mi::neuraylib::ICluster_manager_node::get_ip_address ( )
pure virtual

Returns the IP address of the node.

 get_node_name()

virtual const char * mi::neuraylib::ICluster_manager_node::get_node_name ( )
pure virtual

Returns the node name of the node.

 get_total_gpu_memory()

virtual Size mi::neuraylib::ICluster_manager_node::get_total_gpu_memory ( )
pure virtual

Returns the total amount of GPU memory (per GPU).

The assumption is that all GPUs have the same amount of memory.

 get_total_main_memory()

virtual Size mi::neuraylib::ICluster_manager_node::get_total_main_memory ( )
pure virtual

Returns the total amount of main memory in bytes on the node.

 get_user_name()

virtual const char * mi::neuraylib::ICluster_manager_node::get_user_name ( )
pure virtual

Returns the name of a user which has currently reserved the node, or NULL if the node is free.