slreportgen.report.RptFile class

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

Создайте репортер на основе Report Explorer

Описание

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

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

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

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

Примечание

Используйте цикл блоков, а не компонент Цикл График в файле настройки отчета, чтобы сообщить о Stateflow® чарты. Смотрите Отчет о снимках диалогового окна Stateflow.

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

Создание

Описание

пример

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

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

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

пример

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

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

Свойства

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

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

Атрибуты:

GetAccess
public
SetAccess
public

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

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

Атрибуты:

GetAccess
public
SetAccess
public

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

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

Атрибуты:

GetAccess
public
SetAccess
public

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

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

Примечание

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

Атрибуты:

GetAccess
public
SetAccess
public

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

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

Атрибуты:

GetAccess
public
SetAccess
public

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

Имя шаблона для этого репортера, заданное как символьный массив или строка. По умолчанию это свойство задает RptFile, имя шаблона репортера по умолчанию. Этот шаблон по умолчанию находится в библиотеке шаблонов его шаблона преобразования по умолчанию наряду с другими шаблонами, используемыми для преобразования Компонентов Report Explorer в объекты 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 свойство для задания файла настройки Report Explorer.

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

Используйте RptFile reporter, чтобы сообщить о Documentation блоке в sldemo_fuelsys Simulink® модель.

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

Примечание

Прежде чем запускать этот пример, используйте Report Explorer, чтобы создать файл настройки с именем my_setup_file.rpt. Файл настройки для этого примера содержит иерархию компонентов Model Loop, System Loop, Block Loop, Parape и Documentation, как показано на рисунке. Выберите компоненты на средней панели.

  • Компоненты Model Loop, System Loop и Block Loop находятся в папке Simulink.

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

  • Компонент блока документации находится в папке Блоков 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 используйте цикл блоков в файле настройки Report Explorer.

Используйте Report Explorer, чтобы создать файл настройки с именем my_setup_file.rpt. Файл настройки для этого примера содержит иерархию, состоящую из компонента Model Loop, System Loop, Block Loop и Stateflow Dialog Snapshot. Выберите компоненты на средней панели.

  • Компоненты Model Loop, System Loop и Block Loop находятся в папке Simulink.

  • Компонент Stateflow Dialog Snapshot находится в папке 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