Simulink.sdi.report

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

Описание

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

пример

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

Примеры

свернуть все

В этом примере показано, как создать отчет сигналов, построенных в Инспекторе Данных моделирования, использующем Simulink.sdi.report функция. Можно использовать Simulink.sdi.report функция, чтобы создать отчет, который содержит нанесенные на график сигналы в панели Inspect или для результатов сравнения. Этот пример генерирует данные путем симуляции модели, затем показывает, как создать отчет, который содержит информацию о нанесенных на график сигналах и изображении области графического вывода. Чтобы запустить пример, точно так же, как показано, гарантируйте, что Инспектор Данных моделирования репозиторий запускает пустое использование Simulink.sdi.clear функция.

Сгенерируйте данные

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

Simulink.sdi.clear

load_system('ex_sldemo_absbrake')

% Specify slip ratio and simulate model
set_param('ex_sldemo_absbrake/Desired relative slip','Value','0.24')
sim('ex_sldemo_absbrake');

% Specify new slip ratio and simulate model again
set_param('ex_sldemo_absbrake/Desired relative slip','Value','0.25')
sim('ex_sldemo_absbrake');

Постройте сигналы в панели Inspect

Inspect отчет включает в себя все сигналы, построенные в графической области просмотра панели Inspect и всех отображенных метаданных для нанесенных на график сигналов.

% Get Simulink.sdi.Run objects
runIDs = Simulink.sdi.getAllRunIDs;
runID1 = runIDs(end-1);
runID2 = runIDs(end);

run1 = Simulink.sdi.getRun(runID1);
run2 = Simulink.sdi.getRun(runID2);

% Get Simulink.sdi.Signal objects for slp signal
run1_slp = run1.getSignalByIndex(4);
run2_slp = run2.getSignalByIndex(4);

% Plot slp signals
run1_slp.plotOnSubPlot(1, 1, true)
run2_slp.plotOnSubPlot(1, 1, true)

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

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

% Specify report parameters
reportType = 'Inspect';
reportName = 'absbrake_Report.html';


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

Simulink.sdi.report('ReportType', reportType, 'ReportOutputFile', ...
    reportName, 'ColumnsToReport', signalMetadata);

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

свернуть все

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

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

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

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

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

  • 'Compare' – Создайте отчет, который содержит результаты сравнения.

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

Стиль отчета создать в виде разделенной запятой пары, состоящей из 'ReportStyle' и 'Printable' или 'Interactive'.

  • 'Printable' – Создайте отчет, который отображает все графики и встроенную информацию.

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

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

  • 'Interactive' – Создайте интерактивный отчет, который показывает результаты сравнения по одному. Можно выбрать результаты, вы хотите просмотреть и легко просмотреть все метаданные сигнала. Для получения дополнительной информации об интерактивном отчете сравнения, смотрите, Создают Интерактивный Отчет Сравнения.

    Отчеты, которые включают данные по панели Inspect, не поддерживают интерактивную опцию отчета.

Пример: 'ReportStyle','Interactive'

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

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

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

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

Предотвратить ли перезапись, сообщают файлы в виде разделенной запятой пары, состоящей из 'PreventOverwritingFile' и true или false.

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

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

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

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

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

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

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

Таблица предоставляет сводные данные метаданных, доступных для Compare отчет.

Значение столбцаОписание
Result (значение по умолчанию)Передайте/приведите результат к сбою сравнения сигнала между запусками Compare To и Baseline
Line1Стиль линии и цвет для сигнала Baseline
Line2Стиль линии и цвет для сигнала Compare To
AbsTol (значение по умолчанию)Абсолютный допуск к сигналу Baseline
RelTol (значение по умолчанию)Относительный допуск к сигналу Baseline
MaxDifferenceМаксимальная разница между Baseline и сигналами Compare To
OverrideGlobalTolСвойство, которое задает, берут ли допуски сигнала Baseline приоритет над глобальными допусками
TimeTolДопуск времени к сигналу Baseline
SignalName1Имя сигнала от запущенного Baseline
SignalName2Имя сигнала от запущенного Compare To
Units1Модули измерения для сигнала в запущенном Baseline
Units2Модули измерения для сигнала в запущенном Compare To
SigDataType1Тип данных для сигнала в запущенном Baseline
SigDataType2Тип данных для сигнала в запущенном Compare To
SigSampleTime1Метод раньше производил сигнал в запущенном Baseline
SigSampleTime2Метод раньше производил сигнал в запущенном Compare To
Run1Имя Baseline запущено
Run2Имя Compare To запущено
AlignedBy (значение по умолчанию)Метод выравнивания сигнала раньше коррелировал сигналы Compare To и Baseline
Model1Имя модели, которая сгенерировала сигналы Baseline
Model2Имя модели, которая сгенерировала сигналы Compare To
BlockName1Имя исходного блока для сигнала Baseline
BlockName2Имя исходного блока для сигнала Compare To
BlockPath1Путь к исходному блоку для сигнала Baseline
BlockPath2Путь к исходному блоку для сигнала Compare To
Port1Индекс Baseline сигнализирует на выходном порте его блока
Port2Индекс Compare To сигнализирует на выходном порте его блока
Dimensions1Размерности матрицы, содержащей сигнал Baseline
Dimensions2Размерности матрицы, содержащей сигнал Compare To
Channel1Индекс Baseline в его матрице
Channel2Индекс Compare To в его матрице
InterpMethodМетод интерполяции для сигнала Baseline
SyncMethodМетод синхронизации для сигнала Baseline
TimeSeriesRoot1Имя переменной, сопоставленной с Baseline, сигнализирует для сигналов, импортированных из рабочего пространства MATLAB
TimeSeriesRoot2Имя переменной, сопоставленной с Compare To, сигнализирует для сигналов, импортированных из рабочего пространства MATLAB
TimeSource1Имя массива, содержащего данные времени Baseline для сигналов, импортируется из рабочего пространства MATLAB
TimeSource2Имя массива, содержащего данные времени Compare To для сигналов, импортируется из рабочего пространства MATLAB
DataSource1Имя массива, содержащего данные сигнала Baseline для сигналов, импортируется из рабочего пространства MATLAB
DataSource2Имя массива, содержащего данные сигнала Compare To для сигналов, импортируется из рабочего пространства MATLAB
LinkToPlot (значение по умолчанию)Соединитесь с графиком каждого результата сравнения в печатаемом отчете сравнения

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

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

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

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

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

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

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

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

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

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

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

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

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

Представленный в R2011b