Main Content

mlreportgen.dom.DebugMessage Class

Namespace: mlreportgen.dom

Debugging message

Description

Creates debugging message text originating from the specified source object.

The mlreportgen.dom.DebugMessage class is a handle class.

Creation

Description

example

debugMsgObj = DebugMessage(text,sourceObject) creates a debugging message with the specified text, originating from the specified source object.

Input Arguments

expand all

The text to display for the message.

The DOM object from which the message originates.

Properties

expand all

Object identifier for mlreportgen.dom.DebugMessage object, specified as a character vector or string scalar. The DOM API generates a session-unique identifier when it creates the document element object. You can specify your own value for Id.

Attributes:

NonCopyable
true

Data Types: char | string

Source DOM object from which the message originates.

Tag for mlreportgen.dom.DebugMessage object, specified as a character vector or string scalar. The DOM API generates a session-unique tag as part of the creation of this object. The generated tag has the form CLASS:ID, where CLASS is the object class and ID is the value of the Id property of the object. Specify your own tag value to help you identify where to look when an issue occurs during document generation.

Attributes:

NonCopyable
true

Data Types: char | string

Message text, specified as a character vector.

Methods

expand all

Examples

collapse all

Create the report document.

import mlreportgen.dom.*;
d = Document("test","html");

Create the listener and add it to the message dispatcher.

dispatcher = MessageDispatcher.getTheDispatcher;
dispatcher.Filter.DebugMessagesPass = true;

l = addlistener(dispatcher,"Message", ...
      @(src, evtdata) disp(evtdata.Message.formatAsText));

Add report content.

open(d);

p = Paragraph("Chapter ");
p.Tag = "chapter title";
p.Style = {CounterInc("chapter"),...
    CounterReset("table"),WhiteSpace("pre") };
append(p,AutoNumber("chapter"));
append(d,p);

Generate the report.

close(d);
rptview(d);

Delete the listener to avoid duplicate reporting of message objects during a MATLAB® session.

delete(l);

Version History

Introduced in R2014b