RealityServer Web Services API Programmer's Manual

mi::rswservices::INeuray_configuration Class Reference

[Configuration]

Description

Exposes the neuray library configuration.

Public Member Functions

virtual const char* get_admin_address() const =0
Returns the address the administration interface listens on.
virtual const char* get_cluster_base_address() const =0
Returns the base cluster address. More...
virtual mi::Uint32 get_cluster_compression_level() const =0
Returns the compression level. More...
virtual const char* get_cluster_host( mi::Uint32 index) const =0
Returns a cluster host. More...
virtual const char* get_cluster_interface() const =0
Returns the cluster interface. More...
virtual mi::Uint32 get_cluster_redundancy_level() const =0
Returns the redundancy level. More...
virtual mi::Uint32 get_cpu_load_limit() const =0
Returns the CPU load limit factor. More...
virtual bool  get_cuda_enabled() const =0
Returns whether CUDA usage is enabled or not.
virtual bool  get_cuda_gl_techniques_enabled() const =0
Returns whether CUDA GL techniques usage is enabled or not.
virtual const char* get_discovery_address() const =0
Returns the discovery address. More...
virtual const char* get_discovery_identifier() const =0
Returns the identifier. More...
virtual const char* get_gpu_assignment() const =0
Returns the GPU assignment string. More...
virtual bool  get_gpu_delegation() const =0
Returns whether GPU delegation is enabled or not. More...
virtual bool  get_gpu_driver_check() const =0
Returns whether the GPU driver version should be checked.
virtual bool  get_gpu_enabled() const =0
Returns whether GPU usage is enabled or not.
virtual bool  get_gpu_info() const =0
Get whether to display GPU info on startup. More...
virtual mi::Uint32 get_gpu_load_limit() const =0
Returns the GPU load limit factor. More...
virtual mi::Size get_import_memory_limit() const =0
Returns the high level watermark for file importing. More...
virtual const char* get_include_path( mi::Uint32 index) const =0
Returns an include path. More...
virtual const char* get_iray_render_mode() const =0
Returns the iray render mode. More...
virtual const char* get_irt_acceleration() const =0
Returns the IRT acceleration used. More...
virtual bool  get_load_ogl_renderer() const =0
Returns true we attempted to load the 'ogl' rendering plugin.
virtual const char* get_log_hosts() const =0
Retrieves the log host string. More...
virtual int  get_log_level() const =0
Returns the log level. More...
virtual mi::Sint32 get_log_priority() const =0
Returns the log priority of this host. More...
virtual mi::Uint32 get_log_rotation_dir_size() const =0
Get the max size of log directory before starting rotation.
virtual mi::Uint32 get_log_rotation_file_size() const =0
Get the max size of log file before starting rotation.
virtual const char* get_log_rotation_time( mi::Uint32 index) const =0
Get a log rotation time term. More...
virtual const char* get_log_timestamp() const =0
Returns if log entries will have a timestamp.
virtual bool  get_logcoloring_enabled() const =0
Returns whether colored logging is enabled or not.
virtual const char* get_logfile() const =0
Returns the log file name.
virtual mi::Size get_memory_high() const =0
Returns the memory usage high level watermark. More...
virtual mi::Size get_memory_low() const =0
Returns the memory usage low level watermark. More...
virtual mi::Uint32 get_multicast_ttl() const =0
Gets the multicast TTL. More...
virtual bool  get_networking() const =0
Returns true if networking is enabled.
virtual mi::neuraylib::INetwork_configuration::Mode get_networking_mode() const =0
Returns the networking mode. More...
virtual bool  get_opengl_enabled() const =0
Returns whether OpenGL usage is enabled or not.
virtual const char* get_plugin_path( mi::Uint32 index) const =0
Returns an absolute plugin path. More...
virtual const char* get_reduce_bsp_memory() const =0
Returns if bsp should reduce memory usage.
virtual const char* get_shader_path( mi::Uint32 index) const =0
Returns an absolute shader search path. More...
virtual const char* get_swap_path() const =0
Returns the absolute path to the swap directory. More...
virtual const char* get_texture_path( mi::Uint32 index) const =0
Returns an absolute texture search path. More...
virtual bool  get_trace_flag( const char* flag) const =0
Returns whether a trace flag is set or not. More...

Member Functions

virtual const char* mi::​rswservices::​INeuray_configuration::get_admin_address() const [pure virtual]

Returns the address the administration interface listens on.

virtual const char* mi::​rswservices::​INeuray_configuration::get_cluster_base_address() const [pure virtual]

Returns the base cluster address.

Returns

The first cluster multicast address.

virtual mi::Uint32 mi::​rswservices::​INeuray_configuration::get_cluster_compression_level() const [pure virtual]

Returns the compression level. This value indicates the compression level for network traffic.

Returns

