Exponenta Banner
exponenta event banner

slreportgen.report.MATLABFunction класс

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

Функциональный блок MATLAB или функциональный репортер Stateflow MATLAB

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

Описание

Использование объекта slreportgen.report.MATLABFunction для отчета о функциональном блоке Simulink ® MATLAB или функции Stateflow ® MATLAB ®.

По умолчанию a MATLABFunction репортер добавляет эту информацию в отчет:

  • Функциональный блок Simulink MATLAB или свойства функции Stateflow MATLAB

  • Сводка входных и выходных аргументов функции

  • Код MATLAB, используемый функцией для вычисления выходов с ее входов

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

Примечание

Использование MATLABFunction reporter в отчете, необходимо создать отчет с помощью slreportgen.report.Report класс.

slreportgen.report.MATLABFunction класс является handle класс.

Атрибуты класса

HandleCompatible
true

Сведения об атрибутах класса см. в разделе Атрибуты класса.

Создание

Описание

reporter = slreportgen.report.MATLABFunction() создает пустой MATLABFunction на основе шаблона по умолчанию. Используйте Object , чтобы указать функциональный блок Simulink MATLAB или функцию Stateflow MATLAB для отчета.

пример

reporter = slreportgen.report.MATLABFunction(mlfcnObj) устанавливает Object свойству функционального блока MATLAB или функции Stateflow MATLAB, указанной mlfcnObj.

reporter = MATLABFunction(Name,Value) наборы MATLABFunction свойства репортера с использованием пар имя-значение. Можно указать несколько аргументов пары имя-значение в любом порядке. Заключите каждое имя свойства в одинарные или двойные кавычки.

Свойства

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

Функциональный блок MATLAB или функция Stateflow MATLAB для отчета, заданная как одно из следующих значений:

  • Вектор символов или строковый скаляр, содержащий путь к блоку функции MATLAB

  • Обращение к функциональному блоку MATLAB или функции Stateflow MATLAB

Примечание

При использовании поиска для поиска функционального блока MATLAB или функции Stateflow MATLAB и добавлении результата непосредственно в отчет slreportgen.report.MATLABFunction вместо репортера свойств объекта Simulink используется репортер.

Включить ли свойства объекта, указанные как true или false. Если значение равно trueотчет включает в себя таблицу свойств объекта Simulink или Stateflow, которая соответствует сообщаемому функциональному блоку MATLAB или функции Stateflow MATLAB.

Репортер свойств объекта, указанный как mlreportgen.report.BaseTable объект. MATLABFunction репортер использует указанный репортер для создания таблицы свойств объекта Simulink или Stateflow, соответствующей функциональному блоку MATLAB или сообщаемой функции Stateflow MATLAB.

Для функционального блока Simulink MATLAB сообщаются следующие свойства:

  • Метод обновления

  • Время выборки

  • Поддержка массивов переменного размера

  • Насыщение при целочисленном переполнении

  • Рассматривать унаследованные типы сигналов Simulink как объекты fi

  • MATLAB Функциональный блок fimath

  • Входная математика fi

  • Описание

Для функции Stateflow MATLAB сообщаются следующие свойства:

  • Насыщение при целочисленном переполнении

  • Функция MATLAB fimath

  • Входная математика fi

  • Описание

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

Включать ли сводную таблицу аргументов, указанную как true или false. Если значение равно trueотчет включает в себя сводную таблицу свойств аргументов сообщаемой функции.

Свойства аргумента, включаемые в сводную таблицу аргумента, задаются как массив ячеек символьных векторов или строковый массив. Если модель еще не скомпилирована, MATLABFunction reporter компилирует модель для получения Compile Type и Compiled Size данные. Когда отчет закрыт, модель не компилируется.

Укажите любую комбинацию этих свойств:

  • Name

  • Scope

  • Port

  • Compiled Type (Data Type)

  • Compiled Size (Size)

  • Complexity

  • Description

  • Maximum (Max Value)

  • Minimum (Min Value)

  • Tunable

  • Variable Size

Репортер сводки аргументов, указанный как mlreportgen.report.BaseTable объект. MATLABFunction reporter использует этот reporter для создания таблицы аргументов функции MATLAB. Таблица содержит сводку аргументов и свойств аргументов, указанных в ArgumentSummaryProperties собственность.

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

Включать ли таблицу свойств с подробной информацией для каждого аргумента, указанного как true или false. Если значение равно trueотчет включает таблицу свойств для каждого аргумента функции MATLAB. Если модель еще не скомпилирована, MATLABFunction репортер компилирует модель. Когда отчет закрыт, модель не компилируется.

Репортер свойств аргументов, указанный как mlreportgen.report.BaseTable объект. MATLABFunction reporter использует указанный reporter для создания таблицы свойств каждого аргумента функции MATLAB.

