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

This interface represents the result of an export operation. More...

#include <iexport_result.h>

Inheritance diagram for mi::neuraylib::IExport_result_ext:

Public Member Functions

virtual Sint32 set_message (Uint32 number, base::Message_severity severity, const char *message)=0
 Replaces all messages by the given message number, severity, and message. More...
 
virtual Sint32 message_push_back (Uint32 number, base::Message_severity severity, const char *message)=0
 Appends a message number, severity, and message to the array of recorded message numbers, severities, and messages. More...
 
virtual Sint32 set_message (Size index, Uint32 number, base::Message_severity severity, const char *message)=0
 Replaces a message number, severity, and message in the array of recorded message numbers, severities, and messages. More...
 
virtual void clear_messages ()=0
 Removes all messages. More...
 
virtual Sint32 append_messages (const IExport_result *export_result)=0
 Appends all messages in export_result to this instance. More...
 
- Public Member Functions inherited from mi::neuraylib::IExport_result
virtual Uint32 get_error_number () const =0
 Returns the number of the first error. More...
 
virtual const char * get_error_message () const =0
 Returns the message of the first error. More...
 
virtual Size get_messages_length () const =0
 Returns the number of messages. More...
 
virtual Uint32 get_message_number (Size index) const =0
 Returns the message number for a given message from the array of messages. More...
 
virtual const char * get_message (Size index) const =0
 Returns a message from the array of messages. More...
 
virtual base::Message_severity get_message_severity (Size index) const =0
 Returns the severity for a given message from the array of messages. 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< 0xfbf13ba1, ... >
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::Interface_declare< 0xb900251e, ... >
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< 0xfbf13ba1, ... >
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::Interface_declare< 0xb900251e, ... >
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 represents the result of an export operation.

It is derived from the mi::neuraylib::IExport_result interface and is intended to be used by exporter writers. In addition to the mi::neuraylib::IExport_result interface it provides methods to set all values.

See mi::neuraylib::IExport_api::export_scene() and mi::neuraylib::IExport_api::export_elements() for common message numbers. Numbers in the range 6000-7999 are reserved for exporter-specific messages. All other numbers are reserved for other purposes.

Note
In case of a successful export operation the array of messages should not contain an explicit message with message number 0. If there are no other exporter-specific messages, messages, the message array should then just be empty, such that mi::neuraylib::IExport_result::get_error_number() returns 0 and mi::neuraylib::IExport_result::get_error_message() returns NULL.