DiCE API nvidia_logo_transpbg.gif Up
mi::neuraylib::IHost_properties Class Referenceabstract

This interface contains information about a local or remote host. More...

#include <ihost_properties.h>

Inheritance diagram for mi::neuraylib::IHost_properties:

Public Member Functions

virtual const IStringget_address () const =0
 Returns the address of the host described by this property instance. More...
 
virtual Size get_amount_of_memory () const =0
 Returns the amount of RAM memory in MB. More...
 
virtual Size get_cpu_count () const =0
 Returns the number of CPUs. More...
 
virtual Size get_siblings_per_cpu () const =0
 Returns the number of virtual CPUs in a hyperthreaded CPU. More...
 
virtual Size get_gpu_count () const =0
 Returns the number of GPUs. More...
 
virtual const IStringget_property (const char *key) const =0
 Generic access to properties. More...
 
virtual Uint32 get_host_id () const =0
 Returns the host ID of this host. 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< 0xac76eb08, ... >
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< 0xac76eb08, ... >
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

This interface contains information about a local or remote host.

See also
mi::neuraylib::IGeneral_configuration, mi::neuraylib::IHost_callback

Member Function Documentation

 get_address()

virtual const IString * mi::neuraylib::IHost_properties::get_address ( ) const
pure virtual

Returns the address of the host described by this property instance.

The method always returns NULL if networking support is not available.

Returns
The address, or NULL in case of failure.

 get_amount_of_memory()

virtual Size mi::neuraylib::IHost_properties::get_amount_of_memory ( ) const
pure virtual

Returns the amount of RAM memory in MB.

 get_cpu_count()

virtual Size mi::neuraylib::IHost_properties::get_cpu_count ( ) const
pure virtual

Returns the number of CPUs.

 get_gpu_count()

virtual Size mi::neuraylib::IHost_properties::get_gpu_count ( ) const
pure virtual

Returns the number of GPUs.

 get_host_id()

virtual Uint32 mi::neuraylib::IHost_properties::get_host_id ( ) const
pure virtual

Returns the host ID of this host.

 get_property()

virtual const IString * mi::neuraylib::IHost_properties::get_property ( const char *  key) const
pure virtual

Generic access to properties.

This method provides access to a string map of additional information. To access it, call it with the key for the desired value. The current list of supported keys is as follows:

  • "admin_http_server_address"
    The admin http server address:port of the host.
  • "host_name"
    The host name of the host.
  • "memory_size"
    The amount of RAM memory in MB on the host.
  • "cpu_count"
    The number of CPUs on the host.
  • "siblings_per_cpu"
    The number of virtual CPUs in a hyperthreaded CPU on the host.
  • "gpu_count"
    The number of GPUs on the host.
  • "cuda_device_count"
    Number of CUDA-capable devices on the host.
  • "uptime"
    The number of seconds since DiCE was started.
  • "rtmp_port" (*)
    The port which the last RTMP server started is listening to.

(*) These properties are only supported for the local host, not for remote hosts.

The method always returns NULL if networking support is not available.

Parameters
keyThe key for the property wished for
Returns
The value of the property, or NULL in case of failure.

 get_siblings_per_cpu()

virtual Size mi::neuraylib::IHost_properties::get_siblings_per_cpu ( ) const
pure virtual

Returns the number of virtual CPUs in a hyperthreaded CPU.