Holarch

SysML v2

SysML v2 项目中的需求和验证

使用“需求”、“质量”、“TBD/TBR”、“待检查的链接”、“审批”、“RVTM”、“验证用例”和“可追溯性矩阵”页面,编写、检查、审批和跟踪 SysML v2 模型的需求和验证用例。

使用方法 →

本页内容
  1. 概述
  2. 概念
    1. 模型中的需求
    2. 阈值和目标值
    3. 关系
    4. 测试用例和测试套件
    5. TBD 和 TBR
  3. 如何使用
    1. 何时使用及原因
    2. 编写需求
    3. 在文档中编写需求
    4. 检查质量
    5. 审批需求
    6. 设置阈值和目标值
    7. 将值标记为 TBD 或 TBR
    8. 关闭 TBD 或 TBR
    9. 评审已更改的关联
    10. 计划和执行验证
    11. 实例:Hybrid Car 演示
    12. 提示和良好做法
    13. 常见错误
    14. 与其他功能的关联方式
  4. 需求和质量
    1. 需求页面
    2. 质量页面
  5. 变更控制
    1. 待审查的关联
    2. 审批
    3. TBD/TBR 登记册
  6. 验证页面
    1. 验证用例
    2. RVTM
    3. 可追溯性矩阵
    4. 模型检查
  7. 消息
  8. 限制
  9. 相关页面

概述

SysML v2 项目具有与 LML 项目相同的需求和验证页面。它们作用于模型:需求是模型中的 requirement 元素,测试用例是模型中的 verification 用例。

导航栏分组页面
需要与需求需求、质量、TBD/TBR、待检查的链接、审批
验证RVTM、验证用例、可追溯性矩阵、模型检查

验证用例即 LML 项目中称为测试中心的页面。

部分数据是 SysML 文本,部分是存储在模型旁边的 Holarch 数据:

  • 在文本中:编号(短名称)、名称、描述(doc)、嵌套、satisfy、verify、dependency 和派生关系,以及带单位的属性值。
  • Holarch 数据:状态、优先级、验证方法和其他需求属性、标签、测试状态、结果、步骤和测试周期。其他 SysML v2 工具不会读取这些数据。

概念

模型中的需求

需求是一个 requirement 用法或一个 requirement def。Holarch 从文本中读取其字段:

Holarch 字段SysML v2 文本
编号短名称:<'VR-1'>
姓名名称:CurbMass
描述doc 注释:doc /* … */
子需求(decomposed by)由该需求拥有的需求
requirement def <'VR-1'> CurbMass {
  doc /* The car's curb mass shall not exceed the mass limit. */
  subject car : Car;
  attribute limit : MassValue;
  require constraint { car.curbMass <= limit }
}

页面以首字母大写的形式显示名称,因此 sedanMass 显示为 Sedan Mass。

阈值和目标值

当需求的某个 require 约束将一个量与一个值进行比较时,该需求是定量需求:car.curbMass <= limit 或 range >= 800 [km]。该值是阈值,即最低可接受值。<= 使其成为上限(越低越好),>= 使其成为下限(越高越好)。

SysML v2 没有表示目标值(超出阈值的期望值)的关键字。Holarch 将其写为来自 HolarchRequirements 库包(标准库,文件夹 Holarch)的元数据 @Objective:

requirement def <'VR-1'> CurbMass {
  subject car : Car;
  attribute limit : MassValue;
  require constraint { car.curbMass <= limit }
  @Objective { value = 1600 [kg]; }
}
  • 需求定义上的目标值适用于其每个用法。用法可以给出自己的目标值。
  • 阈值可以是写在约束中的值(12 [kg]),也可以是由需求或重定义设置的属性(attribute :>> limit = maxCurbMass;)。
  • 其他 SysML v2 工具将 @Objective 读取为普通元数据。
  • 预算和 TPM 将阈值用作满足该需求的每个部件的分配值,并在 TPM 标签页上列出该需求及其阈值和目标值(预算和 TPM)。

关系

Holarch 关系SysML v2 文本
satisfied bysatisfy carSpec by fleet.sedan;
verified by验证用例目标中的 verify carSpec.sedanMass;
performed byperform 或 allocate
traced todependency
decomposed by所有权:由另一条需求拥有的需求

