Holarch

SysML v2

SysML v2 变体和配置

在 SysML v2 项目中对产品线建模:在浏览器和属性面板中设置变化点、变体、规则和配置,使用“新建配置…”,以单一配置显示视图,以及对配置进行权衡研究。

使用方法 →

本页内容
  1. 概述
  2. 概念
    1. 变化点和变体
    2. 产品线
    3. 规则
    4. 配置
  3. 如何使用
    1. 何时使用及原因
    2. 标记变化点
    3. 添加规则
    4. 创建配置
    5. 更改配置的选择
    6. 以某一个配置显示模型
    7. 在权衡研究中比较配置
    8. 实例:Hybrid Car 演示
    9. 提示和良好做法
    10. 常见错误
    11. 与其他功能的关联方式
  4. 浏览器
  5. 属性面板
    1. 产品线
    2. 配置
    3. 变化点和变体
  6. 以配置查看
  7. 消息
  8. 限制
  9. 相关页面

概述

产品线是一个设计,其中有少数几处产品之间存在差异,例如电池容量,或是否配备充电器。您只需对产品线建模一次,然后即可查看、检查和比较其中任何一个产品,而无需复制模型。

SysML v2 在语言中内置了这一功能。Holarch 在整个应用中展示它:

  • 浏览器会标记产品线、变化点、变体和配置,并列出每条产品线的配置。
  • 属性面板显示产品线的变化点、规则和配置以及各自的判定结果,并允许您更改配置的选择。
  • 新建配置…通过一个对话框创建配置,该对话框会在您选择时检查规则。
  • 顶栏中的查看方式 ▾会以某一个配置显示视图、数据库、属性面板和产品线页面。
  • 权衡研究可以比较产品线的配置或某个变化点的变体。

文本中的可变性在所有方案中均可使用。在 Free 方案中,产品线页面、“新建配置…”以及在属性面板中更改配置的选择均为只读;编辑这些内容属于 Individual 和 Team 方案。请参阅产品线:方案。

概念

变化点和变体

变化点是设计中产品之间存在差异的位置。其变体是允许的选择。

  • 变化用法是一个设计内部的变化点:variation part charger : Component { variant part noCharger; variant part wallbox; }。
  • 变化定义是一组可重用的选择:variation part def BatteryPack { variant part standardPack; variant part largePack; }。以它为类型的用法(例如 part pack : BatteryPack;)也是一个变化点。

产品线

产品线是拥有或继承变化点的定义或用法。在 Hybrid Car 演示中,CarLine 是产品线:它特化 Car,并添加变化点 pack 和 charger。特化某条产品线的定义也是产品线。

规则

规则是产品线的一个 assert constraint。它排除某些变体组合。在演示中,wallboxNeedsLargePack 规定壁挂式充电器需要大容量电池组:

assert constraint wallboxNeedsLargePack { charger == charger::wallbox implies pack == BatteryPack::largePack }

当某个变化点尚未选择时,针对它的规则既不算满足也不算违反:其判定结果为未知。

配置

配置是产品线中的一个产品。它是一个以产品线为类型的用法,为每个变化点绑定一个变体。Holarch 用 @HolarchConfiguration(包 HolarchVariability)对其进行标记,因此编辑器会标注它尚未选择的每个变化点:

part plugInHybrid : CarLine {
  @HolarchConfiguration;
  part :>> pack = BatteryPack::largePack;
  part :>> charger = charger::wallbox;
}

每个配置都有一个判定结果:

判定结果含义
有效每个变化点都已选择一个变体,且所有规则都已满足。
违反规则 …某条规则被违反;判定结果会指出该规则。
不完整某个变化点尚未选择变体;判定结果会指出该变化点。
未知某条规则无法求值,例如因为它读取的某个值缺失。

Holarch 还会统计变体的组合数,以及规则允许其中多少个。对于非常大的产品线,它只检查前面的若干组合,并说明检查了多少个。

如何使用

何时使用及原因

