This interface contains information about a local or remote host.
More...
#include <ihost_properties.h>
|
| typedef Interface_declare< id1, ... > | Self |
| | Own type. More...
|
| |
| typedef Uuid_t< id1, ... > | IID |
| | Declares the interface ID (IID) of this interface. More...
|
| |
| 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 bool | compare_iid (const Uuid &iid) |
| | Compares the interface ID iid against the interface ID of this interface and of its ancestors. More...
|
| |
| static bool | compare_iid (const Uuid &iid) |
| | Compares the interface ID iid against the interface ID of this interface. More...
|
| |
This interface contains information about a local or remote host.
- See also
- mi::neuraylib::IGeneral_configuration, mi::neuraylib::IHost_callback
◆ 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 the Iray SDK 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
-
| key | The 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.
Public Member Functions inherited from mi::base::IInterface