slreportgen.report.RptFile 类
命名空间: slreportgen.report
超类: slreportgen.report.Reporter
创建基于报告资源管理器的报告器
描述
使用 RptFile 报告器将报告资源管理器设置 (.rpt) 文件生成的内容包含在报告 API 报告中。当添加到报告中时，RptFile 报告器：
执行指定的报告 Explorer 安装文件以生成报告 Explorer 报告的 DocBook XML 版本
使用修改版本的报告 Explorer Docbook-to-DOM 转换模板将 XML 转换为一组 DOM 对象（请参阅 管理报告转换模板）
将 DOM 内容添加到报告 API 报告中。
提示
在报告设置文件中使用“模块循环”而不是“图循环”组件来报告 Stateflow® 图。请参阅报告 Stateflow 对话快照。
slreportgen.report.RptFile 类是 handle 类。
创建对象
描述
reporter = RptFile 创建一个空的基于报告资源管理器的 RptFile 报告器。在将报告器添加到报告之前，报告程序必须将报告器的 SetupFile 属性设置为报告资源管理器安装(.rpt)文件的路径。否则，就会发生错误。
默认情况下，RptFile 报告器使用的转换模板是报告资源管理器针对报告输出类型的默认转换模板的稍微修改版本。例如，如果报告输出类型为 PDF，则报告器将使用报告资源管理器的 PDF (来自模板) 输出类型的默认模板的轻微修改版本。
您可以使用自定义转换模板来自定义报告器输出。使用报告器的 createTemplate 方法创建报告器的默认输出类型特定转换模板之一的副本以进行自定义。要使用自定义模板，请将 RptFile 报告器的 TemplateSrc 属性设置为自定义模板的路径。
reporter = RptFile(Name=Value)
属性
此报告器的超链接目标，指定为指定链接目标 ID 的字符向量或字符串标量，或 mlreportgen.dom.LinkTarget 对象。字符向量或字符串标量值转换为 LinkTarget 对象。链接目标紧接在输出报告中此报告器的内容之前。
属性：
- GetAccess
公共
- SetAccess
公共
方法
示例
创建一个 RptFile 报告器而不指定设置文件。然后，使用 SetupFile 属性指定报告资源管理器安装文件。
reporter = slreportgen.report.RptFile();
reporter.SetupFile = "my_setup_file.rpt"此示例显示如何在 sldemo_fuelsys Simulink®模型中报告文档模块。
设置文件 docblock_setup_file.rpt 包含一个模型循环、一个系统循环、一个模块循环、一个段落和一个文档组件。创建安装文件时，可以从“报告资源管理器”的中间窗格中选择以下组件：
模型循环、系统循环和模块循环组件位于 Simulink 部分。
段落组件位于格式化部分。
文档组件位于 Simulink 模块 部分。
创建 Simulink 报告。
rpt = slreportgen.report.Report("MyReport","pdf");
加载模型。
model_name = "sldemo_fuelsys";
load_system(model_name)创建一个章节。
chap = mlreportgen.report.Chapter("Report on a DocBlock");使用报告设置文件来报告模型中 ToController 系统中的 Sensor Info 模块的属性。
rptFile = slreportgen.report.RptFile("docblock_setup_file.rpt"); rptFile.Model = model_name; rptFile.System = "sldemo_fuelsys/To Controller"; rptFile.Block = "sldemo_fuelsys/To Controller/Sensor Info"; add(chap,rptFile);
将章节添加到报告中。
add(rpt,chap);
关闭并查看报告。
close(rpt); rptview(rpt);
此示例演示了如何使用报告资源管理器设置文件中的模块循环组件报告 Stateflow 对话框快照。
设置文件 sf_setup_file.rpt 包含一个模型循环、一个系统循环、一个模块循环和一个 Stateflow 对话框快照组件。创建安装文件时，可以从“报告资源管理器”的中间窗格中选择以下组件：
模型循环、系统循环和模块循环组件位于 Simulink 部分。
Stateflow 对话框快照组件位于 Stateflow 部分。
创建 Simulink 报告。
rpt = slreportgen.report.Report("MyReport","pdf"); open(rpt);
加载模型。
model_name = "sf_car";
load_system(model_name);创建一个章节。
chap = mlreportgen.report.Chapter();
chap.Title = strcat(model_name,": Stateflow Dialog Snapshots");在模型中查找系统。
sys_finder = slreportgen.finder.SystemDiagramFinder(model_name); 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("sf_setup_file.rpt"); rptFile.Model = model_name; rptFile.System = system; rptFile.Block = block; add(chap,rptFile); end end end
将章节添加到报告中。
add(rpt,chap);
关闭并查看报告。
close(rpt); rptview(rpt); close_system(model_name)
版本历史记录
在 R2019a 中推出