当多个产品共享一个设计的大部分内容时,请使用可变性:车辆的配置等级、出口版本、传感器套件、带或不带某个选项的产品。只需对共享设计建模一次,标记产品之间存在差异的位置,并为每个产品添加一个配置。这样,每个产品都会随共享设计的每项更改保持同步。

标记变化点

  1. 打开编辑器以及包含该设计的包。
  2. 在产品线的定义内部,选择插入 ▾ → 变化。填写变化点的名称和类型。
  3. 在该变化内部,为每个选择各选择一次插入 ▾ → 变体。
  4. 要重用一组选择,请在包级别选择插入 ▾ → 变化。它会写入一个变化定义;然后用它作为某个部件的类型。

浏览器现在会以堆叠方框图标显示产品线,以菱形显示变化点。

添加规则

  1. 在产品线的定义内部,编写一个针对其变化点的断言约束,例如 assert constraint r { charger == charger::wallbox implies pack == BatteryPack::largePack }。
  2. 在浏览器中选择该产品线。

您会在属性面板的产品线部分的规则下看到该规则,以及它所排除的组合数。

创建配置

  1. 在浏览器中,打开产品线或其配置分组的行菜单(⋯、右键单击或 Shift+F10)。
  2. 选择新建配置…。
  3. 检查配置对象:该配置所属的产品线。
  4. 输入名称,例如 longRangeHybrid。
  5. 在变体选择下,为每个变化点选择一个变体。您会立即在选择下方看到判定结果,例如 Valid: meets every rule(有效:满足所有规则)或 Breaks the rule wallboxNeedsLargePack(违反规则 wallboxNeedsLargePack)。
  6. 点击创建。

该配置会写入文本中产品线的最后一个配置之后,并标记为 @HolarchConfiguration,一次撤销即可全部撤回。浏览器会在产品线的配置分组中选中它。

您也可以通过属性面板产品线部分中的新建配置…,或通过 ⌘K / Ctrl+K 打开该对话框。

更改配置的选择

  1. 在浏览器(或视图)中选择该配置。
  2. 在属性面板的配置部分,在某个变化点的列表中选择另一个变体。

文本中的绑定会被重写(part :>> pack = BatteryPack::standardPack;),判定结果随之更新;一次撤销即可全部撤回。选择未选择即可移除该选择。会给模型增加错误的选择会被拒绝并给出原因。

以某一个配置显示模型

  1. 在顶栏中点击查看方式 ▾(在您选择之前显示为所有配置 ▾),然后选择一个配置。顶栏下方的横幅会显示例如 Viewing configuration plugInHybrid.(正在查看配置 plugInHybrid。)以及适用的元素数量。在一般视图、互连视图和网格视图中,该配置未选择的变体以及其他配置会被隐藏,每个变化点显示其选择,例如 pack : BatteryPack = largePack。数据库、属性面板和产品线页面遵循相同的选择。
  2. 要返回,请选择查看方式 ▾ → 所有配置,或点击横幅中的离开。

在 Individual 和 Team 方案中,您可以在显示某个配置时进行编辑;每次编辑都是一次 SysML v2 文本编辑,在应用前经过检查,每次编辑都可通过一次撤销撤回:

  • 选择一个变体会在配置中写入绑定(part :>> pack = BatteryPack::largePack;)。
  • 更改后的属性值会成为该配置自己的值;定义保留其原值。
  • 新的部件和动作属于该配置。
  • 删除一个可以省略的继承元素会在配置中写入 part :>> roofBox[0];。必需的继承元素不能在那里删除;请在编辑器中更改它。
  • 您创建的风险、任务或其他 Holarch 条目适用于该配置。

在 Free 方案中,配置视图为只读。在配置的属性面板中,在视图中显示 ▾会打开其产品线以该配置显示的视图。

在权衡研究中比较配置

  1. 打开风险、问题与决策 → 权衡研究以及一项研究(或点击+ 新建权衡研究)。
  2. 在备选方案下,点击+ 从产品线…。
  3. 在来源下,选择 Configurations of …(某条产品线的配置)或 Variants of …(某个变化点的变体)。
  4. 取消勾选不需要的条目,然后点击添加。

