Simulink.sdi.report

Сгенерируйте отчет Данные Моделирования Inspector

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

Синтаксис

Simulink.sdi.report
Simulink.sdi.report(Name,Value)

Описание

Simulink.sdi.report создает отчет, содержащий снимки графика и метаданные для сигналов, нанесенных на Inspect панели Данных моделирования Inspector.

пример

Simulink.sdi.report(Name,Value) создает отчет, заданный одним или несколькими Name,Value аргументы в виде пар. Используя этот синтаксис, можно создать отчет о данных, нанесенных на графике на панели Inspect или отчет о результатах сравнения. Для каждого отчета можно задать подробную информацию.

Примеры

свернуть все

Открыть Live Script

Создайте отчет, содержащий информацию и графики сигналов, нанесенных на панели «Просмотр» Данных моделирования Inspector. По умолчанию отчет содержит метаданные, отображаемые для сигналов в таблице на панели «Просмотр». В этом примере показано, как указать, какие метаданные будут включены в отчет.

Загрузка файла Сеанса

Этот пример заполняет Данные Моделирования Inspector данными и нанесенными сигналами путем загрузки сохраненного файла сеанса. Файл сеанса содержит данные сигнала, а также информацию о нанесенных сигналах и размещении графика. Загрузите файл сеанса.

Simulink.sdi.load('ex_sldemo_absbrake_slp_Ww.mldatx');

Создайте отчет для нанесенных на график сигналов

Отчет включает графики и метаданные для нанесенных на график сигналов. По умолчанию отчет содержит метаданные, соответствующие столбцам, отображаемым в таблице сигналов на панели «Просмотр». Дополнительные данные можно включить в отчет, отобразив больше столбцов на панели «Просмотр». Можно также программно задать необходимую информацию в отчете с помощью 'ColumnsToReport' Пара "имя-значение" и класс перечисления Simulink.sdi.SignalMetaData.

signalMetadata = [Simulink.sdi.SignalMetaData.Run, ...
    Simulink.sdi.SignalMetaData.Line, ... 
    Simulink.sdi.SignalMetaData.BlockName, ...
    Simulink.sdi.SignalMetaData.SignalName];

Simulink.sdi.report('ReportType','Inspect', 'ReportOutputFile', ...
    'absbrake_slp_report.html', 'ColumnsToReport', signalMetadata);

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

Открыть Live Script

Используйте Simulink.sdi.report функция для создания отчета о результатах сравнения. Отчет является веб-базовым и интерактивным, и можно переключаться между интерактивным представлением и видом печати.

Загрузка результатов сравнения

Этот пример загружает ранее вычисленные результаты сравнения, которые были сохранены в файле MLDATX с помощью saveResult функция. Данные получены из двух симуляций slexAircraftExample модель, которая использует различные значения временных констант для входа фильтра.

Simulink.sdi.load('slexAircraftExampleTsComparison.mldatx');

Создание отчета о сравнении

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

Simulink.sdi.report('ReportType','Compare', 'ReportTitle',...
    'Compare: Ts = 0.1 vs Ts = 1','ReportAuthor', 'Jane Smith');

Отчет открывается в системном браузере после его создания. Выберите сигналы, чтобы увидеть результаты, отображенные на графике, и метаданные для сигналов на панели свойств. Отчет HTML файла находится в sdireports папка в рабочей директории.

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

свернуть все

Аргументы в виде пар имя-значение

Задайте необязательные разделенные разделенными запятой парами Name,Value аргументы. Name - имя аргумента и Value - соответствующее значение. Name должны находиться внутри кавычек. Можно задать несколько аргументов в виде пар имен и значений в любом порядке Name1,Value1,...,NameN,ValueN.

Пример: 'ReportType','Compare','ShortenBlockPath',true

Тип создаваемого отчета, заданный как разделенная разделенными запятой парами, состоящая из 'ReportType' и 'Inspect' или 'Compare'.

  • 'Inspect' - Создайте отчет, содержащий снимки графика и метаданные для сигналов, нанесенных на Inspect панели Данных моделирования Inspector.

  • 'Compare' - Создайте отчет, который суммирует результаты сравнения. Отчет о сравнении является интерактивным и включает график снимки результатов сравнения, а также метаданные для сравниваемых сигналов.

Пример: 'ReportType','Compare'

Заголовок отчета, отображаемый в заголовке для отчета сравнения, задается как разделенная разделенными запятой парами, состоящая из 'ReportTitle' и вектор символов.

Заголовок отчета можно задать только для отчета сравнения.

Пример: 'ReportTitle','Trial 1 vs. Trial 2'

Автор отчета отображается в заголовке для отчета сравнения, заданном как разделенная разделенными запятой парами, состоящая из 'ReportAuthor' и вектор символов.

