slreportgen.report.MATLABFunction class

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

Блок MATLAB function или генератор отчетов функции MATLAB Stateflow

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

Описание

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

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

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

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

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

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

Примечание

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

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

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

HandleCompatible
true

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

Создание

Описание

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

пример

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

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

Свойства

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

Блок MATLAB function или функция MATLAB Stateflow, чтобы сообщить в виде одного из этих значений:

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

  • Обработайте к блоку MATLAB Function или функции MATLAB Stateflow

Примечание

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

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

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

Для блока Simulink MATLAB Function сообщают об этих свойствах:

  • Метод Update

  • Размер шага

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

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

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

  • Блок MATLAB Function fimath

  • Введите fi математику

  • Описание

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

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

  • Функция MATLAB fimath

  • Введите fi математику

  • Описание

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

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

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

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

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

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

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

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

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

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

Функциональный заголовок раздела скрипта в виде mlreportgen.dom.Paragraph объект. 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.

Примечание

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

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

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

Variable PropertiesОписание
ИмяИмя переменной
Тип данныхТип данных и размер переменной
Запустите положениеНомер строки и номер столбца первого символа имени переменной в скрипте, в котором это появляется

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

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

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

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

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

  • MATLAB — Включайте функции поддерживающего MATLAB

  • user-defined— Включайте пользовательские функции поддержки

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

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

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

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

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

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

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

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

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

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

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

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

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

Методы

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

Примеры

свернуть все

Скрипт Open Live Script

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

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

model_name = "slrgex_radar_eml";
load_system(model_name); 
mlfcnObj = "slrgex_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);

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

Скрипт Open Live Script

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

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

model_name = "slrgex_radar_eml";
load_system(model_name); 
mlfcnObj = "slrgex_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);

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

Скрипт Open Live Script

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

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

model_name = "slrgex_radar_eml";
load_system(model_name); 
mlfcnObj = "slrgex_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);

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

Скрипт Open Live Script

По умолчанию, MATLABFunction генератор отчетов включает код основной функции, но не код пользовательских функций поддержки что основные вызовы функции. Чтобы включать код пользовательских функций, используйте 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

Поддержка

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