A value in the range 0 to 9. A value of 0 indicates compression is disabled. The higher the value the greater the effort to compress network traffic.

virtual const char* mi::​rswservices::​INeuray_configuration::get_cluster_host( mi::Uint32 index) const [pure virtual]

Returns a cluster host.

Parameters

index
the index of the host to retrieve

Returns

the hostname or NULL if index is greater than the number of added hosts

virtual const char* mi::​rswservices::​INeuray_configuration::get_cluster_interface() const [pure virtual]

Returns the cluster interface. This is the address used for outgoing packets.

Returns

The address or NULL if none set.

virtual mi::Uint32 mi::​rswservices::​INeuray_configuration::get_cluster_redundancy_level() const [pure virtual]

Returns the redundancy level. This indicates the number of times each database element is stored on the network.

Returns

A value in the range 1 to 4. All host in a cluster must use the same value.

virtual mi::Uint32 mi::​rswservices::​INeuray_configuration::get_cpu_load_limit() const [pure virtual]

Returns the CPU load limit factor. This value is between 0 and 100 where 100 indicates full usage. A value of zero will disable CPU rendering.

virtual bool mi::​rswservices::​INeuray_configuration::get_cuda_enabled() const [pure virtual]

Returns whether CUDA usage is enabled or not.

virtual bool mi::​rswservices::​INeuray_configuration::get_cuda_gl_techniques_enabled() const [pure virtual]

Returns whether CUDA GL techniques usage is enabled or not.

virtual const char* mi::​rswservices::​INeuray_configuration::get_discovery_address() const [pure virtual]

Returns the discovery address. This is the address used for automatic host discovery.

Returns

the address or NULL if none is set

virtual const char* mi::​rswservices::​INeuray_configuration::get_discovery_identifier() const [pure virtual]

Returns the identifier. This identifier ensures only compatible or selected nodes can join the cluster.

Returns

the address or NULL if none is set

virtual const char* mi::​rswservices::​INeuray_configuration::get_gpu_assignment() const [pure virtual]

Returns the GPU assignment string.

Returns

A string which is a semicolon separated list of the form "<renderer>:<gpu_ids>", which indicated which renderer is assigned to a given GPU. If no GPUs are assigned this method returns NULL .

virtual bool mi::​rswservices::​INeuray_configuration::get_gpu_delegation() const [pure virtual]

Returns whether GPU delegation is enabled or not. Indicates if the host will delegate GPU work to other hosts.

virtual bool mi::​rswservices::​INeuray_configuration::get_gpu_driver_check() const [pure virtual]

Returns whether the GPU driver version should be checked.

virtual bool mi::​rswservices::​INeuray_configuration::get_gpu_enabled() const [pure virtual]

Returns whether GPU usage is enabled or not.

virtual bool mi::​rswservices::​INeuray_configuration::get_gpu_info() const [pure virtual]

Get whether to display GPU info on startup.

Returns

true to show, false to not

virtual mi::Uint32 mi::​rswservices::​INeuray_configuration::get_gpu_load_limit() const [pure virtual]

Returns the GPU load limit factor. This value is between 0 and 100 where 100 indicates full usage. A value of zero will disable GPU rendering.

virtual mi::Size mi::​rswservices::​INeuray_configuration::get_import_memory_limit() const [pure virtual]

Returns the high level watermark for file importing. If memory usage exceeds this value during importation the importation is aborted.

virtual const char* mi::​rswservices::​INeuray_configuration::get_include_path( mi::Uint32 index) const [pure virtual]

Returns an include path. Include paths are currently only considered when importing .mi files.

Parameters

index
the index of the path to retrieve

Returns

the path or NULL if index is greater than the number of added paths

virtual const char* mi::​rswservices::​INeuray_configuration::get_iray_render_mode() const [pure virtual]

Returns the iray render mode. The iray render mode controls how iray spreads its work load across available resources.

Returns

  • mixed : All available resources are used. This mode is not available when clustered rendering is used.
  • cuda_dynamic : Only CUDA capable GPUs are used. Load is dynamically balanced between GPUs.
  • cuda_static : Only CUDA capable GPUs are used. No automatic load balancing is done.
  • cpu : Only the available CPU cores are used.
virtual const char* mi::​rswservices::​INeuray_configuration::get_irt_acceleration() const [pure virtual]

Returns the IRT acceleration used. Acceleration trades off render performance with preprocessing time.

Returns

  • "fast_render"
  • "balanced"
  • "gpu_assisted"
virtual bool mi::​rswservices::​INeuray_configuration::get_load_ogl_renderer() const [pure virtual]

Returns true we attempted to load the 'ogl' rendering plugin.

virtual const char* mi::​rswservices::​INeuray_configuration::get_log_hosts() const [pure virtual]

Retrieves the log host string. This provides an alternate way of setting log priorities. The string returned contains a comma separated list of hostnames in priority order. Hosts earlier in the list have greater priority than those later.

