slreportgen.report.ModelConfiguration class

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

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

Описание

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

Примечание

Как использовать slreportgen.report.ModelConfiguration репортер в отчете, вы должны создать отчет с помощью slreportgen.report.Report класс или подкласс.

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

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

HandleCompatible
true

Для получения информации об атрибутах класса см. раздел «Атрибуты класса».

Создание

Описание

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

пример

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

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

Свойства

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

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

Конфигурация модели title, заданный как вектор символов, строковый скаляр, 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, объекты Simulink, объекты Stateflow или графические объекты, могут быть свойства, которые являются самостоятельно объектами. В этих случаях иерархия уплощается, и значение свойства является гиперссылкой на таблицу свойств поля или объекта. Поле или таблица свойств связываются с исходной таблицей.

  • "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® Отчет о словах, 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