Simulink.sdi.report

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

Описание

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

пример

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

Примеры

свернуть все

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

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

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

% Ensure Simulation Data Inspector is empty
Simulink.sdi.clear

% Open model
load_system('ex_sldemo_absbrake')

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

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

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

Inspect Signals отчет включает в себя все сигналы, построенные в графической области просмотра панели 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

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

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


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

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

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

свернуть все

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

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

Пример: 'ReportToCreate','Compare Runs','ShortenBlockPath',true

Инспектор Данных моделирования разделяет на области, чтобы получить в отчете.

  • 'Inspect Signals' – Создайте отчет информации о панели Inspect.

  • 'Compare Runs' – Создайте отчет информации о панели Compare.

Пример: 'ReportToCreate','Inspect Signals'

Пример: 'ReportToCreate','Compare Runs'

Папка, где отчет сохранен. Задайте путь к папке, где вы хотите сохранить отчет как вектор символов.

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

Имя файла для отчета.

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

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

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

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

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

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

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

Задайте метаданные, чтобы включать как массив, с помощью класса перечисления 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 Signals отчет.

Значение столбцаОписание
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 Runs отчет.

Значение столбцаОписание
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

Блокируйте длину пути.

  • true – Сообщите о сокращенной длине пути блока.

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

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

Открытый отчет, когда создано.

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

  • false – Не открывайте отчет относительно создания.

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

Сигналы включать в Compare Runs отчет.

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

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

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

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

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