exponenta event banner

класс slreportgen.report.ModelConfiguration

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

Репортер набора конфигурации модели

Описание

Использование объекта slreportgen.report.ModelConfiguration для отчета об активном наборе конфигурации модели.

Примечание

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

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

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

HandleCompatible
true

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

Создание

Описание

reporter = slreportgen.report.ModelConfiguration() создает пустой ModelConfiguration на основе шаблона по умолчанию. Необходимо указать модель, для которой необходимо сообщить активный набор конфигурации, задав свойство Модель (Model). Используйте другие свойства для задания параметров отчета.

пример

reporter = slreportgen.report.ModelConfiguration(model) создает ModelConfiguration и устанавливает свойство Model для указанной модели.

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

Свойства

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

Имя или дескриптор открытой или загруженной модели Simulink ®, указанный как строковый скаляр, символьный вектор или дескриптор.

Заголовок набора конфигурации, указанный как вектор символа, скаляр строки, mlreportgen.dom.Text объект, mlreportgen.dom.InternalLink объект, или mlreportgen.dom.ExternalLink объект.

Если свойство FormatPolicy имеет значение "Inline Text" и Title свойство имеет значение:

  • Объект DOM, форматирование, указанное объектом DOM, игнорируется

  • Один mlreportgen.dom.InternalLink или mlreportgen.dom.ExternalLink объект, текст ссылки используется для заголовка, но заголовок не является ссылкой

В обоих случаях для форматирования заголовка используйте свойство TextFormatter этого ModelConfiguration репортер.

Если заголовок не указан, за ним следует название модели. Configuration Set. Например:

slrgex_sf_car Configuration Set

Формат для сообщения о наборе конфигурации, указанный как одна из следующих строк или векторов символов:

  • "Auto" - форматирует набор конфигурации, компоненты и значения свойств в виде таблицы или абзаца в зависимости от типа данных.

    Типы данных, отформатированные как таблица, включают:

    • Массив ячеек

    • Логический массив

    • Числовой массив

    • Таблица MATLAB ®

    • Объект Simulink

    • Объект Stateflow ®

    • Графический объект

    • Структура или массив структуры MATLAB

    • Объект или массив объектов MATLAB

    Типы данных, отформатированные как абзац, включают:

    • Клеточный вектор

    • Логический скаляр или вектор

    • Числовой скаляр или вектор

    • Символьный или символьный массив

    • Последовательность

    • Вектор структуры MATLAB

    • Вектор объекта MATLAB

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

  • "Table" - форматирование значений в таблице. Типы данных, которые по умолчанию отображаются как абзацы, форматируются как записи таблицы. У типов данных, которые иерархически структурированы объекты, такие как структуры MATLAB, объекты MATLAB, объекты Симулинка, объекты Стэтефлоу или графические объекты, могут быть свойства, которые являются самостоятельно объектами. В этих случаях иерархия сглаживается, а значение свойства является гиперссылкой на таблицу свойств поля или объекта. Поле или таблица свойств связаны с исходной таблицей.

  • "Paragraph" - создает описание набора конфигурации в виде абзацев. Например:

    First paragraph is "Source Type :Model". Second paragraph is "Source Name: slrgex_sf_car". Third paragraph is "slrgex_sf_car Configuration Set. Configuration (Active)".

  • "Inline Text" - создает описание набора конфигурации в соответствии с окружающим текстом. Например:

    Single line of inline text, reading "slrgex_sf_car Configuration Set Configuration (Active) in slrgex_sf_car (Model)"

Табличный форматтер для таблиц, которые ModelConfiguration reporter генерирует, указанный как mlreportgen.report.BaseTable объект. Значением по умолчанию этого свойства является BaseTable объект с TableStyleName для свойства установлено значение ModelConfigurationTable стиль, который определен в шаблоне по умолчанию для ModelConfiguration репортер. Чтобы настроить внешний вид таблицы, измените свойства по умолчанию BaseTable или замените объект своим собственным BaseTable объект. При добавлении содержимого в Title содержимое отображается перед заголовком таблицы в созданном отчете.

Форматер абзаца для любого содержимого конфигурации модели, создаваемого как абзац, указанный как mlreportgen.dom.Paragraph объект. Значением по умолчанию этого свойства является Paragraph объект с StyleName для свойства установлено значение ModelConfigurationParagraph стиль, который определен в шаблоне по умолчанию для ModelConfiguration репортер. Чтобы настроить внешний вид абзаца, измените свойства по умолчанию Paragraph или замените объект своим собственным Paragraph объект. При добавлении содержимого к объекту абзаца содержимое появляется перед содержимым конфигурации модели в созданном отчете.

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

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

