主要内容

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

systemcomposer.rptgen.finder.ViewResult 类

命名空间: systemcomposer.rptgen.finder
超类: mlreportgen.finder.Result (MATLAB Report Generator)

视图的搜索结果

自 R2022b 起

描述

在 System Composer™ 架构模型中搜索视图信息的结果对象。

systemcomposer.rptgen.finder.ViewResult 类是 handle 类。

创建对象

result = ViewResult 会为使用 systemcomposer.rptgen.finder.ViewFinder 对象找到的视图创建搜索结果对象。

注意

systemcomposer.rptgen.finder.ViewFinder 类的 find 方法会为找到的每个视图创建一个搜索结果对象。您不需要自己创建该对象。

属性

全部展开

结果元素的通用唯一标识符 (UUID),以字符串形式返回。

数据类型: string

视图名称,指定为字符串。

示例: "NewView"

数据类型: string

视图描述,指定为字符串。

数据类型: string

与视图相关的选择查询,指定为字符串。

数据类型: string

分组准则,指定为 "<profile>.<stereotype>.<property>" 形式的属性字符串数组。

示例: ["AutoProfile.MechanicalComponent.mass","AutoProfile.MechanicalComponent.cost"]

视图中的元素,以 systemcomposer.arch.Component 对象数组的形式返回。

视图中的子组,以 systemcomposer.view.ElementGroup 对象数组的形式返回。

数据类型: char | string

自定义快照报告器,指定为 mlreportgen.report.FormalImage (MATLAB Report Generator) 对象。

视图的颜色,指定为字符串。颜色可以是 "blue""black""green",也可以是以十六进制字符串编码的 RGB 值:"#FF00FF""#DDDDDD"。无效颜色会导致错误。

与结果相关联的标记,指定为字符串。您可以使用此属性为结果附加额外信息。您可以将此属性设置为任何符合您需求的值。

数据类型: string

方法

全部展开

示例

全部折叠

使用 ViewFinderViewResult 类创建报告,以查找给定架构模型中的所有视图。

import mlreportgen.report.*
import slreportgen.report.*
import systemcomposer.rptgen.finder.*

打开 scKeylessEntrySystem 工程。

prj = openProject("scKeylessEntrySystem");
model_name = "KeylessEntryArchitecture";
mdl = systemcomposer.loadModel(model_name);

创建一个报告,并追加标题页和目录。

viewsReport = slreportgen.report.Report(OutputPath=model_name + "_ViewsReport", ...
    CompileModelBeforeReporting=false);
append(viewsReport,TitlePage(Title="Views in " + model_name));
append(viewsReport,TableOfContents);

创建一个章节,包含架构模型中与视图相关的所有部分。

viewsChapter = Chapter(Title="Views");

查找架构模型中的所有视图。

viewFinder = ViewFinder(model_name);
while hasNext(viewFinder)
    view = next(viewFinder);
    viewSection = Section(Title=view.Name);
    append(viewSection,view);
    append(viewsChapter,viewSection);
end

将章节附加到报告中,并查看生成的报告。

append(viewsReport,viewsChapter);
close(viewsReport);
rptview(viewsReport);

版本历史记录

在 R2022b 中推出