slreportgen.report.Notes class

Пакет: slreportgen.report

Simulink или Stateflow схематически изображают генератор отчетов примечаний

Описание

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

Примечание

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

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

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

HandleCompatible
true

Для получения информации об атрибутах класса см. Атрибуты класса (MATLAB).

Создание

Описание

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.
'Наследованный'Обратите внимание, что содержимое происходит от предков заданного источника схемы.
'none'Схема не имеет примечаний.

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

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

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

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

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

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

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

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

Имя шаблона для этого генератора отчетов в виде вектора символов или строкового скаляра. Шаблон для этого генератора отчетов находится в библиотеке шаблонов источника шаблона (TemplateSrc) для этого генератора отчетов.

Цель гиперссылки для этого генератора отчетов в виде вектора символов или строкового скаляра, который задает ID цели ссылки или 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

Для просмотра документации необходимо авторизоваться на сайте