This interface represents the result of an import operation.
More...
|
virtual Sint32 |
set_rootgroup (const char *group)=0 |
|
Sets the name of the root group. More...
|
|
virtual Sint32 |
set_camera_inst (const char *camera)=0 |
|
Sets the name of the camera instance. More...
|
|
virtual Sint32 |
set_options (const char *options)=0 |
|
Sets the name of the options. More...
|
|
virtual Sint32 |
element_push_back (const char *element)=0 |
|
Appends an element to the array of recorded elements. More...
|
|
virtual Sint32 |
set_element (Size index, const char *element)=0 |
|
Replaces an element in the array of recorded elements. More...
|
|
virtual void |
clear_elements ()=0 |
|
Removes all elements. More...
|
|
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_elements (const IImport_result *import_result)=0 |
|
Appends all elements in import_result to this instance. More...
|
|
virtual Sint32 |
append_messages (const IImport_result *import_result)=0 |
|
Appends all messages in import_result to this instance. More...
|
|
|
typedef Interface_declare< id1,
id2, id3, id4, id5, id6, id7,
id8, id9, id10, id11,
neuraylib::IImport_result > |
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 bool |
compare_iid (const Uuid &iid) |
|
Compares the interface ID iid against the interface ID of this interface and of its ancestors. More...
|
|
This interface represents the result of an import operation.
It is derived from the mi::neuraylib::IImport_result interface and is intended to be used by importer writers. In addition to the mi::neuraylib::IImport_result interface it provides methods to set all values.
See mi::neuraylib::IImport_api::import_elements() for common message numbers. Numbers in the range 4000-5999 are reserved for importer-specific messages. All other numbers are reserved for other purposes.
- Note
- In case of a successful Import operation the array of messages should not contain an explicit message with message number 0. If there are no other importer-specific messages, messages, the message array should then just be empty, such that mi::neuraylib::IImport_result::get_error_number() returns 0 and mi::neuraylib::IImport_result::get_error_message() returns
NULL
.
virtual Sint32 mi::neuraylib::IImport_result_ext::append_elements |
( |
const IImport_result * |
import_result) |
|
|
|
pure virtual |
Appends all elements in import_result
to this instance.
- Returns
-
- 0: Success.
- -1: Invalid parameters (
NULL
pointer).
virtual Sint32 mi::neuraylib::IImport_result_ext::append_messages |
( |
const IImport_result * |
import_result) |
|
|
|
pure virtual |
Appends all messages in import_result
to this instance.
- Returns
-
- 0: Success.
- -1: Invalid parameters (
NULL
pointer).
virtual void mi::neuraylib::IImport_result_ext::clear_elements |
( |
) |
|
|
|
pure virtual |
virtual void mi::neuraylib::IImport_result_ext::clear_messages |
( |
) |
|
|
|
pure virtual |
virtual Sint32 mi::neuraylib::IImport_result_ext::element_push_back |
( |
const char * |
element) |
|
|
|
pure virtual |
Appends an element to the array of recorded elements.
- Parameters
-
element |
The name of the element to append. |
- Returns
-
- 0: Success.
- -1: Invalid parameters (
NULL
pointer).
Appends a message number, severity, and message to the array of recorded message numbers, severities, and messages.
- Parameters
-
number |
The message number to append. |
severity |
The message severity to append. |
message |
The message to append. |
- Returns
-
- 0: Success.
- -1: Invalid parameters (
NULL
pointer).
- See Also
-
mi::neuraylib::IImport_result_ext for valid message numbers
virtual Sint32 mi::neuraylib::IImport_result_ext::set_camera_inst |
( |
const char * |
camera) |
|
|
|
pure virtual |
Sets the name of the camera instance.
- Returns
-
- 0: Success.
- -1: Invalid parameters (
NULL
pointer).
virtual Sint32 mi::neuraylib::IImport_result_ext::set_element |
( |
Size |
index, |
|
|
const char * |
element |
|
) |
|
|
|
pure virtual |
Replaces an element in the array of recorded elements.
The operation is skipped if index
is out of bounds.
- Parameters
-
index |
The index of the element to be replaced. |
element |
The name of the element element to be replaced. |
- Returns
-
- 0: Success.
- -1: Invalid parameters (
NULL
pointer).
- -2:
index
is out of bounds.
Replaces a message number, severity, and message in the array of recorded message numbers, severities, and messages.
- Parameters
-
index |
The index of the message to be replaced. |
number |
The message number to append. |
severity |
The message severity to append. |
message |
The message to append. |
- Returns
-
- 0: Success.
- -1: Invalid parameters (
NULL
pointer).
- -2:
index
is out of bounds.
- See Also
-
mi::neuraylib::IImport_result_ext for valid message numbers
virtual Sint32 mi::neuraylib::IImport_result_ext::set_options |
( |
const char * |
options) |
|
|
|
pure virtual |
Sets the name of the options.
- Returns
-
- 0: Success.
- -1: Invalid parameters (
NULL
pointer).
virtual Sint32 mi::neuraylib::IImport_result_ext::set_rootgroup |
( |
const char * |
group) |
|
|
|
pure virtual |
Sets the name of the root group.
- Returns
-
- 0: Success.
- -1: Invalid parameters (
NULL
pointer).