Simulink.sdi.report

Сгенерируйте Инспектора Данных моделирования отчет

Описание

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

пример

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

Примеры

свернуть все

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

Загрузите файл сеанса

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

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

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

Отчет включает в себя графики и метаданные для нанесенных на график сигналов. По умолчанию отчет включает в себя метаданные, которые соответствуют столбцам, отображенным в таблице сигналов на панели Inspect. Можно включать больше данных в отчет путем отображения большего количества столбцов в панели Inspect. Можно также указать информацию, которую вы хотите в отчете программно с помощью '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);

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

Используйте 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 имя аргумента и Value соответствующее значение. Name должен появиться в кавычках. Вы можете задать несколько аргументов в виде пар имен и значений в любом порядке, например: Name1, Value1, ..., NameN, ValueN.

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

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

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

  • '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 отключает защиту перезаписи файла.

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

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

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

Примечание

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® идентификатор

Для получения дополнительной информации о SIDs, смотрите Идентификаторы Simulink

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

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

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

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

  • false – Включайте полный блок path в отчет.

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

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

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

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

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

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

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

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

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

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

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

Поведение изменяется в R2020b

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