slreportgen.report.ModelConfiguration class

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

Генератор отчетов набора конфигурации модели

Описание

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

Примечание

Использовать slreportgen.report.ModelConfiguration генератор отчетов в отчете, необходимо создать отчет с помощью 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" — Форматирует конфигурацию модели, компоненты и значения свойств как таблица или абзац, в зависимости от типа данных.

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

    • CellArray

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

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

    • Таблица 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 генератор отчетов генерирует в виде 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.

Типы данных: логический

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

Типы данных: логический

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

Типы данных: логический

Функция или выражение, чтобы отфильтровать конфигурацию модели и свойства объектов компонента из отчета в виде указателя на функцию, строкового скаляра или вектора символов. Задайте функцию как указатель на функцию. Задайте выражение как строковый скаляр или вектор символов. Если 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 или часть документа, шаблон которой используется для этого генератора отчетов или чья библиотека шаблонов содержит шаблон для этого генератора отчетов

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

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

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

Методы

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

Примеры

свернуть все

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

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

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
Для просмотра документации необходимо авторизоваться на сайте