每个配置或变体都会成为一个备选方案,并关联到模型元素。像在任何权衡研究中一样添加准则和值,或使用从模型提取值。

实例:Hybrid Car 演示

在“管理项目”中,使用项目文件 ▾ → 新建演示项目 → Hybrid Car (SysML v2) 创建演示项目。

  1. 打开模型 → 浏览器并展开 Vehicles。BatteryPack 和 CarLine 带有产品线图标;CarLine 有一个配置分组,其中包含 longRangeHybrid、plugInHybrid 和 selfChargingHybrid。
  2. 选择 CarLine。产品线部分列出变化点 pack(standardPack、largePack)和 charger(noCharger、wallbox)、规则 wallboxNeedsLargePack,以及三个配置,全部为有效。它报告 4 种组合:3 种为规则所允许,1 种被排除(壁挂式充电器搭配标准电池组)。
  3. 选择 selfChargingHybrid,并将 charger 更改为 wallbox。判定结果变为 Breaks the rule wallboxNeedsLargePack(违反规则 wallboxNeedsLargePack)。按 ⌘Z / Ctrl+Z 撤销。
  4. 打开视图 carLineVariants(图)。选择查看方式 ▾ → plugInHybrid。BatteryPack 框只保留 largePack,CarLine 框显示 pack : BatteryPack = largePack 和 variation charger : Component = wallbox。
  5. 打开权衡研究 → Configuration Line-up(TR-2)。其备选方案是这三个配置,按价格、纯电续航里程和充电便利性评分。

提示和良好做法

  • 将共享设计保留在产品线中,只将差异放在变体中。变体重定义其所更改的内容(attribute :>> capacity = 12 [kW*h];)。
  • 一旦知道某个组合不被允许,就立即编写规则。这样,判定结果会立即发现有问题的配置。
  • 以产品而不是选择来命名配置(plugInHybrid,而不是 largePackWallbox)。
  • 每条产品线使用一个视图并在配置之间切换,而不是每个配置使用一个视图。

常见错误

  • 配置未列在其产品线下。它必须以该产品线为类型(part x : CarLine)。请在属性面板中检查其类型。
  • 判定结果一直为未知。某条规则读取的值在此配置中没有值。请为每个变化点选择一个变体,或为该值指定默认值。
  • 选择被拒绝。该变体不是该变化点的变体之一。请从属性面板的列表中选择,或在文本中修正名称。

与其他功能的关联方式

  • 编辑器:插入 ▾可写入变化、变体、配置和变体选择。这里的所有内容都是普通的 SysML v2 文本,因此导入、导出和其他 SysML v2 工具都能读取。
  • 权衡研究:将配置和变体作为备选方案。
  • 可靠性框图:变化点的变体是备选方案,因此该图只计入查看方式 ▾中所选配置选择的变体。显示所有配置时,该变化点是一个具有其自身值的块,窗格会提示选择一个配置。
  • 模型检查:验证 → 模型检查会报告每个违反规则或有变化点未选择变体的配置(ProductLine.3,错误)。备注即判定结果,例如 Breaks the rule wallboxNeedsLargePack,被违反的规则会作为相关元素列出。修复 → 打开条目会打开该配置。API 和 MCP 报告相同的发现项(run_model_checks、GET …/model-checks)。
  • 变更请求和历史记录:每项更改都是普通的模型更改,每项都可通过一次撤销撤回。

浏览器

  • 图标:产品线为堆叠方框,变化点为菱形,变体为实心菱形,配置为滑块。每个图标都有工具提示。
  • 配置分组:产品线所在行的第一个成员。它列出该产品线的所有配置,无论它们在何处声明;其中每一行都代表配置本身。其行菜单中有新建配置…。
  • 行菜单:产品线及其每个配置上都有新建配置…。
  • 屏幕阅读器:行的名称会说明它是什么,例如 CarLine, part def, product line 或 plugInHybrid, part, configuration of CarLine。

