本页采用了机器翻译。点击此处可查看英文原文。

generateReport

生成包含度量结果的报告文件

全页折叠

    语法

    reportFile = generateReport(metricEngine,Dashboard="ModelMaintainability")
    reportFile = generateReport(metricEngine,Dashboard="ModelUnitTesting")
    reportFile = generateReport(metricEngine,Dashboard="ModelUnitSILTesting")
    reportFile = generateReport(metricEngine,Dashboard="ProjectModelTesting")
    reportFile = generateReport(___,Name=Value)

    说明

    reportFile = generateReport(metricEngine,Dashboard="ModelMaintainability") 为度量引擎生成模型可维护性报告。

    reportFile = generateReport(metricEngine,Dashboard="ModelUnitTesting") 为度量引擎生成模型测试报告。

    reportFile = generateReport(metricEngine,Dashboard="ModelUnitSILTesting") 为度量引擎生成 SIL 代码测试报告。

    reportFile = generateReport(metricEngine,Dashboard="ProjectModelTesting") 为度量引擎生成工程模型测试报告。

    reportFile = generateReport(___,Name=Value) 使用一个或多个名称-值参量指定选项。例如，Type="html-file" 生成 HTML 报告。

    请注意，Fixed-Point Designer™ 文档中还有一个函数 generateReport (Fixed-Point Designer)。

    示例

    示例

    全部折叠

    分析工程中工件的可维护性，并生成包含结果的报告文件。

    打开要分析的工程。对于此示例，在 MATLAB® 命令行窗口中，输入：

    openExample("slcheck/ExploreTestingMetricDataInModelTestingDashboardExample");
openProject("cc_CruiseControl");

    为工程创建一个 metric.Engine 对象。

    metric_engine = metric.Engine();

    通过将仪表板类型指定为 'ModelMaintainability'，创建模型可维护性仪表板的度量标识符列表。

    metric_ids = getAvailableMetricIds(metric_engine,...
App="DashboardApp",...
Dashboard="ModelMaintainability");

    在生成报告之前，请使用度量标识符列表上的 execute 函数收集度量引擎的度量结果。

    execute(metric_engine,metric_ids);

    在当前目录（即工程的根文件夹）下生成名为 maintainabilityResults 的 HTML 报告。

    reportLocation = fullfile(pwd,"maintainabilityResults.html");
generateReport(metric_engine,Dashboard="ModelMaintainability",...
Type="html-file",Location=reportLocation);

    报告会自动打开。为防止报表自动打开，在调用 generateReport 函数时，将 LaunchReport 指定为 false。

    要打开目录并导航到每个单元的结果，请点击报告左上角的菜单图标 。

    分析工程中的测试工件，并生成包含结果的报告文件。

    打开要分析的工程。对于此示例，在 MATLAB 命令行窗口中，输入：

    openExample("slcheck/ExploreTestingMetricDataInModelTestingDashboardExample");
openProject("cc_CruiseControl");

    为工程创建一个 metric.Engine 对象。

    metric_engine = metric.Engine();

    更新 metric_engine 的追溯信息，确保工件信息是最新的。

    updateArtifacts(metric_engine)

    通过将仪表板类型指定为 'ModelUnitTesting'，创建模型测试仪表板的可用度量标识符列表。

    metric_ids = getAvailableMetricIds(metric_engine,...
App="DashboardApp",...
Dashboard="ModelUnitTesting");

    在生成报告之前，请使用度量标识符列表上的 execute 函数收集度量引擎的度量结果。

    execute(metric_engine,metric_ids);

    生成模型测试报告。默认情况下，报告会以 PDF 格式生成在工程根文件夹中。

    generateReport(metric_engine,Dashboard="ModelUnitTesting");

    报告会自动打开。为防止报表自动打开，在调用 generateReport 函数时，将 LaunchReport 指定为 false。

    报告中的每个单元都有一个工件汇总表，显示需求、设计和测试中的工件数量。

    输入参数

    全部折叠

    您收集度量结果的度量引擎对象，指定为 metric.Engine 对象。

    名称-值参数

    全部折叠

    将可选参量对组指定为 Name1=Value1,...,NameN=ValueN，其中 Name 是参量名称，Value 是对应的值。名称-值参量必须出现在其他参量之后，但对各个参量对组的顺序没有要求。

    如果使用的是 R2021a 之前的版本，请使用逗号分隔每个名称和值，并用引号将 Name 引起来。

    示例: Type="html-file"

    自动打开生成的报告，指定为 true 或 false。

    示例: false

    数据类型: logical

    生成的报告的完整文件名，以字符向量或字符串标量的形式指定。使用位置信息指定报告名称。

    默认情况下，报告名称为 dashboardIdentifier，后跟一个下划线，再后跟工程名称，报告生成在工程的根文件夹中。

    示例: "C:\MyProject\Reports\MyResults.html"

    生成的报告的文件类型，指定为 pdf 或 html-file。

    示例: html-file

    输出参量

    全部折叠

    生成的报告的完整文件名，以字符向量的形式返回。

    替代功能

    App

    您可以使用仪表盘用户界面生成报告。

    要打开仪表盘用户界面，请使用以下方法之一：

    • 在命令行窗口中，输入：

      modelDesignDashboard
      该仪表板将打开模型可维护性仪表板。

    • 在命令行窗口中，输入：

      modelTestingDashboard
      仪表盘将打开模型测试仪表盘。

    点击工具栏上的报告按钮。“创建度量结果报告”对话框打开。点击创建创建报告。

    有关如何使用仪表板用户界面的示例，请参阅 使用模型可维护性仪表板监控设计复杂性。

    版本历史记录

    在 R2021a 中推出

    全部展开

    另请参阅

    | | | | | |

    主题