slreportgen.report. Класс RptFile

Пакет: slreportgen.report

Создайте основанный на Report Explorer генератор отчетов

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

Описание

Используйте генератор отчетов RptFile, чтобы включать содержимое, сгенерированное настройкой Report Explorer (.rpt) файл в отчете API Отчета. Когда добавлено к отчету, генератору отчетов RptFile:

  1. Выполняет заданный файл настройки Report Explorer, чтобы сгенерировать представление XML DocBook отчета Report Explorer

  2. Использует измененную версию Report Explorer Docbook-to-DOM шаблон преобразования, чтобы преобразовать XML в набор Объектов DOM (см., Управляют Шаблонами Преобразования Отчета (MATLAB Report Generator)),

  3. Добавляет содержимое DOM к отчету API Отчета.

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

Создание

Описание

пример

reporter = RptFile() создает пустой основанный на Report Explorer генератор отчетов RptFile. Прежде, чем добавить генератор отчетов в отчет, ваша программа отчета должна установить свойство SetupFile генератора отчетов на путь настройки Report Explorer (.rpt) файл. В противном случае ошибка происходит.

По умолчанию генератор отчетов RptFile использует шаблон преобразования, который является немного измененной версией шаблона преобразования Report Explorer по умолчанию для отчета выходной тип. Например, если отчет, выходным типом является PDF, генератор отчетов, использует немного измененную версию шаблона по умолчанию для Report Explorer's PDF (from template) тип вывода.

Можно использовать пользовательский шаблон преобразования, чтобы настроить генератор отчетов вывод. Используйте метод createTemplate генератора отчетов, чтобы создать копию одного из определенных шаблонов преобразования типа вывода генератора отчетов по умолчанию для индивидуальной настройки. Чтобы использовать индивидуально настраиваемый шаблон, установите свойство TemplateSrc генератора отчетов RptFile на путь индивидуально настраиваемого шаблона.

пример

reporter = RptFile(SetupFile) создает генератор отчетов RptFile на основе заданного файла настройки Report Explorer (файл .rpt). Смотрите свойство SetupFile.

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

Свойства

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

Путь к файлу настройки Report Explorer, заданный как символьный массив или строка. Не используйте основанные на форме отчеты для файлов настройки, что вы используете с генератором отчетов RptFile. API Отчета сообщает, к которому добавляется файл настройки, заменяет выходной тип файла настройки.

Атрибуты:

GetAccess

общественность

SetAccess

общественность

Типы данных: string | character array

Имя модели, заданное как символьный массив или строка, модели, для которой выполняется заданный SetupFile. Если файл настройки содержит Образцовый Цикл, генератор отчетов RptFile устанавливает свое значение к значению этого свойства. Ошибка происходит, если файл настройки не содержит Образцовый Цикл или содержит циклы многоуровневой модели.

Атрибуты:

GetAccess

общественность

SetAccess

общественность

Типы данных: character array | string

Системный путь, заданный как символьный массив, строка или объект slreportgen.finder.DiagramResult. Если файл настройки содержит Системный Цикл, генератор отчетов RptFile устанавливает Системное значение Цикла к значению этого свойства, если это - символ или строка. Если значение является объектом DiagramResult, генератор отчетов устанавливает Системный Цикл на значение свойства Path результата. Ошибка происходит, если файл настройки не содержит Системный Цикл или содержит несколько системных циклов.

Атрибуты:

GetAccess

общественность

SetAccess

общественность

Типы данных: character array | string | object

Блок path, заданный как символьный массив или строка, объект slreportgen.finder.DiagramElementResult или объект slreportgen.finder.BlockResult для блока. Если файл настройки содержит Цикл Блока, генератор отчетов RptFile устанавливает значение Цикла Блока к значению этого свойства, если это - символ или строка. Если значение является объектом slreportgen.finder.BlockResult, генератор отчетов использует значение свойства BlockPath объекта. Если значение является объектом DiagramElementResult, генератор отчетов использует значение свойств DiagramPath и Name объекта определить полный путь. Ошибка происходит, если файл настройки не содержит Цикл Блока или содержит несколько циклов блока.

Атрибуты:

GetAccess

общественность

SetAccess

общественность

Типы данных: character array | string | object

Источник преобразования обрабатывает по шаблону, чтобы использоваться этим генератором отчетов, чтобы преобразовать XML файла настройки вывод в Объекты DOM. Пустое значение задает использование шаблона по умолчанию для выходного типа отчета, который будет сгенерирован. Значение строки или символьного массива задает путь настроенной версии шаблона по умолчанию для выходного типа, который будет сгенерирован.

Атрибуты:

GetAccess

общественность

SetAccess

общественность

Типы данных: character array | string

Имя шаблона для этого генератора отчетов, заданного как символьный массив или строка. По умолчанию это свойство задает RptFile, имя шаблона генератора отчетов по умолчанию. Этот шаблон по умолчанию находится в библиотеке шаблонов его шаблона преобразования по умолчанию наряду с другими шаблонами, используемыми, чтобы преобразовать компоненты XML Report Explorer в Объекты DOM. Шаблон генератора отчетов по умолчанию содержит одну дыру под названием Content, чтобы быть заполненным содержимым DOM, преобразованным от содержания XML, сгенерированного настройкой. Если вы меняете имя этого шаблона, необходимо установить это свойство на новое имя. Можно изменить сам шаблон, но измененный шаблон должен содержать дыру под названием Содержимое.

Атрибуты:

GetAccess

общественность

SetAccess

общественность

Типы данных: character array | string

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

Атрибуты:

GetAccess

общественность

SetAccess

общественность

Типы данных: string | character array | object

Методы

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

Примеры

Создайте генератор отчетов RptFile

Создайте генератор отчетов RptFile, не задавая файл настройки. Затем используйте свойство SetupFile задать файл настройки Report Explorer.

reporter = slreportgen.report.RptFile();
reporter.SetupFile = "my_setup_file.rpt"

Сообщите относительно блока документации

Используйте генератор отчетов RptFile, чтобы сообщить относительно блока Documentation в модели sldemo_fuelsys Simulink. Генератор отчетов RptFile использует файл настройки Report Explorer, чтобы получить информацию о блоке Documentation.

Примечание

Прежде чем вы запустите этот пример, используйте Report Explorer, чтобы создать файл настройки под названием my_setup_file.rpt. Файл настройки для этого примера содержит иерархию Образцового Цикла, Системного Цикла, Цикла Блока, Абзаца и компонентов Документации как показано. Выберите компоненты из средней панели.

  • Образцовый Цикл, Системный Цикл и компоненты Цикла Блока находятся в папке Simulink.

  • Компонент абзаца находится в папке Formatting.

  • Компонент блока Documentation находится в папке Simulink Blocks.

Для получения дополнительной информации о подготовке файла настройки для этого примера смотрите, Создают Файл настройки Отчета (MATLAB Report Generator).

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

model = "sldemo_fuelsys";
load_system(model)

rpt = slreportgen.report.Report("MyReport","pdf");
chap = mlreportgen.report.Chapter("Report on a DocBlock");
 
rptFile = slreportgen.report.RptFile("my_setup_file.rpt");
rptFile.Model = model;
rptFile.System = "sldemo_fuelsys/To Controller";
rptFile.Block = "sldemo_fuelsys/To Controller/Sensor Info";

add(chap,rptFile);
add(rpt,chap);
 
close(rpt);
rptview(rpt);

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

|

Темы

Введенный в R2019a

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