exponenta event banner

slreportgen.report.Notes класс

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

Репортер диаграмм Simulink или Stateflow

Описание

Создайте репортер для отчетов по заметкам диаграммы Simulink ® или Stateflow ®.

Примечание

Использование Notes reporter в отчете, необходимо создать отчет с помощью slreportgen.report.Report класс.

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

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

HandleCompatible
true

Сведения об атрибутах класса см. в разделе Атрибуты класса.

Создание

Описание

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

пример

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

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

Свойства

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

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

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

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

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

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

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

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

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

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

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

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

Имя шаблона для этого репортера, указанного как вектор символов или скаляр строки. Шаблон для этого репортера должен находиться в библиотеке шаблонов источника шаблона (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