slreportgen.report.SimulinkObjectProperties class

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

Генератор отчетов свойств объектов Simulink

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

Описание

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

Примечание

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

Конструкция

reporter = SimulinkObjectProperties() создает пустой генератор отчетов свойств объектов Simulink. Используйте свойства этого генератора отчетов задать создание отчетов об этих объектах Simulink:

  • Объект, чьи свойства сообщить

  • Свойства сообщить

  • Формат свойств, о которых сообщают,

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

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

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

Примечание

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

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

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

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

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

Свойства

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

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

  • модель

  • блок

  • аннотация

  • порт

  • строка

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Методы

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

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

copyСоздайте копию генератора отчетов, возражают и делают глубокие копии значений свойств, которые ссылаются на генератор отчетов, ReporterLayout или Объект DOM
getImplПолучите реализацию генератора отчетов

Примеры

Добавьте таблицу свойств, чтобы сообщить

Используйте SimulinkObjectProperties генератор отчетов, чтобы добавить таблицу свойств для 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.*
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

Поддержка

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