SysML v2
SysML v2 项目入门
在 LML 项目和 SysML v2 项目之间进行选择,创建 SysML v2 项目或演示项目,编写第一个模型并熟悉界面。
本页内容
概述
Holarch 支持 SysML v2 项目。一个 SysML v2 项目包含一个模型,以 SysML v2 文本表示法编写,并基于 OMG SysML v2 规范。
您在编辑器中以文本形式编写模型。Holarch 将同一个模型保存为元素:包、定义、用法和关系。浏览器、视图和生命周期页面(需求、验证、接口、风险、计划)都显示这些相同的元素。
本页介绍两种项目类型、如何开始一个 SysML v2 项目以及各项内容的位置。语言本身的介绍见 SysML v2 文本表示法。编辑器和浏览器的介绍见文本编辑器和浏览器。
概念
两种项目类型
每个 Holarch 项目要么是 LML 项目,要么是 SysML v2 项目。您在创建项目时选择类型。类型固定不变:项目只能通过转换后的副本更改类型(请参阅在 LML 和 SysML v2 之间转换)。
| LML | SysML v2 | |
|---|---|---|
| 用途 | 用生命周期建模语言对系统建模:需求、功能、物理架构、接口、测试、风险和进度计划。Holarch 会在每一步检查您的工作。 | 以文本形式用 SysML v2 语言构建模型,使用标准 SysML v2 概念:包、定义和用法、端口、连接、动作、状态和需求。 |
| 如何构建模型 | 数据库、表单和 30 多种图类型。 | 编辑器中的文本,以及写入同一文本的视图和生命周期页面。 |
| 可以交换的内容 | Word、Excel、CSV、ReqIF 和 XMI 导入;Word、Excel 和图导出;项目文件。 | SysML v2 文本(.sysml)和 SysML v2 JSON(请参阅交换 SysML v2 模型);从 XMI 以及 Cameo 或 MagicDraw .mdzip 文件导入 SysML v1(请参阅导入 SysML v1 模型);项目文件。 |
如果不确定,请选择 LML。它拥有 Holarch 的所有页面和图,适合 MBSE 新手。当您的团队已经在用 SysML v2 建模,或与 SysML v2 工具交换模型时,请选择 SysML v2。
模型和文本是一体的
SysML v2 项目内部没有文件。模型是一组元素,编辑器为每个顶层包显示一个文本文档。文本解析成功时,Holarch 会将其应用到模型。当您在其他地方(视图、表格、属性面板)更改模型时,文本也会随之更改。请参阅文本和视图保持同步。
模型数据和 Holarch 数据
有些信息是 SysML 文本的一部分;有些由 Holarch 保存在模型旁边。
- 在文本中:元素名称、短名称(需求编号)、文档说明、类型、多重性、值,以及
satisfy、verify、perform和connect等关系。 - 在模型旁边(Holarch 数据):需求状态和审批、验证结果、标签、负责人、截止日期、讨论评论、视图布局、仿真器设置、预算、风险、决策和任务。它们按标识关联到模型元素,因此在重命名和移动后关联仍然保留。
Holarch 数据不会写入 SysML 文本,也不属于 .sysml 导出的内容。
定义和用法
大多数 SysML v2 关键字有两种形式。定义(part def Wheel;)描述一类事物。用法(part frontWheel : Wheel;)是某个定义在另一个元素内部的一次使用。同样的模式也适用于 port def/port、action def/action 和 requirement def/requirement。SysML v2 文本表示法对此有完整说明。
如何使用
选择项目类型
在创建项目之前确定类型。
- 选择 LML 以使用完整的 Holarch 方法:数据库、LML 图以及每一步的引导式检查。
- 当模型必须是 SysML v2 文本时选择 SysML v2,例如要与另一个 SysML v2 工具交换模型时。
- 要先试用 SysML v2,请打开 Hybrid Car 演示(下下个工作流程),而不是空白项目。
创建 SysML v2 项目
- 打开管理项目,然后点击+ 新建项目。
- 在您将如何对此系统建模?下,选择 SysML v2。
- 输入名称,然后点击创建项目。
项目在主页上打开。顶栏中和“管理项目”上的项目名称旁显示 SysML v2 标签。新模型是空的:主页上的后续操作显示在编辑器中编写第一个包。
打开 Hybrid Car 演示
Hybrid Car 演示是一个完整的 SysML v2 模型,可供探索和编辑。
- 打开管理项目。
- 点击项目文件 ▾ → 新建演示项目 → Hybrid Car (SysML v2)。
Holarch 会创建项目 Hybrid Car (SysML v2 demo),并在主页上打开它。点击导航栏中的编辑器以阅读文本。该模型有六个顶层包:Vehicles、VehicleRequirements、VehicleBehavior、VehicleViews、HolarchFrameworks 和 HybridCarArchitecture。每个包都是编辑器包列表中的一个文档。
该演示是您自己的副本。可以随意更改,或重新创建以从头开始。
要通过链接打开演示,请使用 https://app.holarch.app/#/?demo=hybrid。它会构建并打开演示;在托管应用上,它会在您登录后打开。
打开 Hybrid Car Battery Pack 演示
Hybrid Car Battery Pack 演示是汽车的牵引电池组,按其供应商的建模方式放在一个单独的项目中。如果您的项目中也有 Hybrid Car 演示(无论在它之前还是之后创建),三条电池组需求会关联到汽车的电池需求(BP-1 到 VR-3、BP-2 到 VR-6、BP-3 到 VR-5),因此管理项目 → 项目群地图会显示这两个项目如何相连。这些演示关联在所有方案上都可用。
- 打开管理项目。
- 点击项目文件 ▾ → 新建演示项目 → Hybrid Car Battery Pack (SysML v2)。
可以尝试的操作:
- 计算值:在编辑器中,
Pack::mass汇总各模块(每个模块 12 个电芯和一个外壳)、电池管理系统、接线盒、冷却系统和外箱:43 kg,限值为 48 kg,因此massMargin为 5 kg。Pack::capacity汇总 120 个电芯:1.44 kWh,要求为 1.4 kWh。选择一个属性,即可在属性面板中查看其值。 - 参数视图:打开 packParametrics。容量、质量、充电时间和电芯均衡检查各自绑定到电池组的值,并且都通过。
- RVTM:容量和质量为 Passed,充电接受能力为 Failed(高温充电测试用时 34 分钟,要求为 30 分钟),电芯均衡尚未运行。每个验证用例都根据模型计算其判定结果。
- 仿真器:仿真器在 pack 上打开,并同时加载 Hot Day Charge。点击运行到结束,然后点击状态:电芯过热时充电降至半功率,冷却后恢复。在一起运行下选择 Cell Over Voltage Fault,可查看保护性关断和维修复位。
打开地球观测卫星演示
地球观测卫星演示是一个更大的模型:EO-2 任务,一颗 12U 成像卫星及其地面段,约 3,000 行,分布在 14 个包中。Holarch 自己的数据填充在模型之上,因此每个页面都有内容可显示。
- 打开管理项目。
- 点击项目文件 ▾ → 新建演示项目 → 地球观测卫星 (SysML v2)。
Holarch 会创建项目 Earth Observation Satellite (SysML v2 demo) 并打开主页。该演示有 1,549 个条目,超过 Free 方案每个项目 1,000 个条目的限制:在 Free 方案上,其菜单项处于禁用状态,并显示需要 Individual 方案(1,549 个条目)。链接 https://app.holarch.app/#/?demo=eosat 也会构建它。可以尝试的操作:
- 文档:打开 EO-2 System Requirements Specification。其各节包含 EORequirements 的需求、实时值和一个验证矩阵。
- 预算:成像仪的质量超出其 4.0 kg 的分配值;TPM Imager Mass 显示其趋势。
- 待检查的链接和 TBD/TBR:需要处理的已更改需求和未定值。
- 仿真器:从 imagingPassFlow 视图运行成像过境过程。
- 基线:将 PDR Data Freeze 基线与当前模型进行比较。
- 视图:航天器模式、互连视图和任务编排序列。
编写您的第一个模型
此工作流程用以下文本构建一个小型无人机模型:
package Drone {
private import ISQ::*;
private import SI::*;
part def Battery {
attribute mass : MassValue = 0.4 [kg];
}
part def Quadcopter {
part battery : Battery;
}
}
- 打开模型 → 编辑器,点击+ 新建包,输入
Drone并确认。编辑器会打开新包的文本。 - 如上所示,在包的花括号内输入导入和成员。
- 停止输入。短暂停顿后,文本下方的状态行显示已应用。模型现在包含该包、两个部件定义、该属性和该部件,一次撤销即可全部撤回。
- 打开模型 → 浏览器,展开 Drone,以树形方式查看相同的元素。
如果某一行有错误,状态行会显示未应用:请修正第 N 行。在文本重新解析成功之前,模型保持其上一个正确状态。请参阅错误和草稿。
熟悉界面
SysML v2 项目保留了 Holarch 的生命周期导航栏。每个组都基于 SysML v2 模型工作。
- 从主页开始,查看需要处理的事项、生命周期组和后续操作。
- 使用模型 → 编辑器编写文本,使用模型 → 浏览器查看树。
- 使用需要与需求和验证处理需求、验证用例和可追溯性。
- 使用行为、架构和接口访问视图和分析页面。
- 打开导航栏底部的图工具,查看所有视图。
- 按 ⌘K / Ctrl+K,可按名称、短名称、限定名(
Vehicles::Car)或文档说明文本查找任何元素。 - 刚接触 SysML v2?开启简单模式,可首先看到最常用的元素。
实例:探索 Hybrid Car
本演练使用 Hybrid Car 演示。
- 创建该演示(请参阅打开 Hybrid Car 演示)。它会在主页上打开。打开模型 → 编辑器,然后在包列表中选择 Vehicles。
- 找到
part def Car。它有部件body、powertrain、frontAxle、rearAxle和spare : Wheel [0..1]。 - 按住 ⌘ / Ctrl 点击
part powertrain : Powertrain;中的Powertrain。光标会跳到part def Powertrain,它有部件tank、engine、motor、battery、transmission和controller,以及interface fuel : FuelLine connect tank.fuelOut to engine.fuelIn;等接口。 - 将指针指向
attribute mass : MassValue;中的MassValue。一张卡片会显示其种类以及在标准库中的限定名。 - 打开模型 → 浏览器。在按名称筛选中输入
sedan。树会在 Vehicles 中的fleet下显示sedan。选择它:属性面板显示种类 part、类型 Car,以及限定名Vehicles::fleet::sedan。 - 打开主页。需要与需求的生命周期卡片统计模型的需求数量;需要处理显示模型中待检查的链接、逾期的 TBD 和高风险。
- 打开需要与需求 → 需求。各行中包括
VR-1.1sedanMass,这是一个需求用法,其编号就是其短名称<'VR-1.1'>。 - 打开图工具,然后打开 driveCycleFlow,即
DriveCycle的动作流视图。在那里重命名一个动作,然后回到编辑器:VehicleBehavior 显示新名称。
提示和常见错误
- 从演示开始。从 Hybrid Car 文本中复制模式是学习该表示法最快的方式。
- 导入单位。
5 [kg]需要SI(MassValue需要ISQ)可见。在包中添加private import ISQ::*;和private import SI::*;。 - 每个项目只保留一个模型。将大型模型拆分为多个顶层包;每个包都是编辑器中的一个独立文档。
- 选错类型。类型无法就地切换。请从“管理项目”创建转换后的副本(⋯ → 创建 LML 副本…或创建 SysML v2 副本…)。
- 期望在文本中看到状态。需求状态、验证结果和标签属于 Holarch 数据。它们不会出现在文本中,也不会出现在
.sysml导出中。
SysML v2 项目中的导航栏
| 组 | 页面 |
|---|---|
| 主页 | 需要处理、生命周期、后续操作以及其他主页面板 |
| 需要与需求 | 文档、需求、质量、TBD/TBR、待检查的链接、审批、符合性矩阵* |
| 模型 | 编辑器、浏览器、导入和导出 |
| 行为 | 功能分析、动作流、FFBD、状态机、序列、仿真器 |
| 架构 | 部件、一般视图、互连视图、层级、预算和 TPM |
| 接口 | 接口登记册、ICD、N² 图、条目与输入/输出 |
| 验证 | RVTM、验证用例、偏离和让步*、可追溯性矩阵、项目群覆盖、模型检查 |
| 安全性与可靠性† | 危险源日志、FMECA、故障树、可靠性框图 |
| 风险、问题与决策 | 风险登记册、Risk 图、权衡研究、决策、问题与行动项 |
| 方案 | 我的工作、SE 流程、项目管理、图表、白板、演示文稿 |
| 控制与评审 | 变更请求、基线和版本、库、评审、活动 |
| 框架 | DoDAF、UAF |
* 需开启正式项目群功能。† 需开启安全性与可靠性项目群功能。两者都在项目偏好设置 → 项目群功能中切换。
底部的导航栏工具与 LML 项目中相同:数据库、图、回收站、设置和帮助。在 SysML v2 项目中,设置还列出标准库。不适用于 SysML v2 项目的页面不会显示。
这些页面的说明见 SysML v2 视图、SysML v2 项目中的需求与验证、SysML v2 项目中的求值、单位与分析和 SysML v2 项目中的 Holarch 功能。
简单模式
简单模式面向刚接触 SysML v2 的用户。它显示大多数模型起步时使用的元素,用一句话解释每个元素,并隐藏其余元素,直到您要求显示。它只改变您看到的内容:模型、其文本和所有导出都保持不变。
开启或关闭
- 偏好设置 → SysML v2 → 简单模式。
- 模型 → 浏览器页面标题中的简单模式(开启时呈按下状态)。
- ⌘K / Ctrl+K → 开启简单模式或关闭简单模式。
默认关闭。该设置属于您的账户:它会跟随您到任何登录的计算机上,登录时会应用账户的设置。重置偏好设置不会改变它。
第一次打开 SysML v2 项目时,顶栏下方会出现一条提示:初次使用 SysML v2?开启简单模式可优先查看最常用的元素。点击开启可打开简单模式,点击 × 可关闭提示。无论哪种回答都会保存在您的账户中,提示不会再次显示。在您未作答期间,每次打开 SysML v2 项目时都会显示它。简单模式已开启时不会显示。
显示内容
十二个概念,即 Hybrid Car 演示和教程中最常用的概念:包、部件、属性、端口、连接和接口、动作、流和后继、状态、转换、需求、满足以及验证。
| 位置 | 简单模式中显示 | 在“显示全部”前隐藏 |
|---|---|---|
| 一般视图,添加面板 | 包、部件定义、部件、端口定义、端口、属性、接口定义、动作定义、动作、需求定义、需求、验证用例 | 属性定义、项定义、枚举定义 |
| Spider 图,添加面板 | 包、部件定义、部件、端口定义、端口、属性、动作定义、动作、状态、需求定义、需求、验证用例 | 项定义、项、属性定义、用例 |
| 互连视图,添加面板 | 部件、端口 | 项 |
| 状态转换视图,添加面板 | 初始状态、终止状态、状态、entry 动作、do 动作、exit 动作 | 并行状态、区域 |
| 动作流视图,添加面板和 + Action ▾ | 动作、分叉、汇合、决策、合并、泳道 | 接受、发送、循环、终止 |
| 编辑器,插入 ▾ | 包、部件定义、部件、属性、端口定义、端口、接口、连接、动作定义、动作、后继、流、状态定义、状态、初始状态、转换、需求定义、需求、满足、验证定义、验证 | 适合光标位置的所有其他代码片段 |
| 模型 → 浏览器 | 包、定义、用法、连接、流、转换、需求、满足和验证 | 导入、别名、暴露、注释、文档、元数据、库包、绑定连接器、KerML 级元素,以及转换的触发器和效果行 |
将指针指向添加面板中的某一项,或浏览器中某一行的类型,即可阅读该元素的一句话说明。
需求视图、用例视图、参数视图、序列视图、包视图和几何视图,以及层级、树、IDEF0 和 FFBD 面板保留其所有项:它们各自都以所添加的类型为主题。+ 新建图、表格、搜索、属性面板以及在编辑器中键入(含自动补全)均不受筛选。
显示全部
- 添加面板:各项下方的显示全部(还有 n 项);显示更少会再次隐藏它们。
- + Action ▾:末尾的显示全部…会重新打开包含所有类型的菜单。
- 插入 ▾:勾选其标题中的显示全部。
- 浏览器:勾选筛选栏中的显示全部。
“显示全部”会持续到您重新加载页面或切换简单模式为止,在此期间简单模式保持开启。在浏览器中,从其他位置打开的元素(例如属性面板中的在浏览器中显示)及其所有者始终会显示,即使其类型被隐藏。
主页
主页与 LML 项目中是同一个页面(请参阅主页):需要处理(待检查的链接、逾期的 TBD、失败的测试、TPM 超限、高风险、模型检查、保存状态)、每个导航栏组一张生命周期卡片,以及后续操作、SE 流程关口和里程碑等面板。计数来自 SysML v2 模型及其旁边的 Holarch 数据。SysML v2 项目中不提供✦ 撰写项目摘要。
- 导航栏组显示相同的问题徽标,每个组的概览页面会列出需要处理的内容及其数量。
- + 添加面板 → 模型内容显示包(附顶层包的数量)、定义、用法、关系和需求(n 个未满足 · n 个未验证),元素失去所有者时显示错位元素,以及最近更改:最新的模型更改(创建、更改、移动、删除或恢复),附元素类型和时间。
询问 AI
询问 AI 根据帮助和文档回答有关 SysML v2 语言和 Holarch 使用方面的问题。在 Individual 和 Team 方案中,以及使用您自己或您组织的 AI 密钥时,它还会回答有关当前打开模型的问题并提出更改,这些更改会先打开供评审,然后才应用。请参阅询问 AI。
尚未提供
- 通过 Systems Modeling API 向
main提交、创建标签和合并:其他工具提交到变更请求分支,由审批人在 Holarch 中应用(请参阅 SysML v2 项目中的 API 和 MCP)。 - 编辑语言:标准库是只读的。
SysML v2 文本表示法详细列出了所支持的语言。
消息
| 留言 | 含义 |
|---|---|
| 模型为空 | 项目没有任何元素。点击+ 新建包,然后在编辑器中编写其成员。 |
| 未应用:请修正第 N 行。 | 文本的第 N 行有错误。在文本能够解析之前,模型保持其上一个正确状态。 |
| 仅查看:请向所有者申请编辑权限。 | 您对该项目拥有查看权限。文本和页面均为只读。 |
| 此项目需要更新版本的 Holarch。 | 该项目由更新版本的 Holarch 保存,而此页面较旧。项目以仅查看方式打开,顶部的横幅会说明原因。点击横幅中的重新加载以获取新版本。 |
限制
- 项目类型在创建时即已确定。
- 每个项目一个模型。
- 大于 8 MB 的文本文档不会被检查;请将其拆分为多个包。
相关页面
SysML® 和 OMG® 是 Object Management Group, Inc. 在美国和其他国家/地区的注册商标。