Exponenta Banner
exponenta event banner

slreportgen.report.SimulinkObjectProperties класс

Пакет: slreportgen.report

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

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

Описание

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

Примечание

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

Строительство

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

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

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

Примечание

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

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

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

Входные аргументы

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

См. раздел Свойство объекта.

Свойства

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

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

  • модель

  • блок

  • аннотация

  • порт

  • линия

  • отрезок линии

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

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

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

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

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

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

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

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

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

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

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

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

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

Методы

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

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

copyСоздание копии объекта-репортера Simulink и создание глубоких копий определенных значений свойств
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.*
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

Поддержка