Iray SDK API nvidia_logo_transpbg.gif Up
iimport_result.h
Go to the documentation of this file.
1/***************************************************************************************************
2 * Copyright 2024 NVIDIA Corporation. All rights reserved.
3 **************************************************************************************************/
6
7#ifndef MI_NEURAYLIB_IIMPORT_RESULT_H
8#define MI_NEURAYLIB_IIMPORT_RESULT_H
9
10#include <mi/base/enums.h>
12
13namespace mi {
14
15namespace neuraylib {
16
43 public base::Interface_declare<0xa47741d4,0x49c5,0x418d,0xa5,0x4b,0xa6,0xfb,0xf4,0xa0,0x91,0x44>
44{
45public:
52 virtual const char* get_rootgroup() const = 0;
53
58 virtual const char* get_camera_inst() const = 0;
59
63 virtual const char* get_options() const = 0;
64
66 virtual Size get_elements_length() const = 0;
67
69 virtual const char* get_element( Size index) const = 0;
70
82 virtual Uint32 get_error_number() const = 0;
83
93 virtual const char* get_error_message() const = 0;
94
96 virtual Size get_messages_length() const = 0;
97
100 virtual Uint32 get_message_number( Size index) const = 0;
101
104 virtual const char* get_message( Size index) const = 0;
105
109};
110
127 public base::Interface_declare<0xe43ae7a3,0x7816,0x4915,0xb1,0x98,0x42,0x12,0x1d,0x1b,0xe2,0x09,
128 neuraylib::IImport_result>
129{
130public:
136 virtual Sint32 set_rootgroup( const char* group) = 0;
137
143 virtual Sint32 set_camera_inst( const char* camera) = 0;
144
150 virtual Sint32 set_options( const char* options) = 0;
151
158 virtual Sint32 element_push_back( const char* element) = 0;
159
170 virtual Sint32 set_element( Size index, const char* element) = 0;
171
173 virtual void clear_elements() = 0;
174
185 Uint32 number, base::Message_severity severity, const char* message) = 0;
186
199 Uint32 number, base::Message_severity severity, const char* message) = 0;
200
215 Size index, Uint32 number, base::Message_severity severity, const char* message) = 0;
216
218 virtual void clear_messages() = 0;
219
225 virtual Sint32 append_elements( const IImport_result* import_result) = 0;
226
232 virtual Sint32 append_messages( const IImport_result* import_result) = 0;
233};
234
235
236/*
237@}
238*/ // end group mi_neuray_impexp
239
240} // namespace neuraylib
241
242} // namespace mi
243
244#endif // MI_NEURAYLIB_IIMPORT_RESULT_H
Mixin class template for deriving new interface declarations.
Definition: interface_declare.h:43
This interface represents the result of an import operation.
Definition: iimport_result.h:129
This interface represents the result of an import operation.
Definition: iimport_result.h:44
Basic enums.
Message_severity
Constants for possible message severities.
Definition: enums.h:31
unsigned int Uint32
32-bit unsigned integer.
Definition: types.h:49
Uint64 Size
Unsigned integral type that is large enough to hold the size of all types.
Definition: types.h:112
signed int Sint32
32-bit signed integer.
Definition: types.h:46
virtual Sint32 set_rootgroup(const char *group)=0
Sets the name of the root group.
virtual Size get_elements_length() const =0
Returns the length of the element array.
virtual const char * get_error_message() const =0
Returns the message of the first error.
virtual Sint32 set_options(const char *options)=0
Sets the name of the options.
virtual Sint32 append_messages(const IImport_result *import_result)=0
Appends all messages in import_result to this instance.
virtual void clear_messages()=0
Removes all messages.
virtual const char * get_rootgroup() const =0
Returns the name of the root group.
virtual const char * get_options() const =0
Returns the name of the options element.
virtual base::Message_severity get_message_severity(Size index) const =0
Returns the severity for a given message from the array of messages.
virtual Sint32 element_push_back(const char *element)=0
Appends an element to the array of recorded elements.
virtual Sint32 append_elements(const IImport_result *import_result)=0
Appends all elements in import_result to this instance.
virtual Uint32 get_error_number() const =0
Returns the number of the first error.
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.
virtual const char * get_camera_inst() const =0
Returns the name of the camera instance.
virtual void clear_elements()=0
Removes all elements.
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,...
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,...
virtual Size get_messages_length() const =0
Returns the number of messages.
virtual const char * get_element(Size index) const =0
Returns the name of the element indicated by index.
virtual Sint32 set_element(Size index, const char *element)=0
Replaces an element in the array of recorded elements.
virtual const char * get_message(Size index) const =0
Returns a message from the array of messages.
virtual Uint32 get_message_number(Size index) const =0
Returns the message number for a given message from the array of messages.
virtual Sint32 set_camera_inst(const char *camera)=0
Sets the name of the camera instance.
Mixin class template for deriving new interface declarations.
Common namespace for APIs of NVIDIA Advanced Rendering Center GmbH.
Definition: neuraylib.h:179