在任何页面上添加或移除其中之一都会更改文本,一次撤销即可全部撤回。

测试用例和测试套件

  • 测试用例是一个 verification 用法或一个 verification def。
  • 它所验证的需求是其目标中的 verify 成员。
  • 拥有验证用例的包是一个测试套件。
verification def CurbMassTest {
  doc /* Weigh the car on a scale with full fluids and no driver. */
  subject car : Car;
  objective massObjective {
    verify carSpec.sedanMass;
  }
}

TBD 和 TBR

当以下任一条件成立时,需求处于未决状态(TBD 或 TBR):

  • 其 TBD/TBR 属性为 TBD 或 TBR。
  • 其名称或 doc 中出现 TBD、TBR 或 TBS。
  • 其某个属性值带有 TBD 或 TBR 元数据。

在值的位置写 TBD 不是有效的 SysML。请改用 Holarch 库包 HolarchMetadata 中的元数据标记该属性(请参阅将值标记为 TBD 或 TBR)。

如何使用

何时使用及原因

在模型中写好第一批需求后即可使用这些页面,并在整个验证过程中持续使用:

  • 编写时使用需求和质量:每条需求的格式是否正确?
  • 评审时使用审批:谁已签核?
  • 设计变更期间使用 TBD/TBR 和待检查的链接:哪些仍未决,哪些需要再看一遍?
  • 计划和执行验证时使用可追溯性矩阵、验证用例和 RVTM:每条需求是否都已被满足和验证?

编写需求

  1. 打开需要与需求 → 需求。
  2. 点击+ 新建。一个带有下一个编号的需求用法会被添加到包 Requirements 中。
  3. 在属性面板或表格中键入名称和描述。文本会立即更改,每次编辑都可通过一次撤销撤回。
  4. 在属性面板中设置 Holarch 数据,所在部分与 LML 需求相同:评审条中的状态,工作流下的优先级、关键性和所有者;验证下的验证方法和验证级别;Requirement 下的理由和来源。这些是 Holarch 数据;文本不会更改。每次编辑都可通过一次撤销撤回,需求表格、RVTM 和 VCRM 显示相同的值。

您也可以在编辑器中编写需求。文本一旦能够解析,它们就会出现在需求页面上。

在文档中编写需求

一个文档可以包含一个包的需求用法。

  1. 在文档中,选择编写 ▾ → 需求包…并选取该包。新文档会获得一个以其命名的包,其中含有第一条需求。
  2. 像在 LML 文档中一样添加、缩进、取消缩进和移动需求。
    • 章节下的需求属于该包。
    • 另一条需求下的需求嵌套在其中。
    • 编号就是其短名称。添加、移除或移动其他条目只会重新编号章节,从不更改短名称;新需求以其文档编号作为短名称。上移和下移会交换两条需求的短名称,重新编号…会在预览后更改它们。
  3. 在编辑器中写入该包的需求会出现在文档中。

移除会在确认后删除该包中的一条需求。要将需求从文档中移出而不删除它,请在编辑器中将其移到另一个包。

检查质量

  1. 打开需要与需求 → 质量。
  2. 点击检查质量。每条需求的描述会按九项准则评分,规则与 LML 项目中相同。
  3. 先修复得分最低的需求。

标记为已过时的得分属于较早的文本。请再次检查质量。

审批需求

需求的状态依次为 草稿 → 评审中 → 已审批或已拒绝。

  1. 将需求的状态设置为“评审中”。它会列在审批中,并在评审者的“我的工作”中列在 Awaiting review(等待评审)下。评审者会收到通知。
  2. 作为评审者,选择该需求。属性面板会显示其状态以及审批、拒绝…和重新打开。
  3. 点击审批,或点击拒绝…并填写可选的原因。属性面板会记录设置状态的人员和时间。

拥有评审者角色的人员可以审批和拒绝。编辑已审批需求的文本会使其退回“评审中”。

设置阈值和目标值

  1. 将阈值写为一个将某个量与一个值进行比较的 require 约束,例如 require constraint { battery.mass <= 50 [kg] }。
  2. 选择该需求。属性面板会显示阈值和目标,其中包括量和阈值(At most(至多)或 At least(至少))。
  3. 在目标值中键入期望值,例如 45 kg,然后按 Enter。

    Holarch 会将 @HolarchRequirements::Objective { value = 45 [kg]; } 写入该需求。清空该字段即可将其移除。

  4. 用 satisfy 将需求关联到满足它的部件。当部件满足阈值但未达到目标值时,编辑器会加以提示。