属性面板

产品线

  • 变化点:每个变化点及其可选的变体。
  • 规则:产品线的断言约束,或 No rules: every combination of variants is allowed.(无规则:允许所有变体组合。)
  • 配置:列出各配置及其判定结果的表格。
  • 组合:存在多少种变体组合,以及其中有多少被规则允许、排除或仍为未知。
  • 新建配置…

配置

  • 配置对象:产品线。
  • 状态:判定结果,发生变化时会向屏幕阅读器播报。
  • 每个变化点一个列表:所选的变体,或未选择。一次撤销即可撤回一项更改。
  • 规则:每条规则显示为 Met(已满足)、Broken(已违反)或 Unknown(未知)。
  • 在视图中显示 ▾:显示该产品线的一般视图、互连视图和网格视图,以此配置打开。

变化点和变体

  • 变化点会列出其变体,并在选择者下列出每个配置的选择。
  • 变体会显示它是哪个变化点的变体(变体所属),以及哪些配置选择了它。

以配置查看

  • 位置:顶栏,在模型有配置之后出现。每个浏览器标签页一个选择:一般视图、互连视图和网格视图、数据库、属性面板以及产品线页面都会遵循该选择。
  • 控件:查看方式 ▾(在您选择之前显示为所有配置 ▾)。该菜单列出所有配置、每条产品线的配置及其判定结果、适用性 ▸(按序列号、生产日期或两者显示模型:序列号和日期…表示在该日期生产的、具有该序列号的单元)以及管理产品线。顶栏下方的横幅有更改 ▾和离开。
  • 变化内容:该配置未选择的变体以及同一产品线的其他配置会连同其所拥有的内容一起被隐藏。变化点显示其选择。布局不会重新排列,并由所有配置共享。
  • 编辑:Individual 和 Team 方案。编辑遵循以单一配置显示模型中的规则。在 Free 方案中,以及对于拥有查看权限的人员,该视图为只读,横幅会说明原因。
  • 网格:表格会略去隐藏的元素,并在表格上方列出各项选择。矩阵显示整条产品线。
  • 按标签页:该选择会在浏览器标签页中保留,直到您更改它。图列表中视图的缩略图显示整条产品线。
  • 屏幕阅读器:切换时会播报配置以及适用的元素数量,例如 Viewing configuration plugInHybrid. … elements apply.,无法编辑时还会加上 Read only.。

消息

留言应采取的行动
模型尚无变化点。请在编辑器中添加一个变化(插入 ▾ → 变化),然后重试。请先标记一个变化点。
The model has no configurations or variants yet. …(模型尚无配置或变体。…)(+ 从产品线…)请先添加一个变化点或配置。
输入配置的名称。在名称中键入名称。
… 已在 … 中使用。请选择其他名称。同一个包中的另一个元素使用了该名称。
名称为 1 到 1,000 个字符,且不含换行。请更改名称。缩短名称或删除换行。
被拒绝的选择或配置它会给模型增加一个错误;消息会指出该错误。请修正文本,或选择另一个变体。
SysML 检查器不可用,因此无法读取变化点。请重新加载页面,或在编辑器中使用插入 ▾ → 配置创建配置。

限制

  • 对于非常大的产品线,组合数只统计前面的若干组合;配置始终会被完整检查。
  • 在 Free 方案中,以单一配置显示的视图为只读。
  • 尚不支持:发布或退役 SysML v2 配置。所有 SysML v2 配置均为草稿,因此配置控制不会锁定配置。
  • 可变性涵盖 SysML v2 模型。模型旁边的 Holarch 条目(风险、测试、任务、文档章节)适用于所有配置,但在显示某个配置时创建的条目除外:它们适用于该配置。在 SysML v2 项目中尚无法编辑它们的“适用于”。

SysML® 和 OMG® 是 Object Management Group, Inc. 在美国和其他国家/地区的注册商标。