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

This interface represents the return value of mi::neuraylib::IRendering_configuration::check_light_path_expressions(). More...

#include <irendering_configuration.h>

Inheritance diagram for mi::neuraylib::ILpe_check_result:

Public Member Functions

virtual Size get_messages_length () const =0
 Returns the number of error messages represented by this interface. More...
 
virtual Size get_index (Size i) const =0
 Returns the index of the light path expression in the input array that this error message applies to. More...
 
virtual bool get_color_expression_flag (Size i) const =0
 Indicates whether the error message applies to the color or alpha expression. More...
 
virtual Size get_position (Size i) const =0
 Returns the position of the offending character/token in the light path expression identified by get_index(). More...
 
virtual const char * get_message (Size i) const =0
 Returns an error message describing why the light path expression identified by get_index() is invalid. 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< 0xec3bc890, ... >
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< 0xec3bc890, ... >
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 return value of mi::neuraylib::IRendering_configuration::check_light_path_expressions().

Member Function Documentation

 get_color_expression_flag()

virtual bool mi::neuraylib::ILpe_check_result::get_color_expression_flag ( Size  i) const
pure virtual

Indicates whether the error message applies to the color or alpha expression.

 get_index()

virtual Size mi::neuraylib::ILpe_check_result::get_index ( Size  i) const
pure virtual

Returns the index of the light path expression in the input array that this error message applies to.

 get_message()

virtual const char * mi::neuraylib::ILpe_check_result::get_message ( Size  i) const
pure virtual

Returns an error message describing why the light path expression identified by get_index() is invalid.

 get_messages_length()

virtual Size mi::neuraylib::ILpe_check_result::get_messages_length ( ) const
pure virtual

Returns the number of error messages represented by this interface.

 get_position()

virtual Size mi::neuraylib::ILpe_check_result::get_position ( Size  i) const
pure virtual

Returns the position of the offending character/token in the light path expression identified by get_index().