将值标记为 TBD 或 TBR

  1. 在需求所在的包中导入元数据包:private import HolarchMetadata::*;。
  2. 在值尚待确定的属性前写 #TBD。省略该值,或给出一个估计值。
  3. 在值有待评审的属性前写 #TBR。
  4. 要记录其负责人和原因,请在属性的正文中使用完整形式。
#TBR attribute limit : TimeValue = 0.5 [h];
attribute chargerPower : PowerValue {
  @TBD { owner = "Powertrain lead"; rationale = "The fast-charging standard is not chosen yet."; due = "2026-12-01"; }
}

编辑器中的插入 ▾ → TBD 值和TBR 值会为您写入这些内容。TBD 和 TBR 特化 ModelingMetadata::StatusInfo,因此其他 SysML v2 工具会将它们读取为状态注解。@StatusInfo { status = StatusKind::tbd; } 也同样计入。该包列在标准库的 Holarch 下。

关闭 TBD 或 TBR

  1. 打开需要与需求 → TBD/TBR。每个未决条目显示其负责人、截止日期和存在时长,并附有未决条目的燃尽图。
  2. 在文本或属性面板中输入最终值,然后点击该行上的关闭。TBD/TBR 属性会恢复为“无”,TBD/TBR 元数据会从这些值中移除。

编辑 doc 时,doc 中的标记会关闭。导出 XLSX会导出该登记册。

需求更改时,依赖于它的关联会作为该更改的一部分被标记为待评审,一次撤销即可将两者一并撤回。

  1. 打开需要与需求 → 待检查的链接。每个关联都会显示更改了什么、何时更改以及由谁更改。
  2. 点击差异查看旧的和新的名称及 doc,或点击在文本中显示在编辑器中打开该需求。
  3. 检查被关联的元素。如果它已不再适用,请更新它。
  4. 点击标记为已评审…,添加可选的评论,然后确认。

带有待评审关联的元素还会在属性面板中显示带有评审…的横幅,并在表格中显示 Review 徽章。数据库视图 Links to review 会列出这些元素。

计划和执行验证

  1. 打开验证 → 验证用例。
  2. 点击+ 新建 ▾ → 测试套件…添加一个包,然后点击+ 新建 ▾ → 测试用例…添加一个验证用法。
  3. 将一条需求关联到该测试用例。测试用例的目标中会添加一个 verify。
  4. 添加步骤,使用运行套件运行套件,并设置每个测试用例的状态。状态、预期和实际结果、步骤和周期都是 Holarch 数据。
  5. 打开验证 → RVTM,即可查看每条需求及其验证方法、验证它的测试用例以及从子需求汇总的状态。

实例:Hybrid Car 演示

先创建演示项目:管理项目 → 项目文件 ▾ → 新建演示项目 → Hybrid Car (SysML v2)。其需求位于包 VehicleRequirements 中。

  1. 打开需要与需求 → 需求。其中包括 VR-1 Curb Mass 到 VR-6 Battery Mass Limit,以及需求 carSpec,其下有 VR-1.1 Sedan Mass、VR-2.1 Sedan Acceleration 和 VR-4.1 Sedan Range。
  2. 选择 VR-1.1 Sedan Mass。它由验证用例 CurbMassTest 通过其目标中的 verify carSpec.sedanMass; 进行验证。
  3. 打开 TBD/TBR。VR-5 Charge Time 处于未决状态:其 limit 带有 #TBR,其 chargerPower 带有 @TBD,负责人为 Powertrain lead。
  4. 在编辑器中,将 maxCurbMass 从 1650 [kg] 改为 1600 [kg]。VR-1.1 Sedan Mass 使用 maxCurbMass 作为其限值,因此它的关联会被标记为待评审。
  5. 打开待检查的链接。其中列出了 VR-1.1 Sedan Mass 的 verified by 关联。点击差异,检查该测试,然后点击标记为已评审…。
  6. 打开验证 → 可追溯性矩阵,以需求为行、Asset 为列。carSpec 与 fleet.sedan 交叉的单元格显示 satisfied by,来自 satisfy carSpec by fleet.sedan;。

