neuray API Programmer's Manual

mi::neuraylib::IImport_result_ext Class Reference

[Importer and Exporter]

Description

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.

mi::base::Interface_declare\< ..., neuraylib::IImport_result \>Mixin class template for deriving new interface declarations. This interface represents the result of an import operation.This interface represents the result of an import operation. mi::base::Interface_declare\< ... \>Mixin class template for deriving new interface declarations. The basic extensible interface.The basic extensible interface.

Public Member Functions

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...
virtual void clear_elements() =0
Removes all elements.
virtual void clear_messages() =0
Removes all messages.
virtual Sint32 element_push_back( const char* element) =0
Appends an element to the array of recorded elements. 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_camera_inst( const char* camera) =0
Sets the name of the camera instance. More...
virtual Sint32 set_element( Size index, const char* element) =0
Replaces an element in the array of recorded 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 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 Sint32 set_options( const char* options) =0
Sets the name of the options. More...
virtual Sint32 set_rootgroup( const char* group) =0
Sets the name of the root group. More...

Member Functions

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]

Removes all elements.

virtual void mi::​neuraylib::​IImport_result_ext::clear_messages() [pure virtual]

Removes all messages.

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).

virtual Sint32 mi::​neuraylib::​IImport_result_ext::message_push_back( Uint32 number, base::​Message_severity severity, const char* message) [pure virtual]

Appends a message number, severity, and message to the array of recorded message numbers, severities, and messages.

See also:

mi::neuraylib::IImport_result_ext for valid message numbers

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).

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.

virtual Sint32 mi::​neuraylib::​IImport_result_ext::set_message( Uint32 number, base::​Message_severity severity, const char* message) [pure virtual]

Replaces all messages by the given message number, severity, and message. Equivalent to clear_messages(), followed by message_push_back().

See also:

mi::neuraylib::IImport_result_ext for valid message numbers

Returns

  • 0: Success.
  • -1: Invalid parameters (NULL pointer).

virtual Sint32 mi::​neuraylib::​IImport_result_ext::set_message( Size index, Uint32 number, base::​Message_severity severity, const char* message) [pure virtual]

Replaces a message number, severity, and message in the array of recorded message numbers, severities, and messages.

See also:

mi::neuraylib::IImport_result_ext for valid message numbers

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.

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).