Максимальное количество вложенных уровней в иерархии структурированных объектов для отчета, указанное как неотрицательное целое число. Верхним уровнем иерархии является объект набора конфигурации (Simulink.ConfigSet). Уровни, меньшие или равные значению DepthLimit сплющены в последовательность взаимосвязанных таблиц. Уровни, превышающие предел глубины, не сообщаются. Если установить DepthLimit свойство для 0иерархически структурированные типы не расширяются.

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

Включать ли заголовок набора конфигурации, указанный как true или false.

Когда IncludeTitle является true, заголовок набора конфигурации (содержимое Title свойство) входит в состав:

  • Заголовок таблицы свойств набора конфигурации при FormatPolicy является "Auto" или "Table"

  • Содержимое, созданное при FormatPolicy является "Inline Text" или "Paragraph"

Заголовок набора конфигурации всегда включается в заголовок абзаца или таблицы, содержащей компоненты набора конфигурации, независимо от значения IncludeTitle собственность.

Включает ли заголовок тип данных значения, которое описывает заголовок, указанный как true или false.

Типы данных: logical

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

Типы данных: logical

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

Типы данных: logical

Функция или выражение для фильтрации набора конфигурации и свойств объекта компонента из отчета, заданного как дескриптор функции, скаляр строки или вектор символа. Укажите функцию как дескриптор функции. Укажите выражение как строковый скалярный или символьный вектор. Если PropertyFilterFcn пуст, все свойства включены в отчет.

Если предоставляется дескриптор функции, связанная функция должна:

  • Возьмем следующие аргументы:

    • variableName - имя сообщаемой переменной;

    • variableObject - Представляемая переменная

    • propertyName - имя свойства сообщаемой переменной;

  • Вернуть true для фильтрации указанного свойства из отчета или false для включения свойства в отчет.

Например, этот код использует PropertyFilterFcn для предотвращения отображения Name и Description свойства:

import slreportgen.report.*

rpt = slreportgen.report.Report("MyReport","pdf");
open(rpt);

model = "slrgex_sf_car";
load_system(model);
reporter = ModelConfiguration(model);

filterFcnHandle = @(variableName,variableObject,propertyName) ...
    (propertyName == "Name") ||  ...
    (propertyName == "Description");

reporter.PropertyFilterFcn = filterFcnHandle;
append(rpt,reporter);
close(rpt);
rptview(rpt);

Если предоставляется строковый скаляр или символьный вектор, он должен содержать выражение. Выражение:

  • Может использовать переменные variableName, variableObject, и propertyName

  • Необходимо задать переменную isFiltered кому true для фильтрации указанного свойства из отчета или false включение свойства в отчет

Например, этот код использует PropertyFilterFcn для предотвращения отображения Name и Description свойства:

import slreportgen.report.*

rpt = slreportgen.report.Report("MyReport","pdf");
open(rpt);

model = "slrgex_sf_car";
load_system(model);
reporter = ModelConfiguration(model);


filterStr = "isFiltered = " +...
    "strcmp(propertyName,'Name')||strcmp(propertyName,'Description');";
reporter.PropertyFilterFcn = filterStr;

append(rpt,reporter);
close(rpt);
rptview(rpt);

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

Укажите формат в виде строкового скаляра или символьного вектора. См. раздел formatSpec аргумент на sprintf справочная страница.

Укажите точность как положительное целое число. См. раздел precision аргумент на num2str справочная страница.

Пример: "%.2f" отображает двойные значения с двумя цифрами справа от десятичного знака.

Пример: 2 отображает максимальное количество двух значащих цифр.

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

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

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

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

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

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

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

Методы

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

Примеры

свернуть все

Использование объекта slreportgen.report.ModelConfiguration для отчета об активном наборе конфигурации модели.

Импортируйте пакеты MATLAB Report и Simulink Report API, чтобы не использовать длинные, полные имена классов.

import mlreportgen.report.*
import slreportgen.report.*

Создание отчета Simulink.

rpt = slreportgen.report.Report("MyReport","pdf");
open(rpt);

Создайте главу для активного набора конфигурации модели.

chapter = Chapter();
chapter.Title = "Active Model Configuration Set";

Загрузка модели.

model = "slrgex_sf_car";
load_system(model);

Создание slreportgen.report.ModelConfiguration объект для отчета об активном наборе конфигурации модели.

reporter = ModelConfiguration(model);

Добавьте репортера к главе и главу к отчету.

append(chapter,reporter);
append(rpt,chapter);

Закрыть и просмотреть отчет

close(rpt);
rptview(rpt);
Представлен в R2020b