mi::neuraylib::IScheduling_configuration Class Reference

This interface is used to query and change the scheduling configuration. More...

#include <ischeduling_configuration.h>

Inheritance diagram for mi::neuraylib::IScheduling_configuration:

Public Member Functions
virtual Sint32	set_cpu_load_limit (Float32 limit)=0
	Sets the CPU load limit. More...
virtual Float32	get_cpu_load_limit () const =0
	Returns the CPU load limit. More...
virtual Sint32	set_gpu_load_limit (Float32 limit)=0
	Sets the GPU load limit. More...
virtual Float32	get_gpu_load_limit () const =0
	Returns the GPU load limit. More...
virtual Sint32	set_thread_affinity_enabled (bool value)=0
	Sets the CPU affinity for threads. More...
virtual bool	get_thread_affinity_enabled () const =0
	Returns the CPU affinity for threads. More...
virtual Sint32	set_accept_delegations (bool value)=0
	Not supported. More...
virtual bool	get_accept_delegations () const =0
	Not supported. More...
virtual Sint32	set_work_delegation_enabled (bool value)=0
	Not supported. More...
virtual bool	get_work_delegation_enabled () const =0
	Not supported. More...
virtual Sint32	set_gpu_work_delegation_enabled (bool value)=0
	Not supported. More...
virtual bool	get_gpu_work_delegation_enabled () const =0
	Not supported. 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 IInterface *	get_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 IInterface *	get_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< 0x4f1fe336, ... >
using	Self = Interface_declare< id1, ... >
	Own type. More...
using	IID = Uuid_t< id1, ... >
	Declares the interface ID (IID) of this interface. More...
Public Types inherited from mi::base::IInterface
using	IID = Uuid_t<0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0>
	Declares the interface ID (IID) of this interface. More...
Static Public Member Functions inherited from mi::base::Interface_declare< 0x4f1fe336, ... >
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 is used to query and change the scheduling configuration.

Member Function Documentation

get_accept_delegations()

virtual bool mi::neuraylib::IScheduling_configuration::get_accept_delegations ( ) const

pure virtual

Not supported.

get_cpu_load_limit()

virtual Float32 mi::neuraylib::IScheduling_configuration::get_cpu_load_limit ( ) const

pure virtual

Returns the CPU load limit.

See also

set_cpu_load_limit()

get_gpu_load_limit()

virtual Float32 mi::neuraylib::IScheduling_configuration::get_gpu_load_limit ( ) const

pure virtual

Returns the GPU load limit.

See also

set_gpu_load_limit()

get_gpu_work_delegation_enabled()

virtual bool mi::neuraylib::IScheduling_configuration::get_gpu_work_delegation_enabled ( ) const

pure virtual

Not supported.

get_thread_affinity_enabled()

virtual bool mi::neuraylib::IScheduling_configuration::get_thread_affinity_enabled ( ) const

pure virtual

Returns the CPU affinity for threads.

See also

set_thread_affinity_enabled()

get_work_delegation_enabled()

virtual bool mi::neuraylib::IScheduling_configuration::get_work_delegation_enabled ( ) const

pure virtual

Not supported.

set_accept_delegations()

virtual Sint32 mi::neuraylib::IScheduling_configuration::set_accept_delegations ( bool  value )

pure virtual

Not supported.

set_cpu_load_limit()

virtual Sint32 mi::neuraylib::IScheduling_configuration::set_cpu_load_limit ( Float32  limit )

pure virtual

Sets the CPU load limit.

The CPU load is the sum of the CPU loads caused by all currently active threads. A single thread fully using a single CPU core is said to cause a CPU load of 1.0. The CPU load limit defaults to the number of CPU cores.

Note

If the limit is reduced, it might take some time until the current CPU load obeys the limit.

See also

get_cpu_load_limit()

Parameters

limit

The new CPU load limit.

Returns

• 0: Success
• -1: Invalid new limit (less than 1.0).

set_gpu_load_limit()

virtual Sint32 mi::neuraylib::IScheduling_configuration::set_gpu_load_limit ( Float32  limit )

pure virtual

Sets the GPU load limit.

The GPU load is the sum of the GPU loads caused by all currently active threads. A single thread fully using a single GPU is said to cause a GPU load of 1.0. The GPU load limit defaults to the number of GPUs.

Note

If the limit is reduced, it might take some time until the current GPU load obeys the limit.

See also

get_gpu_load_limit()

Parameters

limit

The new GPU load limit.

Returns

• 0: Success
• -1: Invalid new limit (less than 1.0).

set_gpu_work_delegation_enabled()

virtual Sint32 mi::neuraylib::IScheduling_configuration::set_gpu_work_delegation_enabled ( bool  value )

pure virtual

Not supported.

set_thread_affinity_enabled()

virtual Sint32 mi::neuraylib::IScheduling_configuration::set_thread_affinity_enabled ( bool  value )

pure virtual

Sets the CPU affinity for threads.

If thread affinity is enabled for a thread then this thread is bound to the CPU it is currently running on. If thread affinity is disabled (the default) the operating system is free to migrate the thread between CPUs as it sees fit (which might suffer from cache misses).

This thread affinity setting only affects internal threads that are used to execute jobs. Application threads are not affected by this setting.

Note that changing this value does not affect a job that is currently being executed, it only affects subsequently started jobs (or fragments thereof).

This method can only be used while the MDL SDK is running.

Parameters

value

Returns

• 0: Success.
• -1: Setting the thread affinity is not supported on this operating system (Linux with glibc older than 2.6 and MacOS X).
• -2: The method cannot be called at this point of time.

set_work_delegation_enabled()

virtual Sint32 mi::neuraylib::IScheduling_configuration::set_work_delegation_enabled ( bool  value )

pure virtual

Not supported.