mlreportgen.dom.DebugMessage class

Package: mlreportgen.dom
Superclasses:

Debugging message

Description

Creates debugging message text originating from the specified source object.

Construction

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.

Output Arguments

expand all

Debug message, represented by an mlreportgen.dom.DebugMessage object.

Properties

expand all

ID for this document element, specified as a character vector. The DOM generates a session-unique ID when it creates the document element. You can specify your own ID.

Source DOM object from which the message originates.

Tag for the document element, specified as a character vector.

The DOM generates a session-unique tag when it creates the document element. Structure the tag as class:id, where class is the class of the element and id is the value of the Id property. You can specify a tag to replace the generated tag. Specifying your own tag can make it easier to identify where an issue occurred during document generation.

Message text, specified as a character vector.

Methods

Use DebugMessage methods similar to how you use ProgressMessage methods.

Method

Purpose

formatAsHTML

Format message as HTML.

formatAsText

Format message as text.

passesFilter

Determine whether message passes filter.

Examples

collapse all

Create the report document.

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

Create the listener and add to the message dispatcher.

dispatcher = MessageDispatcher.getTheDispatcher;

dispatcher.Filter.ErrorMessagesPass = true;
dispatcher.Filter.ProgressMessagesPass = false;

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

Create the message and dispatch it before opening.

msg = ErrorMessage('Invalid slide',pre);
dispatch(dispatcher, msg);

open(pre);

Add report content.

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

Run report.

close(d);
rptview('test','html');

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

delete(l);