slreportgen.report.Notes class

Пакет: slreportgen.report
Суперклассы: slreportgen.report.Reporter

Simulink или Stateflow замечает репортер

Описание

Создайте репортера, который сообщает о Simulink® или Stateflow® примечания к схеме.

Примечание

Как использовать Notes репортер в отчете, вы должны создать отчет с помощью slreportgen.report.Report класс.

The slreportgen.report.Notes класс является handle класс.

Атрибуты класса

HandleCompatible
true

Для получения информации об атрибутах класса см. раздел «Атрибуты класса».

Создание

Описание

notes = slreportgen.report.Notes() создает пустой slreportgen.report.Notes репортер.

пример

notes = slreportgen.report.Notes(source) создает slreportgen.report.Notes reporter для системы, заданной source и устанавливает свойство Source на source.

slreportgen.report.Notes(Name,Value) устанавливает свойства reporter с помощью пар "имя-значение". Можно задать несколько аргументы пары "имя-значение" в любом порядке. Заключайте каждое имя свойства в одинарные или двойные кавычки.

Свойства

расширить все

Источник, из которого можно извлечь заметки, заданный как строковый скаляр, вектор символов, указатель или slreportgen.finder.DiagramResult объект. Источником может быть модель, подсистема, диаграмма Stateflow, таблица истинности Stateflow или Состояние Stateflow таблица перехода.

Тип примечаний, заданный в качестве одного из значений в этой таблице:

ЗначениеОписание
'Внутренний'Содержимое примечания включается в модель и сохраняется в .mldatx файл.
'Внешний'Содержимое примечания является внешним по отношению к модели и задается URL-адресом.
'Унаследованный'Содержимое примечания происходит от предков указанного источника схемы.
НичегоСхема не имеет примечаний.

Это свойство доступно только для чтения.

Сообщать ли о примечаниях, имеющих NoteType от 'Inherit', заданный как true или false. Представленное содержимое примечания основано на типе родительского примечания, как описано в этой таблице.

Тип родительского примечанияСодержимое отчетной записки
'Внутренний'Ссылка на содержимое родительской заметки
'Внешний'Ссылка на внешнее содержимое, заданное родительской заметкой
НичегоПустое содержимое

Источник шаблона для этого репортера, заданный одним из следующих способов:

  • Вектор символов или строковый скаляр, который задает путь к файлу, содержащему шаблон для этого репортера

  • Репортер или отчет, шаблон которого используется для этого репортера или библиотека шаблонов которого содержит шаблон для этого репортера

  • DOM-документ или деталь документа, шаблон которой используется для этого репортера или библиотека шаблонов которой содержит шаблон для этого репортера

Указанный шаблон должен совпадать с типом отчета, к которому добавлен этот репортер. Для примера, для Microsoft® Отчет о словах, TemplateSrc должен быть шаблоном репортера Word. Если на TemplateSrc свойство пусто, этот репортер использует шаблон reporter по умолчанию для типа выхода отчета.

Имя шаблона для этого репортера, заданное как вектор символов или строковый скаляр. Шаблон для этого репортера должен быть в библиотеке шаблонов источника шаблона (TemplateSrc) для этого репортера.

Цель гиперссылки для этого репортера, заданная как вектор символов или строковый скаляр, задающий идентификатор цели ссылки или mlreportgen.dom.LinkTarget объект. Вектор символов или строковое скалярное значение преобразуется в LinkTarget объект. Цель ссылки непосредственно предшествует содержимому этого репортера в выход отчете.

Методы

расширить все

Примеры

свернуть все

Этот пример сообщает заметки для slreportgendemo_autotrans модель, которая является версией sldemo_autotrans модель с примечаниями. Этот пример сообщает примечания для общей модели. Для примера, который сообщает схему и примечания для каждой подсистемы модели, смотрите Примечания к модели отчета.

Пример создает главу для примечаний и включает примечания модели в главу путем добавления slreportgen.report.Notes репортер главы.

model = "slreportgendemo_autotrans";
open_system(model);

import mlreportgen.report.*
import slreportgen.report.*

rpt = slreportgen.report.Report(model + "_Notes_Report","pdf");
open(rpt);

ch = Chapter("Title", model + " Notes");
notes = Notes(model);
add(ch,notes);
add(rpt,ch);

close(rpt);
rptview(rpt);
Введенный в R2020a