Exponenta Banner

slreportgen.report.RptFile class

Пакет: 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, генератор отчетов, использует немного модифицированную версию шаблона по умолчанию для PDF (from template) Report Explorer 'OutputType' .

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

пример

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

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

Свойства

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

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

Атрибуты:

GetAccess
public
SetAccess
public

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

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

Атрибуты:

GetAccess
public
SetAccess
public

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

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

Атрибуты:

GetAccess
public
SetAccess
public

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

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

Атрибуты:

GetAccess
public
SetAccess
public

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

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

Атрибуты:

GetAccess
public
SetAccess
public

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

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

Атрибуты:

GetAccess
public
SetAccess
public

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

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

Атрибуты:

GetAccess
public
SetAccess
public

Типы данных: 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
Поддержка