slreportgen.report. Класс MATLABFunction

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

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

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

Описание

Создайте блок MATLAB function или генератор отчетов функции Stateflow® MATLAB®.

Примечание

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

Конструкция

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

reporter = MATLABFunction(mlfcnobj) создает генератор отчетов MATLABFunction для заданного mlfcnobj. Этот генератор отчетов добавляет эту информацию по умолчанию в сгенерированный отчет:

  • Свойства блока MATLAB function Simulink или свойства функции MATLAB Stateflow, в зависимости от того, является ли функция MATLAB блоком или объектом

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

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

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

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

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

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

Смотрите Свойство объекта.

Свойства

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

Блок MATLAB function Simulink или функция MATLAB Stateflow, чьи свойства сообщить, заданный как путь или указатель.

Примечание

Если вы используете средство поиска, чтобы найти блок Lookup Table и добавить его непосредственно в отчет, этот генератор отчетов LookupTable используется, а не генератор отчетов свойства объекта Simulink.

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

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

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

  • Метод Update

  • 'SampleTime'

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

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

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

  • Блок MATLAB function fimath

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

  • Описание

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

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

  • Функция MATLAB fimath

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

  • Описание

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

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

Свойства аргумента включать в сводную таблицу аргумента MATLAB Function, заданную как массив ячеек векторов символов имени свойства. Свойствами по умолчанию, включенными в сводные данные, является Name, Scope, Port, Compiled Type и Compiiled Size. Если модель уже не скомпилирована, генератор отчетов MATLABFunction компилирует модель, чтобы получить данные Compiled Size и Compile Type. Когда отчет закрывается, модель не скомпилирована.

Значение этого свойства может быть любой комбинацией этих свойств аргумента MATLAB Function.

  • Name

  • Scope

  • Port

  • Compiled Type (Data Type)

  • Compiled Size (Size)

  • Complexity

  • Description

  • Maximum (Max Value)

  • Minimum (Min Value)

  • Tunable

  • Variable Size

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

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

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

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

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

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

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

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

Функциональный заголовок скрипта, заданный как mlreportgen.dom.Paragraph, который содержит заголовок для раздела, который содержит скрипт функции MATLAB. Заголовок по умолчанию является именем блока MATLAB function, сопровождаемым "Функциональным Скриптом", который добавлен к абзацу. Например, для блока MATLAB function, названного "Производная Ковариации", заголовок является "Производной Ковариации Функциональный Скрипт". Свойства абзаца задают внешний вид заголовка скрипта.

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

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

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

Если false, отчет не включает в себя информацию о символах, которые появляются в основном скрипте функции MATLAB. Если true, отчет включает в себя информацию о данных о символе. Если свойством IncludeSupportingFunctions является также true, отчет также содержит информацию о символах, которые появляются в поддерживании функций. О функциональных данных о символе сообщают, только если свойством исходного объекта этого генератора отчетов является блок MATLAB function Simulink.

Примечание

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Методы

createTemplateСоздайте шаблон генератора отчетов функции MATLAB
customizeReporterСоздайте пользовательский класс генератора отчетов функции MATLAB
getClassFolderРасположение файла определения класса генератора отчетов функции MATLAB

Унаследованные методы

getImplПолучите реализацию генератора отчетов

Копировать семантику

Указатель. Чтобы изучить, как классы Handle влияют на операции копии, смотрите Копирование Объектов (MATLAB).

Примеры

Добавьте свойства функции MATLAB, аргументы и функциональный скрипт

Создайте генератор отчетов PDF, который использует генератор отчетов MATLABFunction. Этот генератор отчетов включает информацию о блоке MATLAB function в модели sldemo_radar_eml.. Отчет, по умолчанию, включает в себя таблицу свойств объектов, таблицу аргументов ввода и вывода и функциональный скрипт.

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('output','pdf');
chapter = Chapter(mlfcnobj); 
rptr = MATLABFunction(mlfcnobj); 
add(chapter,rptr); 
add(rpt,chapter); 

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

Первую страницу сгенерированного отчета показывают.

Добавьте детали аргумента функции MATLAB

Создайте генератор отчета HTML, который использует генератор отчетов MATLABFunction и включает детали аргумента MATLAB Function. Используйте свойство IncludeArgumentProperties включать таблицу для каждого аргумента ввода и вывода блока MATLAB function. Этот пример использует модель sldemo_radar_eml.

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('output','html');
chapter = Chapter(mlfcnobj); 
rptr = MATLABFunction(mlfcnobj);
rptr.IncludeArgumentProperties = true;

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

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

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

Измените форматирование скрипта функции MATLAB и заголовок

Создайте генератор отчета HTML, который использует генератор отчетов MATLABFunction и устанавливает внешний вид функционального скрипта и заголовка. Измените внешний вид раздела скрипта функции блока MATLAB function отчета. Используйте свойство FunctionScriptTitle задать текст, чтобы добавить впереди функционального табличного заголовка скрипта по умолчанию. Создайте и используйте абзац DOM, чтобы изменить шрифт, размер шрифта и цвет скрипта. Этот пример использует модель sldemo_radar_eml.

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('output','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);

Этот раздел сгенерированного отчета показывает "СКРИПТ": добавленный к заголовку и Arial на 12 ПБ синий шрифт.

Смотрите также

| | | | | | | |

Темы

Введенный в R2018a

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