Exponenta Banner
exponenta event banner

Отчеты по блокам DocBlock

Открыть сценарий в реальном времени

В этом примере показано, как включить содержимое блоков Simulink DocBlock в отчет Microsoft ® Word, созданный API Report. Пример модели ,slreportgen_demo_docblockсодержит только блоки DocBlock с одним блоком для каждого типа документа DocBlock:

  • RTF

  • HTML

  • Текст

В созданном отчете содержимое блоков DocBlock выглядит следующим образом:

Импортируйте пакеты API так, чтобы можно было ссылаться на классы API по их неквалифицированным именам, то есть без имен пакетов классов, в которых они находятся.

import mlreportgen.report.*
import slreportgen.report.*
import slreportgen.finder.*
import mlreportgen.dom.*

Загрузите модель для этого примера. 

model = 'slreportgen_demo_docblock';
load_system(model);

Создайте контейнер для хранения содержимого отчета. Чтобы избежать ошибки компиляции из-за модели, содержащей только виртуальные блоки, установите значение CompileModelBeforeReporting свойство объекта отчета для false.

rpt = slreportgen.report.Report('ModelDoc', 'docx');
rpt.CompileModelBeforeReporting = false;

Добавление титульной страницы и оглавления.

add(rpt,TitlePage('Title',sprintf('%s Model Documentation',model)));
add(rpt,TableOfContents);

Поиск и циклический перебор всех систем в модели.

finder = SystemDiagramFinder(model);
for system = find(finder)

Создайте главу для каждой системы. Включите имя системы в заголовок главы. Эта глава используется для создания отчета о содержимом DocBlock системы.

    ch = Chapter('Title',sprintf('System %s', system.Name));

Найдите все блоки DocBlock в текущей системе. Каждый результат возвращает репортер DocBlock для найденного DocBlock. add метод вызывает репортер DocBlock.

    docBlockFinder = BlockFinder(system);
    docBlockFinder.Properties = {'MaskType', 'DocBlock'}';
    results = find(docBlockFinder);
    if ~isempty(results)
        add(ch, results);
        else
        add(ch, "This system does not have documentation.");
    end
    add(rpt,ch)
end

Закройте и просмотрите отчет.

close(rpt);
close_system(model);
rptview(rpt);

См. также

| | | |

Связанные темы

Документация по генератору отчетов Simulink

Поддержка