Abstract interface to report progress of a long-running operation back to the caller. More...
Public Member Functions | |
virtual void | progress (Float64 value, const char *area, const char *message)=0 |
The callback method that provides the progress information. More... |
|
Additional Inherited Members | |
Public Types inherited from mi::base::Interface_declare< 0xa0f0f12b, 0xa3e9, 0x47d1, 0xb7, 0x1b, 0xb9, 0x67, 0xf5, 0x97, 0x11, 0xca > | |
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< 0xa0f0f12b, 0xa3e9, 0x47d1, 0xb7, 0x1b, 0xb9, 0x67, 0xf5, 0x97, 0x11, 0xca > | |
static bool | compare_iid (const Uuid &iid) |
Compares the interface ID iid against the interface ID of this interface and of its ancestors. More... |
|
Abstract interface to report progress of a long-running operation back to the caller.
Typically, an instance of this interface is passed to methods triggering long-running operations. The operation can now regularly call the progress() method of this instance to provide information about the progress of the operation to the caller.
For example, an instance of this interface can be passed to mi::neuraylib::IRender_context::render() and mi::neuraylib::IRender_context::render_async().
|
pure virtual |
The callback method that provides the progress information.
It can be called at any time from any thread.
value | This is some value which gives information about how much the work progressed. The interpretation depends on the area string. In some areas it might be a percentage, in some it might be an absolute value. |
area | This describes the area where progress has been made. |
message | This is a free form message which might be present and gives additional information about the progress in text form. |