slreportgen.report.SimulinkObjectProperties class

Пакет: slreportgen.report

Репортер свойств объекта Simulink

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

Описание

The SimulinkObjectProperties reporter генерирует таблицы, в которых перечисляются свойства и значения свойств Simulink® объекты.

Примечание

Чтобы использовать репортер свойств объекта Simulink в отчете, необходимо создать отчет с помощью slreportgen.report.Report класс.

Конструкция

reporter = SimulinkObjectProperties() создает пустой репортер свойств объекта Simulink. Используйте Object свойство, чтобы задать объект для отчета.

Чтобы задать список свойств объектов Simulink, включаемых в таблицу сгенерированных свойств, используйте Properties свойство репортера. Если вы не задаете никаких свойств, репортер включает набор свойств по умолчанию, основанный на типе объекта. Например, таблица свойств для блока включает свойства, заданные его диалоговым окном параметра.

Чтобы настроить формат сгенерированной таблицы свойств, используйте PropertyTable свойство.

Примечание

Этот репортер компилирует модель, содержащую объект, который будет сообщен, если модель еще не скомпилирована. Компиляция модели необходима, чтобы распространить значения на свойства, которые не заданы, когда модель не была скомпилирована. Модель не компилируется, когда вы закрываете отчет, содержащий сгенерированную таблицу свойств.

reporter = SimulinkObjectProperties(obj) создает репортер, который генерирует таблицу, в которой перечисляются значения свойств заданного объекта Simulink.

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

Входные параметры

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

См. Свойство объекта.

Свойства

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

Объект Simulink, свойства которого для отчета заданы как путь к указанному объекту или указатель на него. The Object значение должно быть одним из следующих типов объектов:

  • модель

  • блок

  • аннотация

  • порт

  • линия

  • сегмент линии

Таблица свойств объекта reporter, заданная как mlreportgen.report.BaseTable репортер. Репортер свойств объекта использует репортер базовой таблицы для форматирования свойств объекта. Если это свойство первоначально пустое, репортер свойств объекта устанавливает свойство по умолчанию таблицы reporter. Чтобы настроить форматирование таблицы свойств, установите это свойство на базовый репортер таблицы, соответствующий вашим требованиям к форматированию.

Выбор отображения имен свойства в виде приглашений в диалоговом окне, заданный как логический. Если true и свойство появляется в диалоговом окне объекта, таблица выводит приглашение диалогового окна вместо имени свойства. В противном случае в сгенерированной таблице свойств перечисляется свойство, используя его имя свойства.

Выбор для отображения свойств с пустыми значениями.

Отображать ли свойства с пустыми значениями, задается как логическое. Если falseтаблица свойств сгенерированного объекта опускает свойства объекта, значение которых пустое. Если true, таблица включает свойства, значение которых пустое.

Имена свойств объекта, которые будут сообщаться, заданные как массив ячеек.

Массив ячеек с именами свойств объектов, которые будут сообщаться, заданный как массив ячеек со строками или векторами символов. Если вы не задаете никаких свойств, reporter определяет набор свойств для отчета.

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

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

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

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

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

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

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

Методы

createTemplate Создайте шаблон репортера свойств объекта Simulink
customizeReporter Создайте пользовательский класс свойств объекта Simulink
getClassFolder Свойства объекта Simulink класса расположение файла определения

Унаследованные методы

copyСоздайте копию объекта-репортера Simulink и сделайте глубокие копии определенных значений свойств
getImplПолучите реализацию reporter

Примеры

Добавление таблицы свойств к отчету

Используйте SimulinkObjectProperties reporter, чтобы добавить таблицу свойств для vdp модель для отчета.

import slreportgen.report.*
import mlreportgen.report.*
model_name = 'vdp';
load_system(model_name);

rpt = slreportgen.report.Report('output','pdf');
chapter = Chapter(model_name);
rptr = SimulinkObjectProperties(model_name);

add(chapter, rptr);
add(rpt, chapter);
close(rpt);
close_system(model_name);
rptview(rpt);

Задайте свойства объекта для таблицы отчетов

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

import slreportgen.report.*
import mlreportgen.report.*
model_name = 'vdp';
rpt = slreportgen.report.Report('output','pdf');
chapter = Chapter(model_name);

load_system(model_name);
ph = get_param('vdp/Mu','PortHandles');
outPort = ph.Outport;
line = get_param(outPort,'Line');
rptr = SimulinkObjectProperties(line);
rptr.Properties = {'Parent','SourcePort','StorageClass'};

add(chapter,rptr);
add(rpt,chapter);
close(rpt);
close_system(model_name);
rptview(rpt);

См. также

|

Темы

Введенный в R2017b

Simulink Report Generator

Поддержка

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