Чтобы настроить внешний вид таблицы свойств аргумента, настройте значение по умолчанию BaseTable репортер или замените его пользовательским BaseTable репортер.

Включать ли сценарий функции MATLAB, указанный как true или false. Если значение равно true, отчет включает в себя код, который вычисляет вывод функции MATLAB на его входах.

Форматер кода функции, указанный как mlreportgen.dom.Paragraph объект. Paragraph объект управляет форматированием, таким как семейство шрифтов, размер шрифта и выравнивание кода в функции MATLAB. Он не определяет, выделяет ли репортер синтаксис кода. Для управления подсвечиванием используйте HighlightScriptSyntax собственность.

Чтобы настроить внешний вид кода, измените свойства по умолчанию Paragraph репортер или заменить репортер заказным репортером. При добавлении содержимого по умолчанию или замене Paragraph , содержимое помещается перед скриптом MATLAB Function в созданном отчете.

Заголовок раздела сценария функции, указанный как mlreportgen.dom.Paragraph объект. Paragraph объект содержит заголовок раздела, содержащего код функции MATLAB. Заголовок по умолчанию - имя функционального блока MATLAB, за которым следует Function Script. Например, для функционального блока MATLAB с именем Covariance Derivative, название - Covariance Derivative Function Script. Свойства абзаца определяют внешний вид заголовка.

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

Выделить ли ключевые слова синтаксиса сценария, указанные как true или false. Если значение равно true, в отчете используется цвет для выделения ключевых слов синтаксиса кода функции.

Включать ли данные символа функции, указанные как true или false.

Если значение равно true, отчет включает информацию о символах, которые появляются в основном коде функции MATLAB. Если IncludeSupportingFunctions свойство - true, отчет также содержит информацию о символах, которые появляются в коде вспомогательных функций. Данные символа функции выводятся только в том случае, если Object свойство указывает функциональный блок MATLAB.

Примечание

Если включить данные символа функции, создание отчета может быть медленнее, чем если его не включить.

Репортер данных символа функции, указанный как mlreportgen.report.BaseTable объект. MATLABLFunction reporter использует этот reporter для создания таблиц свойств каждого символа, который появляется в основном коде функции MATLAB и дополнительно в коде вспомогательных функций. Символы в созданном отчете группируются по типам, которые являются переменными, операциями и сайтом вызова функций. Таблицы для каждого типа символов отображаются после свойств функции. Свойства функции и символа перечислены в следующих таблицах.

Свойства функцииОписание
Имя функцииИмя функции
Идентификатор функцииИдентификатор функции. Simulink присваивает уникальный идентификатор каждой функции MATLAB в модели и каждой поддерживающей функции. Встроенная или определяемая пользователем вспомогательная функция использует один и тот же идентификатор независимо от того, сколько функций она поддерживает в данной модели.
ПутьПуть к функции, который является путем модели блока MATLAB Function или содержащего его блока Stateflow. Путь поддерживающей функции - это путь к определяющему его файлу MATLAB.

Свойства переменнойОписание
ИмяИмя переменной
Тип данныхТип данных и размер переменной
Начальное положениеНомер строки и столбца первого символа имени переменной в сценарии, в котором она отображается

Свойства операцииОписание
ИмяСимвол или символы, представляющие тип операции. Например, +
Тип данныхТип данных и размер значения, создаваемого операцией
Начальное положениеНомер строки и столбца первого символа операции в сценарии, в котором она отображается

Свойства сайта вызова функцииОписание
ИмяИмя вызываемой функции
Тип данныхТип данных и размер значения, возвращаемого вызываемой функцией
Я быИдентификатор вызываемой функции
Начальное положениеНомер строки и столбца первого символа узла вызова в сценарии, в котором он отображается

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

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

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

  • MATLAB - Включить вспомогательные функции MATLAB

  • user-defined- Включение пользовательских вспомогательных функций

Репортер вспомогательных функций, указанный как mlreportgen.report.BaseTable объект. BaseTable объект сообщает о функциях, прямо или косвенно вызванных основной функцией MATLAB. Функции сортируются по имени функции.

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

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

Пользовательский формат кода вспомогательных функций, указанный как mlreportgen.dom.Paragraph объект. Paragraph объект управляет форматированием, таким как семейство шрифтов, размер шрифта и выравнивание кода в отчете. MATLABFunction reporter выделяет синтаксис текста функции (кода) и добавляет выделенный текст к объекту абзаца.

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

