Material Definition Language API nvidia_logo_transpbg.gif Up
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
mi::neuraylib::IMessage Class Referenceabstract

Message interface. More...

Inheritance diagram for mi::neuraylib::IMessage:
mi::base::Interface_declare< 0x51965a01, 0xcd3f, 0x41fc, 0xb1, 0x8b, 0x8, 0x1c, 0x7b, 0x4b, 0xba, 0xb2 > mi::base::IInterface

Public Types

enum  Kind {
  MSG_COMILER_CORE,
  MSG_COMILER_BACKEND,
  MSG_COMPILER_DAG,
  MSG_COMPILER_ARCHIVE_TOOL,
  MSG_IMP_EXP,
  MSG_INTEGRATION,
  MSG_UNCATEGORIZED
}
 The possible kinds of messages. More...
 
- Public Types inherited from mi::base::Interface_declare< 0x51965a01, 0xcd3f, 0x41fc, 0xb1, 0x8b, 0x8, 0x1c, 0x7b, 0x4b, 0xba, 0xb2 >
typedef Interface_declare< id1,
id2, id3, id4, id5, id6, id7,
id8, id9, id10, id11,
IInterface
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...
 
- 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...
 

Public Member Functions

virtual Kind get_kind () const =0
 Returns the kind of message. More...
 
virtual base::Message_severity get_severity () const =0
 Returns the severity of the message. More...
 
virtual const char * get_string () const =0
 Returns the message string. More...
 
virtual Sint32 get_code () const =0
 Returns a unique identifier for the message. More...
 
virtual Size get_notes_count () const =0
 Returns the number of notes associated with the message. More...
 
virtual const IMessageget_note (Size index) const =0
 Returns the note at index or NULL, if no such index exists. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from mi::base::Interface_declare< 0x51965a01, 0xcd3f, 0x41fc, 0xb1, 0x8b, 0x8, 0x1c, 0x7b, 0x4b, 0xba, 0xb2 >
static bool compare_iid (const Uuid &iid)
 Compares the interface ID iid against the interface ID of this interface and of its ancestors. More...
 

Detailed Description

Message interface.

Member Enumeration Documentation

The possible kinds of messages.

A message can be uniquely identified by the message code and kind, except for uncategorized messages.

Enumerator
MSG_COMILER_CORE 

MDL Core compiler message.

MSG_COMILER_BACKEND 

MDL Core compiler backend message.

MSG_COMPILER_DAG 

MDL Core DAG generator message.

MSG_COMPILER_ARCHIVE_TOOL 

MDL Core archive tool message.

MSG_IMP_EXP 

MDL import/exporter message.

MSG_INTEGRATION 

MDL integration message.

MSG_UNCATEGORIZED 

Uncategorized messages do not have a code.

Member Function Documentation

virtual Sint32 mi::neuraylib::IMessage::get_code ( ) const
pure virtual

Returns a unique identifier for the message.

virtual Kind mi::neuraylib::IMessage::get_kind ( ) const
pure virtual

Returns the kind of message.

virtual const IMessage* mi::neuraylib::IMessage::get_note ( Size  index) const
pure virtual

Returns the note at index or NULL, if no such index exists.

virtual Size mi::neuraylib::IMessage::get_notes_count ( ) const
pure virtual

Returns the number of notes associated with the message.

Notes can be used to describe an error message further or add additional details.

virtual base::Message_severity mi::neuraylib::IMessage::get_severity ( ) const
pure virtual

Returns the severity of the message.

virtual const char* mi::neuraylib::IMessage::get_string ( ) const
pure virtual

Returns the message string.