mlreportgen.dom. Класс MessageDispatcher

Пакет: mlreportgen.dom
Суперклассы:

DOM передают диспетчера

Описание

Диспетчер для сообщений о состоянии генерации документов.

Примечание

Когда вы создаете диспетчера сообщения, API DOM сохраняет диспетчера до конца текущего сеанса MATLAB®. Удалите прослушиватели события сообщения, чтобы избежать дублирующегося создания отчетов объектов сообщения во время сеанса работы с MATLAB.

Свойства

развернуть все

(Только для чтения) значение этого свойства является фильтром, который определяет типы сообщений отправки диспетчера. Можно управлять, какие типы сообщений диспетчеризируются путем установки свойств фильтра.

ID для этого элемента документа, указанного как вектор символов. DOM генерирует уникальный идентификатор сеанса, когда он создает элемент документа. Можно задать собственный ID.

Пометьте для элемента документа, указанного как вектор символов.

Уникальный идентификатор сеанса сгенерирован как часть создания элемента документа. Сгенерированный тег имеет форму CLASS:ID, где CLASS является классом элемента, и ID является значением свойства Id объекта. Можно задать тег, чтобы заменить сгенерированный тег.

Например, чтобы облегчить идентифицировать, где проблема произошла во время генерации документов, можно задать собственное значение тега.

Методы

Метод

Цель

dispatch

Диспетчеризируйте сообщение о состоянии генерации документов.

getTheDispatcher

Получите диспетчера сообщения.

Примеры

свернуть все

Этот пример показывает, как добавить сообщение о ходе выполнения, чтобы отобразиться при генерации отчета.

Добавьте диспетчера и прослушиватель отчета.

import mlreportgen.dom.*;
doctype = 'html';
d = Document('test',doctype);
d.Tag = 'My report';
          dispatcher = MessageDispatcher.getTheDispatcher;
l = addlistener(dispatcher,'Message', ...
    @(src,evtdata) disp(evtdata.Message.formatAsText));
     
open(d);
dispatch(dispatcher,ProgressMessage('starting chapter',d));
p = Paragraph('Chapter ');
p.Tag = 'chapter title';
append(d,p);
     
close(d);
rptview('test',doctype);

Удалите прослушиватель, чтобы избежать дублирующегося создания отчетов объектов сообщения во время сеанса работы с MATLAB.

delete(l);

Проверяйте сообщения о ходе выполнения в Окно Команды MATLAB. Сообщение starting chapter появляется, в дополнение к предопределенным сообщениям о ходе выполнения DOM.