Для отчета сравнения можно задать только автора отчета.

Пример: 'ReportAuthor','John Smith'

Папка, в которой сохранен отчет, заданная как разделенная разделенными запятой парами, состоящая из 'ReportOutputFolder' и вектор символов.

Пример: 'ReportOutputFolder','C:\Users\user1\Desktop'

Имя файла отчета, заданное как разделенная разделенными запятой парами, состоящая из 'ReportOutputFile' и вектор символов.

Пример: 'ReportOutputFile','MyReport.html'

Следует ли препятствовать перезаписи файлов отчетов, задается как разделенная разделенными запятой парами, состоящая из 'PreventOverwritingFile' и true или false.

  • true включает защиту от перезаписи файлов.

  • false отключает защиту от перезаписи файлов.

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

Пример: 'PreventOverwritingFile',false

Метаданные сигнала для включения в отчет сигналов, нанесенных на Inspect панели Данных моделирования Inspector, заданные как разделенная запятой пара, состоящие из 'ColumnsToReport' и массив. По умолчанию в Inspect отчет включает путь блока, имя, стиль линии и цвет, и параметры источника данных для каждого нанесенного на график сигнала.

Примечание

The ColumnsToReport вход не влияет на отчеты сравнения. Отчет о сравнении всегда включает все метаданные сигнала, и сводные данные в верхней части отчета о сравнении всегда включают имя сигнала, абсолютную погрешность, относительную погрешность, максимальное различие и результат для каждого сравнения сигнала.

Задайте метаданные, которые будут включены в качестве массива, используя класс перечисления Simulink.sdi.SignalMetaData. Для примера включить имя запуска симуляции и имя сигнала:

signal_metadata = [Simulink.sdi.SignalMetaData.Run,...
                    Simulink.sdi.SignalMetaData.SignalName];

Затем задайте ColumnsToReport как signal_metadata в паре "имя-значение":

Simulink.sdi.report('ColumnsToReport',signal_metadata)

Таблица результирующих метаданных, доступных для Inspect отчет.

Значение столбцаОписание
SignalName (по умолчанию)Имя сигнала
Line (по умолчанию)Стиль линии
SID

Simulink® идентификатор

Для получения дополнительной информации о SID, смотрите Simulink Identifiers

UnitsМодули измерения сигнала
SigDataTypeТип данных сигнала
SigSampleTimeМетод, используемый для дискретизации сигнала
ModelИмя модели, которая сгенерировала сигнал
BlockNameИмя исходного блока для сигнала
BlockPath Путь к исходному блоку для сигнала
PortИндекс сигнала на выход порте его блока
DimensionsРазмерности матрицы, содержащей сигнал
ChannelИндекс сигнала в матрице
RunИмя запуска симуляции, содержащего сигнал
AbsTol Абсолютная погрешность для сигнала
RelTol Относительная погрешность для сигнала
OverrideGlobalTolСвойство, которое определяет, имеют ли допуски сигнала приоритет над глобальными допусками
TimeTolДопуск по времени для сигнала
InterpMethodМетод интерполяции
SyncMethodМетод синхронизации, используемый для координации сигналов для сравнения
TimeSeriesRootИмя переменной, сопоставленной с сигналом для сигналов, импортированных из MATLAB® рабочая область
TimeSourceИмя массива, содержащего данные времени для сигналов, импортированных из рабочего пространства MATLAB
DataSourceИмя массива, содержащего данные сигнала для сигналов, импортированных из рабочего пространства MATLAB

Пример: 'ColumnsToReport',metadata

Сокращать ли путь блока в отчете, задается как разделенная разделенными запятой парами, состоящая из 'ShortenBlockPath' и true или false.

  • true - Используйте укороченный путь блока в отчете.

  • false - Включите полный путь к блоку в отчет.

Пример: 'ShortenBlockPath',false

Открывать ли отчет при его создании, задается как разделенная разделенными запятой парами, состоящая из 'LaunchReport' и true или false.

  • true - Открывайте отчет, когда он будет создан.

  • false - Не открывайте отчет автоматически.

Пример: 'LaunchReport',false

Сигналы для включения в отчет сравнения, заданные как разделенная разделенными запятой парами, состоящая из 'SignalsToReport' и 'ReportOnlyMismatchedSignals' или 'ReportAllSignals'.

  • ReportOnlyMismatchedSignals - Включать только сигналы с результатами сравнения вне допуска.

  • ReportAllSignals - Включите все сигналы.

Пример: 'SignalsToReport','ReportAllSignals'

Вопросы совместимости

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

Поведение изменено в R2020b

См. также

| | |

Темы

Введенный в R2011b

Документация Simulink

Поддержка

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