mi::neuraylib::IMessage Class Reference

Message interface. More...

#include <imdl_execution_context.h>

Inheritance diagram for mi::neuraylib::IMessage:

Public Types
enum	Kind : Uint32 {   MSG_COMPILER_CORE ,   MSG_COMPILER_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, ... >
using	Self = Interface_declare< id1, ... >
	Own type. More...
using	IID = Uuid_t< id1, ... >
	Declares the interface ID (IID) of this interface. More...
Public Types inherited from mi::base::IInterface
using	IID = Uuid_t<0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0>
	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 IMessage *	get_note (Size index) const =0
	Returns the note at index or nullptr, if no such index exists. 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 IInterface *	get_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 IInterface *	get_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
Static Public Member Functions inherited from mi::base::Interface_declare< 0x51965a01, ... >
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

Message interface.

Member Enumeration Documentation

Kind

enum mi::neuraylib::IMessage::Kind : Uint32

The possible kinds of messages.

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

Enumerator
MSG_COMPILER_CORE	MDL Core compiler message.
MSG_COMPILER_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 (currently unused).
MSG_INTEGRATION	MDL integration message.
MSG_UNCATEGORIZED	Uncategorized message.

Member Function Documentation

get_code()

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

pure virtual

Returns a unique identifier for the message.

get_kind()

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

pure virtual

Returns the kind of message.

get_note()

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

pure virtual

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

get_notes_count()

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.

get_severity()

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

pure virtual

Returns the severity of the message.

get_string()

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

pure virtual

Returns the message string.