提示和良好做法

  • 为每条需求指定短名称。它是每个页面上和文档中的编号。
  • 将值写为属性,而不是写在 doc 中。attribute :>> limit = maxCurbMass; 可以被求值、由参数视图检查,并通过待评审的关联进行跟踪。
  • 用 #TBD 或 #TBR 标记未决值,而不是在值中写“TBD”。这样文本保持有效,登记册也能找到它们。
  • 将测试用例放在单独的包中。它会在验证用例页面上成为一个测试套件。

常见错误

  • 以为状态在文本中。状态、优先级和验证方法是 Holarch 数据。交换文件不包含它们。
  • 编写 limit = TBD。这不是有效的 SysML,文本会保持为草稿。请使用 #TBD attribute limit : TimeValue;。
  • 为移动需求而将其从文档中移除。移除会将其从模型中删除。请改为在编辑器中将其移到另一个包。

与其他功能的关联方式

  • 视图:需求视图绘制相同的需求以及 satisfy、verify、derive 和 refine 关系(SysML v2 视图)。
  • 仿真器:对照需求检查…从需求的 require 约束中获取准则,并将结果记录在验证用例上(求值、单位和分析)。
  • 文档:RTM、RVTM、VCRM、需求分解和分配矩阵块会列出模型的需求。
  • 变更控制:基线保存模型;比较会列出需求的更改(SysML v2 项目中的 Holarch 功能)。

需求和质量

需求页面

需求是筛选为 Requirement 类的数据库。它具有数据库的筛选器、视图、列、树模式、行内编辑、批量工具和导出功能(需求)。

  • + 新建会在包 Requirements 中添加一个带有下一个编号的需求用法。
  • 编辑编号、名称或描述会更改模型文本,每次更改都可通过一次撤销撤回。
  • 表格和定义导出包括种类、类型、多重性和值;在含个体的模型中还包括 Individual、部分(portion)和实例。
  • 选择一条需求会在 SysML v2 属性面板中显示它。其链接会在浏览器中打开它。

不适用于模型元素:更改类、复制、锁定和连同子项复制,以及项目数据 (JSON) 和项目包 (.holarch) 导出。导出项目…会将整个项目备份为 .holarch。

质量页面

质量按 LML 项目的九项准则为每条需求的描述评分:Appropriate、Complete、Conforming、Correct、Feasible、Necessary、Singular、Unambiguous 和 Verifiable(需求质量)。得分是 Holarch 数据。标记为已过时的得分属于较早的文本。

像在 LML 项目中一样筛选(筛选质量页面):+ 筛选,含质量、未通过某项准则和规则发现项分组、需求属性和标签、键入的 quality: 词项、搜索文本以及视图 ▾。

变更控制

当关联另一端的条目在该关联上次评审后发生了更改时,该关联需要评审(在其他工具中也称为可疑关联):检查该关联是否仍然成立,然后将其标记为已评审。需求的更改会将以下关联标记为待评审:satisfied by(satisfy)、verified by(verify)、decomposed by(拥有的需求)和 traced to(dependency)。

更改是指对以下任一项的编辑:

  • 需求的名称或 doc。
  • 关键属性:优先级、关键性、验证方法或验证级别。
  • 其拥有的属性的值,例如 attribute :>> limit = maxCurbMass;,或其某个约束。
  • 这些值或约束所指明的目标属性,例如 attribute maxCurbMass : MassValue = 1650 [kg];。

无论在何处进行更改都会计入:编辑器、视图、属性面板或表格。更改验证方法或验证级别只会将 verified by 关联标记为待评审,而首次设置时不会标记任何关联。

待检查的链接页面为每个关联提供差异、在文本中显示和标记为已评审…。

审批

审批列出处于“评审中”状态的需求。属性面板会显示状态以及审批、拒绝…和重新打开,还有设置状态的人员和时间。状态是模型旁边的 Holarch 数据;它不是 SysML 文本的一部分。

TBD/TBR 登记册

登记册列出每条未决需求及其负责人、截止日期和存在时长,以及未决条目的燃尽图和导出 XLSX。关闭会将 TBD/TBR 属性恢复为“无”,并移除这些值的 TBD/TBR 元数据。

