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

slreportgen.report.EnumerationType 类

命名空间: slreportgen.report

Simulink 枚举数据类型报告器

自 R2023b 起

全页展开

描述

使用 slreportgen.report.EnumerationType 类的对象来报告 Simulink® 模型和子模型中使用的枚举类型。此类的实例由 slreportgen.finder.EnumerationTypeResult 对象的 getReporter 方法返回。将此报告器添加到报告中，无需进行任何修改，只会在默认设置的基础上添加枚举类型的信息。使用报告器属性来指定报告选项。

注意

您只能将此报告器与 slreportgen.report.Report 类的报告一起使用。

slreportgen.report.EnumerationType 类是 handle 类。

类属性

HandleCompatible
true

有关类属性的信息，请参阅类属性。

创建对象

您不需要自己创建 slreportgen.report.EnumerationType 对象。此类的实例由 slreportgen.finder.EnumerationTypeResult 对象的 getReporter 方法返回。将此报告器添加到报告中，无需进行任何修改，只会在默认设置的基础上添加枚举类型的信息。使用报告器属性来指定报告选项。

属性

全部展开

Simulink.VariableUsage 对象为该结果所代表的变量。

属性：

SetAccess
受保护

指定使用一个报告器来以表格形式（即属性值对表）报告和格式化枚举类型属性。该属性的默认值是 mlreportgen.report.BaseTable 类型的对象。您可以通过自定义默认报告器或将其替换为 BaseTable 报告器的自定义版本来自定义表的外观。有关自定义此报告器的信息，请参阅 mlreportgen.report.BaseTable 文档或命令行帮助。您在默认或替换报告器的 Title 属性中指定的任何内容都将出现在生成的报告的标题之前。此示例显示了在下列情况下 BaseTable 报告的内容：

  • 在 MATLAB® 文件中定义枚举类型

    表 1.1.ON_OFF_TYPE 属性

    属性值
    名称ON_OFF_TYPE
    源类型MATLAB 文件
    源文件ON_OFF_TYPE.m
    成员

    • OFF(0)

    • ON(1)

    • FAILEDANDCLOSE(2)

    默认值OFF(0)

  • 动态定义一个枚举类型。

    表 1.1.BasicColors 属性

    属性值
    名称BasicColors
    源类型动态类
    源文件由 Simulink.defineIntEnumType 定义
    成员

    • Blue(0)

    • Red(1)

    • Yellow(2)

    默认值Blue

  • 在数据字典中定义枚举类型。

    表 1.1.BasicColors 属性

    属性值
    名称BasicColors
    源类型数据字典
    源文件sldemo_fuelsys_dd_controller.dd
    枚举成员

    • Blue(0)

    • Red(1)

    • Yellow(2)

    默认值Blue

指定要报告的枚举属性的名称，指定为字符串或字符向量元胞数组。该属性的默认值是由枚举属性 {"Name","Source Type","Source","Members","Default Value"} 组成的元胞数组。您可以从以下枚举类型属性中自定义此元胞数组：

枚举类型属性

"Name"
"Source Type"
"Source"
"Members"
"Default Value"
"Header File"
"Description"

数据类型: cell

是否显示使用枚举类型的模块列表，指定为 true 或 false。如果将 ShowUsedBy 属性设置为 true，则报告器会在报告中包含使用总线对象的模块的列表。如果 ShowUsedBySnapshot 属性也设置为 true，则报告器将为使用枚举类型的每个父子系统包含一个图快照。使用枚举类型的模块在快照中突出显示。

数据类型: logical

枚举类型列表的格式化程序，指定为 mlreportgen.dom.OrderedList 对象或 mlreportgen.dom.UnorderedList 对象。OrderedList 或 UnorderedList 对象不能包含列表项。

该属性的默认值是 OrderedList 对象，其 StyleName 属性设置为 ExecutionOrderList 样式，该样式在 ExecutionOrder 报告器的默认模板中定义。要自定义列表的外观，请修改默认 OrderedList 对象的属性，或将该对象替换为您自己的 OrderedList 或 UnorderedList 对象。

