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

This interface describes a worker node and its properties. More...

#include <inode_manager.h>

Inheritance diagram for mi::neuraylib::IWorker_node_descriptor:

Public Member Functions

virtual const IStringget_address () const =0
 Returns the IP address of the worker node. More...
 
virtual bool is_in_cluster () const =0
 Indicates whether the worker node is currently a member of a cluster. More...
 
virtual const IMapget_properties () const =0
 Returns the properties of the worker node. 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< 0x29a6d6a5, ... >
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< 0x29a6d6a5, ... >
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 describes a worker node and its properties.

Member Function Documentation

 get_address()

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

Returns the IP address of the worker node.

 get_properties()

virtual const IMap * mi::neuraylib::IWorker_node_descriptor::get_properties ( ) const
pure virtual

Returns the properties of the worker node.

The type of the map is "Map<String>".

The following properties are defined by default.

  • "dice_host_name"
    The host name of the worker node.
  • "dice_number_of_cpus"
    The number of CPUs of the worker node.
  • "dice_number_of_gpus"
    The number of GPUs of the worker node.
  • "dice_platform_os"
    The platform/operating system identifier of the worker node.
  • "dice_platform_version"
    The version of the Iray SDK used by the worker node.

Other properties with the name prefix dice are reserved for future use.

 is_in_cluster()

virtual bool mi::neuraylib::IWorker_node_descriptor::is_in_cluster ( ) const
pure virtual

Indicates whether the worker node is currently a member of a cluster.