exponenta event banner

класс slreportgen.report.RptFile

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

Создание репортера на основе проводника отчетов

Описание

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

  1. Выполнение указанного файла настройки проводника отчетов для создания XML-представления DocBook отчета проводника отчетов

  2. Использует измененную версию шаблона преобразования Docbook-to-DOM проводника отчетов для преобразования XML в набор объектов DOM (см. раздел Управление шаблонами преобразования отчетов)

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

Примечание

Используйте в файле настройки отчета компонент Block Loop, а не Chart Loop для создания отчета по диаграммам Stateflow ®. См. раздел Отчет о снимках диалогового окна Stateflow.

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

Создание

Описание

пример

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

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

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

пример

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

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

Свойства

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

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

Атрибуты:

GetAccess
public
SetAccess
public

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

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

Атрибуты:

GetAccess
public
SetAccess
public

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

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

Атрибуты:

GetAccess
public
SetAccess
public

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

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

Примечание

Используйте компонент Block Loop в файле настройки для создания отчетов по диаграммам потока состояний. См. раздел Отчет о снимках диалогового окна Stateflow.

Атрибуты:

GetAccess
public
SetAccess
public

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

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

Атрибуты:

GetAccess
public
SetAccess
public

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

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

Атрибуты:

GetAccess
public
SetAccess
public

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

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

Атрибуты:

GetAccess
public
SetAccess
public

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

Методы

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

Примеры

свернуть все

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

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

Используйте RptFile репортер для отчета о блоке документации в sldemo_fuelsys Модель Simulink ® .

RptFile reporter использует файл настройки Report Explorer для получения информации о блоке документации.

Примечание

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

  • Компоненты Цикл модели (Model Loop), Системный контур (System Loop) и Контур блока (Block Loop) находятся в папке Simulink.

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

  • Компонент блока документации находится в папке «Блоки Simulink».

Дополнительные сведения о настройке файла настройки для этого примера см. в разделе Создание файла настройки отчета.

Этот сценарий используется для создания отчета, содержащего информацию о свойствах блока 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);

Использовать slreportgen.report.RptFile для создания отчета о снимках диалогового окна Stateflow используйте цикл блоков в файле настройки проводника отчетов.

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

  • Компоненты Контур модели (Model Loop), Системный контур (System Loop) и Контур блока (Block Loop) находятся в папке Simulink.

  • Компонент «Снимок диалогового окна Stateflow» находится в папке «Stateflow».

Дополнительные сведения о настройке файла настройки см. в разделе Создание файла настройки отчета.

Создание отчета Simulink.

rpt = slreportgen.report.Report("MyReport","pdf");
open(rpt);

Загрузка модели.

model = "slrgex_sf_car";
load_system(model);

Создание главы.

chap = mlreportgen.report.Chapter();
chap.Title = strcat(model,": Stateflow Dialog Snapshots");

Найдите все системы в модели.

sys_finder = slreportgen.finder.SystemDiagramFinder(model);
systems = find(sys_finder);

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

for system = systems
    blk_finder = slreportgen.finder.BlockFinder(system);
    blocks = find(blk_finder);
    
    for block = blocks
        if slreportgen.utils.isValidSlSystem(block.Object) && ...
                ~isempty(slreportgen.utils.block2chart(block.Object))
            rptFile = slreportgen.report.RptFile("my_setup_file.rpt");
            rptFile.Model = model;
            rptFile.System = system;
            rptFile.Block = block;
            add(chap,rptFile);
        end
    end
end

Добавьте главу в отчет.

add(rpt,chap);

Закройте и просмотрите отчет.

close(rpt);
rptview(rpt);

Представлен в R2019a