此属性指定是否包含定义枚举类型的 MATLAB 代码，指定为 true 或 false。默认值为 false。

注意

仅当您在 M 文件中定义枚举类型时，此属性才适用。

数据类型: logical

指定一个 mlreportgen.dom.Paragraph 对象来填充 MATLABCodeReporter 代码的标题内容，指定为 mlreportgen.dom.Paragraph 对象。该属性的默认值是一个空的 mlreportgen.dom.Paragraph 对象，其属性指定源代码标题的外观。默认情况下，EnumerationType 报告器根据枚举数据类型名称生成标题并将其附加到段落。生成的标题由枚举类型名称后跟 "Source Code" 组成。例如，枚举类型 "ON_OFF_TYPE" 生成标题 "ON_OFF_TYPE Source Code"。您可以通过修改默认段落对象的属性或将其替换为另一个段落对象来自定义标题外观。您添加到默认或替换段落的任何内容都会出现在生成的报告的标题之前。有关自定义 DOM 段落格式的信息，请参阅 mlreportgen.dom.Paragraph 文档或命令行帮助。

注意

此属性仅当 IncludeMATLABCode 属性设置为 true 时才适用。

指定一个报告器来报告和格式化定义枚举类型的 MATLAB 代码，指定为 mlreportgen.report.MATLABCode 对象。该属性的默认值是 mlreportgen.report.MATLABCode 对象。要自定义代码外观，请修改默认 MATLABCode 报告器的属性或用自定义报告器替换该报告器。有关自定义此报告器的信息，请参阅 mlreportgen.report.MATLABCode 文档或命令行帮助。

注意

仅当 IncludeMATLABCode 属性设置为 true 时，此属性才适用。

此报告器的模板来源，以下列方式之一指定：

  • 字符向量或字符串标量，指定包含此报告器模板的文件的路径

  • 此报告器使用的模板或其模板库中包含此报告器模板的报告器或报告

  • 文档对象模型 (DOM) 文档或文档部分，该报告器使用其模板或其模板库包含该报告器的模板

指定的模板必须与您附加此报告器的报告类型相同。例如，对于 Microsoft® Word 报告，TemplateSrc 必须是 Word 报告模板。如果 TemplateSrc 属性为空，则此报告器将使用默认报告器模板作为报告的输出类型。

属性：

GetAccess
公共
SetAccess
公共
NonCopyable
true

此报告器的模板名称，指定为字符向量或字符串标量。此报告器的模板必须位于此报告器 TemplateSrc 属性所指定模板的模板库中。

属性：

GetAccess
公共
SetAccess
公共

数据类型: char | string

此报告器的超链接目标，指定为指定链接目标 ID 的字符向量或字符串标量，或 mlreportgen.dom.LinkTarget 对象。字符向量或字符串标量值转换为 LinkTarget 对象。链接目标紧接在输出报告中此报告器的内容之前。

属性：

GetAccess
公共
SetAccess
公共

方法

全部展开

示例

全部折叠

通过遍历搜索结果并为每个结果设置模型变量报告器的属性来自定义报告中模型变量的格式。

% Create a Report
rpt = slreportgen.report.Report("MyReport","docx");
 
% Create a Chapter
chapter = mlreportgen.report.Chapter();
chapter.Title = "EnumerationType Reporter Example";
 
% Load the model
model_name = "EnumExample";
load_system(model_name);
 
% Find the enumerated types in the model
finder = slreportgen.finder.EnumerationTypeFinder(model_name);
 
while hasNext(finder)
    result = next(finder);
     
    % Get the EnumerationType reporter for the result 
    % and set the IncludeMATLABCode property to true
    reporter = getReporter(result);
    reporter.IncludeMATLABCode = true;
     
    % Add the reporter to the chapter
    append(chapter,reporter);
end
% Add chapter to the report
append(rpt,chapter);
 
% Close the report and open the viewer
close(rpt);
rptview(rpt);

版本历史记录

在 R2023b 中推出

另请参阅

| | |