截止日期是需求唯一的截止日期,与属性面板工作流分组中以及条目视图上的截止日期相同:

  1. 需求各值上 @TBD/@TBR 元数据中最早的 due,例如 @TBD { owner = "Powertrain lead"; due = "2027-06-30"; }。
  2. 否则为 TBD Due Date 属性。
  3. 否则为需求自身的截止日期。

登记册为只读。请在文本中更改日期,或在属性面板中设置截止日期。截止日期会将 due = "<date>"; 写入需求的每个 @TBD/@TBR 元数据正文(正文中没有时会添加),并设置需求的截止日期,一次撤销即可全部撤回。前缀形式 #TBD/#TBR 没有正文,因此仅以这种方式标记的值使用需求的截止日期。

验证页面

验证用例

套件、测试用例、状态、步骤、测试周期、运行套件和报告的作用与 LML 项目中相同(验证)。

  • + 新建 ▾ → 测试用例…会添加一个验证用法;测试套件…会添加一个包。
  • 关联需求会在测试用例的目标中添加一个 verify。
  • 状态、预期和实际结果、步骤和周期是存储在模型旁边的 Holarch 数据。

RVTM

每条需求及其验证方法、验证它的测试用例以及从子需求汇总的状态(RVTM)。⚠ 标记其 satisfy、verify 或分解关联需要评审的需求,以及其 verify 关联需要评审的验证用例。

可追溯性矩阵

行、列和关系的作用与 LML 项目中相同(可追溯性矩阵)。

  • 资产是部件用法(系统中的部件),Actions 是动作用法。
  • 对于类轴,Elements → 定义会改为列出定义。
  • 在模型元素之间,单元格可以包含 satisfied by(satisfy)、verified by(verify)、performed by(allocate 或 perform)、traced to(dependency)和 decomposed by(所有权)。其他关系显示为不允许。
  • 每次点击都可通过一次撤销撤回,并会更改模型文本。

模型检查

适用于模型的规则会运行(模型检查),以 SysML v2 术语表述如下:

  • 缺少名称、短名称(叶需求)、描述(其自身的或其定义的)、satisfy 或 verify 的需求用法,以及不含“shall”的叶需求;
  • 重复的短名称、含糊的措辞、指向缺失目标的实时值、无法显示的 UAF 视图;
  • 没有缓解措施的未关闭顶层风险、没有 Issue 的失败验证用例、超出阈值的 TPM;
  • 模型旁边的条目(风险、任务、决策、文档)中同名或没有关系的条目。

编辑器中的检查器涵盖名称、类型和结构,因此 LML 功能分析规则(Action、Asset、Conduit 和 Input/Output)不会运行,设置中只列出上述规则。不为模型元素提供合并修复。

消息

留言含义和解决方法
在 SysML v2 项目中不可用:请在编辑器中更改模型。该操作仅适用于 LML 实体。请在编辑器中进行更改。
更改未应用。该编辑会使文本无效。其旁边的消息会指出问题。
已过时 — 重新运行需求的文本在上次质量检查后已更改。请再次检查质量。
“…”满足“…”,但 … 未达到目标值 …。信息:部件满足阈值,但未达到目标值。请改进设计,或更改目标值。
“…”有目标值,但没有可与之比较的阈值。…该需求有 @Objective,但没有将某个量与一个值进行比较的 require 约束。请添加一个。
“…”有多个阈值(…),因此其目标值含义不明确。…该需求比较了多个量。请将其拆分为每个量一条需求。
“…”的目标值 … 不低于(不高于)其阈值 …。目标值必须超出阈值:对于上限要更低,对于下限要更高。
“…”的目标值 … 的单位为 …,但其阈值 … 的单位为 …。目标值的单位与阈值的单位属于不同的量。请使用阈值所属量的单位。
@Objective 适用于需求,但“…”是 …。该注解位于需求之外。请将其移入一条需求中。

限制

  • 状态、验证方法、其他需求属性、标签和测试结果是 Holarch 数据。SysML v2 交换文件不包含它们。
  • 更改类、复制、锁定和连同子项复制不适用于模型元素。
  • 模型检查中的合并修复不适用于模型元素。

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