Определяемый пользователем заголовок раздела вспомогательной функции, указанный как mlreportgen.dom.Paragraph объект. MATLABFunction reporter использует форматтер для создания заголовка для каждой определяемой пользователем вспомогательной функции. Значением по умолчанию этого свойства является пустой абзац со свойствами, задающими внешний вид заголовка функции. По умолчанию MATLABFunction reporter добавляет к абзацу имя поддерживающей функции. Внешний вид заголовка можно настроить, изменив свойства объекта абзаца по умолчанию или заменив его другим объектом абзаца. Любое содержимое, добавляемое к абзацу по умолчанию или заменяющему абзацу, отображается перед каждым заголовком в созданном отчете.

Источник шаблона для этого репортера, указанный одним из следующих способов:

  • Вектор символов или строковый скаляр, указывающий путь к файлу, содержащему шаблон для этого репортера

  • Репортер или отчет, шаблон которого используется для этого репортера или библиотека шаблонов которого содержит шаблон для этого репортера

  • Документ DOM или деталь документа, шаблон которого используется для этого репортера или библиотека шаблонов которого содержит шаблон для этого репортера

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

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

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

Методы

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

Примеры

свернуть все

Открыть сценарий в реальном времени

Для включения информации о функциональном блоке MATLAB в отчет используйте slreportgen.report.MATLABFunction репортер. По умолчанию отчет включает таблицу свойств объекта, таблицу входных и выходных аргументов и сценарий функции.

import slreportgen.report.*
import mlreportgen.report.*

model_name = "sldemo_radar_eml";
load_system(model_name); 
mlfcnObj = "sldemo_radar_eml/MATLAB Function";

rpt = slreportgen.report.Report("MyReport","pdf");
chapter = Chapter(mlfcnObj); 
rptr = MATLABFunction(mlfcnObj); 
add(chapter,rptr); 
add(rpt,chapter); 

close(rpt); 
close_system(model_name);
rptview(rpt);

Вот первая страница доклада:

Открыть сценарий в реальном времени

Чтобы включить сведения о аргументе функции MATLAB в отчет, используйте IncludeArgumentProperties имущества MATLABFunction репортер.

import slreportgen.report.*
import mlreportgen.report.*

model_name = "sldemo_radar_eml";
load_system(model_name); 
mlfcnObj = "sldemo_radar_eml/MATLAB Function";

rpt = slreportgen.report.Report("myReport","pdf");
chapter = Chapter(mlfcnObj); 
rptr = MATLABFunction(mlfcnObj);
rptr.IncludeArgumentProperties = true;

add(chapter,rptr); 
add(rpt,chapter); 

close(rpt); 
close_system(model_name);
rptview(rpt);

Ниже приведены некоторые таблицы подробных данных аргументов в созданном отчете.

Открыть сценарий в реальном времени

Чтобы настроить заголовок раздела сценария функции, используйте FunctionScriptTitle собственность. Чтобы изменить форматирование кода, создайте абзац DOM, определяющий семейство шрифтов, размер и цвет, и назначьте абзац FunctionScript собственность.

import slreportgen.report.*
import mlreportgen.report.*

model_name = "sldemo_radar_eml";
load_system(model_name); 
mlfcnObj = "sldemo_radar_eml/MATLAB Function";

rpt = slreportgen.report.Report("myReport","html");
chapter = Chapter(mlfcnObj); 
rptr = MATLABFunction(mlfcnObj);

paraTitle = mlreportgen.dom.Paragraph("SCRIPT: ");
rptr.FunctionScriptTitle = paraTitle;

paraScript = mlreportgen.dom.Paragraph;
paraScript.FontFamilyName = "Arial";
paraScript.FontSize = "12pt";
paraScript.Color = "blue";
rptr.FunctionScript = paraScript;

add(chapter,rptr); 
add(rpt,chapter); 

close(rpt); 
close_system(model_name);
rptview(rpt);

Вот часть раздела сценария функции, которая показывает название и часть кода:

Открыть сценарий в реальном времени

По умолчанию a MATLABFunction reporter включает код основной функции, но не код пользовательских вспомогательных функций, вызываемых основной функцией. Для включения кода пользовательских функций используйте IncludeSupportingFunctionsCode собственность.

import slreportgen.report.*
import mlreportgen.report.*

model_name = "slrgex_stats";
load_system(model_name); 
mlfcnObj = "slrgex_stats/MATLAB Function";
rpt = slreportgen.report.Report("myReport","pdf");
chapter = Chapter(mlfcnObj); 
rptr = MATLABFunction(mlfcnObj);
rptr.IncludeSupportingFunctionsCode = true;
add(chapter,rptr); 
add(rpt,chapter); 
close(rpt); 
close_system(model_name);
rptview(rpt);

Вот раздел сценария функции MATLAB, в котором показан код как основной функции, так и определяемой пользователем вспомогательной функции. avg.

См. также

| | | | | | | |

Темы

Представлен в R2018a

Документация по генератору отчетов Simulink

Поддержка