NVIDIA Iray API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
mi::neuraylib::IWorker_node_descriptor Class Referenceabstract

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

Inheritance diagram for mi::neuraylib::IWorker_node_descriptor:
Inheritance graph
[legend]

Public Member Functions

virtual const IString get_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 IMap get_properties () const =0
  Returns the properties of the worker node. More...
 

Additional Inherited Members

- Public Types inherited from mi::base::Interface_declare< 0x29a6d6a5, 0xfaa9, 0x48dc, 0x87, 0xc5, 0xee, 0xa5, 0x83, 0x2c, 0xe9, 0xb3 >
typedef Interface_declare< id1,
id2, id3, id4, id5, id6, id7,
id8, id9, id10, id11,
IInterface
Self
  Own type. More...
 
typedef Uuid_t< id1, id2, id3,
id4, id5, id6, id7, id8, id9,
id10, id11 > 
IID
  Declares the interface ID (IID) of this interface. More...
 
- Static Public Member Functions inherited from mi::base::Interface_declare< 0x29a6d6a5, 0xfaa9, 0x48dc, 0x87, 0xc5, 0xee, 0xa5, 0x83, 0x2c, 0xe9, 0xb3 >
static bool  compare_iid (const Uuid &iid)
  Compares the interface ID iid against the interface ID of this interface and of its ancestors. More...
 

Detailed Description

This interface describes a worker node and its properties.

Member Function Documentation

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

Returns the IP address of the worker node.

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 Iray used by the worker node.

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

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.