Returns

the log host string or NULL if none specified.

virtual int mi::​rswservices::​INeuray_configuration::get_log_level() const [pure virtual]

Returns the log level. Any messages with a severity less than this log level are discarded.

Returns

  • mi::base::MESSAGE_SEVERITY_FATAL
  • mi::base::MESSAGE_SEVERITY_ERROR
  • mi::base::MESSAGE_SEVERITY_WARNING
  • mi::base::MESSAGE_SEVERITY_INFO
  • mi::base::MESSAGE_SEVERITY_VERBOSE
virtual mi::Sint32 mi::​rswservices::​INeuray_configuration::get_log_priority() const [pure virtual]

Returns the log priority of this host. Larger values indicate greater priority. A negative value indicates no priority specified and is equivalent to priority 0. Log priority values override any priority implied from a host list in get_log_hosts.

Returns

the log priority of this host

virtual mi::Uint32 mi::​rswservices::​INeuray_configuration::get_log_rotation_dir_size() const [pure virtual]

Get the max size of log directory before starting rotation.

virtual mi::Uint32 mi::​rswservices::​INeuray_configuration::get_log_rotation_file_size() const [pure virtual]

Get the max size of log file before starting rotation.

virtual const char* mi::​rswservices::​INeuray_configuration::get_log_rotation_time( mi::Uint32 index) const [pure virtual]

Get a log rotation time term.

Parameters

index
the index of the time term to retrieve

Returns

the time term or NULL if index is greater than the number of added terms

virtual const char* mi::​rswservices::​INeuray_configuration::get_log_timestamp() const [pure virtual]

Returns if log entries will have a timestamp.

virtual bool mi::​rswservices::​INeuray_configuration::get_logcoloring_enabled() const [pure virtual]

Returns whether colored logging is enabled or not.

virtual const char* mi::​rswservices::​INeuray_configuration::get_logfile() const [pure virtual]

Returns the log file name.

virtual mi::Size mi::​rswservices::​INeuray_configuration::get_memory_high() const [pure virtual]

Returns the memory usage high level watermark. If memory usage exceeds this value unused memory will be flushed until memory usage drops below the low level memory watermark.

virtual mi::Size mi::​rswservices::​INeuray_configuration::get_memory_low() const [pure virtual]

Returns the memory usage low level watermark. This is the value at which memory flushing will stop.

virtual mi::Uint32 mi::​rswservices::​INeuray_configuration::get_multicast_ttl() const [pure virtual]

Gets the multicast TTL.

Returns

The time to live multicast packets should have.

virtual bool mi::​rswservices::​INeuray_configuration::get_networking() const [pure virtual]

Returns true if networking is enabled.

virtual mi::neuraylib::INetwork_configuration::Mode mi::​rswservices::​INeuray_configuration::get_networking_mode() const [pure virtual]

Returns the networking mode.

Returns

  • mi::neuraylib::INetwork_configuration::MODE_OFF
  • mi::neuraylib::INetwork_configuration::MODE_TCP
  • mi::neuraylib::INetwork_configuration::MODE_UDP
  • mi::neuraylib::INetwork_configuration::MODE_TCP_WITH_DISCOVERY
virtual bool mi::​rswservices::​INeuray_configuration::get_opengl_enabled() const [pure virtual]

Returns whether OpenGL usage is enabled or not.

virtual const char* mi::​rswservices::​INeuray_configuration::get_plugin_path( mi::Uint32 index) const [pure virtual]

Returns an absolute plugin path.

Parameters

index
the index of the path to retrieve

Returns

the path or NULL if index is greater than the number of added paths

virtual const char* mi::​rswservices::​INeuray_configuration::get_reduce_bsp_memory() const [pure virtual]

Returns if bsp should reduce memory usage.

virtual const char* mi::​rswservices::​INeuray_configuration::get_shader_path( mi::Uint32 index) const [pure virtual]

Returns an absolute shader search path.

Parameters

index
the index of the path to retrieve

Returns

the path or NULL if index is greater than the number of added paths

virtual const char* mi::​rswservices::​INeuray_configuration::get_swap_path() const [pure virtual]

Returns the absolute path to the swap directory.

Returns

swap directory or NULL if none configured

virtual const char* mi::​rswservices::​INeuray_configuration::get_texture_path( mi::Uint32 index) const [pure virtual]

Returns an absolute texture search path.

Parameters

index
the index of the path to retrieve

Returns

the path or NULL if index is greater than the number of added paths

virtual bool mi::​rswservices::​INeuray_configuration::get_trace_flag( const char* flag) const [pure virtual]

Returns whether a trace flag is set or not.

Parameters

flag
the name of the flag to get. Can be one of
  • errtrace
  • gputrace
  • disktrace
  • urltrace

Returns

true if set, false if not or flag not defined.