slreportgen.report.MATLABFunction class

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

Блок MATLAB function или Stateflow MATLAB function reporter

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

Описание

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

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

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

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

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

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

Примечание

Как использовать MATLABFunction репортер в отчете, вы должны создать отчет с помощью slreportgen.report.Report класс.

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

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

HandleCompatible
true

Для получения информации об атрибутах класса см. раздел «Атрибуты класса».

Создание

Описание

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

пример

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

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

Свойства

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

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

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

  • Указатель на MATLAB Function блок или функцию Stateflow MATLAB

Примечание

Если вы используете finder, чтобы найти MATLAB Function блок или функцию Stateflow MATLAB и добавить результат непосредственно к отчету, slreportgen.report.MATLABFunction reporter используется вместо свойства объекта Simulink.

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

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

Для блока MATLAB Function Simulink сообщаются следующие свойства:

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

  • Шаг расчета

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

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

  • Обработайте эти унаследованные типы сигналов Simulink как объекты fi

  • MATLAB Function блок fimath

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

  • Описание

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

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

  • Fimath функции MATLAB

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

  • Описание

Чтобы настроить внешний вид таблицы свойств функции и ее заголовка, настройте 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 объект. The MATLABFunction reporter использует этого репортера, чтобы создать таблицу аргументов функции MATLAB. Таблица включает сводные данные аргументов и свойств аргументов, заданных в ArgumentSummaryProperties свойство.

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

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

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

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

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

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

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

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

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

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

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

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

Примечание

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Методы

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

Примеры

свернуть все

Открыть Live Script

Чтобы включить информацию о блоке MATLAB Function в отчет, используйте 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);

Вот первая страница отчета:

Открыть Live Script

Чтобы включить детали аргумента функции 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);

Вот некоторые подробные таблицы аргументов в сгенерированном отчете:

Открыть Live Script

Чтобы настроить заголовок раздела скрипта функции, используйте 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);

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

Открыть Live Script

По умолчанию 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 Report Generator

Поддержка

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