mi::neuraylib::IMessage Class Reference
[Miscellaneous MDL-related Interfaces]
Description
Message interface.
Public Enumerations
- enum Kind{ MSG_COMILER_CORE, MSG_COMILER_BACKEND, MSG_COMPILER_DAG, MSG_COMPILER_ARCHIVE_TOOL, MSG_IMP_EXP, MSG_INTEGRATION, MSG_UNCATEGORIZED, MSG_FORCE_32_BIT = 0xffffffffU}
- The possible kinds of messages. More...
Public Member Functions
- virtual Sint32 get_code() const =0
- Returns a unique identifier for the message.
- virtual Kind get_kind() const =0
- Returns the kind of message.
- virtual const IMessage* get_note( Size index) const =0
- Returns the note at index or NULL, if no such index exists.
- virtual Size get_notes_count() const =0
- Returns the number of notes associated with the message. More...
- virtual base::Message_severity get_severity() const =0
- Returns the severity of the message.
- virtual const char* get_string() const =0
- Returns the message string.
Enums
- enum mi::neuraylib::IMessage::Kind
-
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.
- MSG_FORCE_32_BIT = 0xffffffffU
Member Functions
- 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.