Holarch

指南 · SysML v2

SysML v2 工具:选择前需要检查什么

收听本指南(英文音频) 16 分钟

一份 SysML v2 工具评估指南:任何候选工具都需要检查什么,如何区分真正的支持和幻灯片上的宣传,一张用于打分的检查清单表,以及一个可加载到每个工具中的小型测试模型。

本页内容
  1. 为什么 SysML v2 工具需要单独评估
  2. 需要检查什么
    1. 语言覆盖范围,以及差距如何记录
    2. 文本表示法:编辑与检查
    3. 图形视图,以及文本与图的同步
    4. 标准库
    5. Systems Modeling API
    6. JSON 交换与往返
    7. 从 SysML v1 迁移
    8. 协作与版本控制
    9. 基于模型的需求与验证
    10. 带单位的分析与求值
    11. 部署:云端或自托管
    12. 许可与成本
    13. 培训
  3. 评估检查清单
  4. 可加载到任何候选工具中的测试模型
    1. 检查器的两个探针
  5. 开展评估
  6. Holarch 对检查清单的回答
  7. 在 Holarch 中试用
  8. 后续阅读

为什么 SysML v2 工具需要单独评估

SysML v2 是一门新语言,而不是 SysML v1 的修订版(SysML v1 与 v2 有何不同对两者进行了详细比较)。它既有文本表示法,也有图形表示法,有基于 KerML 的形式化语义基础,有包含量、单位和视图种类的标准库,还有用于读写模型的标准 API。一个工具可以声称支持 SysML v2,却只覆盖其中一部分,而它遗漏的部分可能正是您的项目所依赖的。

规范的篇幅很大,每个工具都是分步实现的。这很正常。评估中重要的是,您知道一个工具已经完成了哪些步骤、还没有完成哪些步骤,以及厂商是否坦白地告诉您。下面的检查适用于任何 SysML v2 工具,无论其价格或部署方式如何,而测试模型为每个候选工具提供相同的输入。

要寻找候选工具,可以从 OMG 维护的 SysML v2 工具列表,以及 INCOSE 和 OMG 为支持从 SysML v1 过渡而发布的 SysML v2 工具能力摘要入手。两者都只是起点:从中获取名称,然后亲自测试每个工具。

需要检查什么

语言覆盖范围,以及差距如何记录

索取一份覆盖范围说明:语言的每个领域(包、定义和用法、特化和重定义、多重性、值和单位、约束、结构、动作、状态、需求、用例、分析用例和验证用例、视图、元数据、可变性、个体和时间切片),以及每个领域的级别。有用的级别会区分四种情况:

  • 工具解析、检查并使用该构造;
  • 工具这样做,但有明确说明的限制;
  • 工具完全按原文保留该构造,但不赋予其含义(它能经受往返,但没有任何东西检查或计算它);
  • 工具不接受该构造。

公布已知差距的厂商,比只列出功能的厂商更便于规划。将没有覆盖范围表的“支持 SysML v2”视为未知,并测试您的模型所使用的构造。

文本表示法:编辑与检查

文本表示法是 SysML v2 与 v1 差异最大的地方,也是各工具差异最大的地方。检查:

  • 编辑:语法着色、名称和关键字补全、转到定义、在整个模型中重命名、查找和替换。
  • 输入时检查:语法错误是最低要求。有用的检查器还会通过导入解析每个名称,报告重复和有歧义的名称,对照继承内容检查重定义,比较单位量纲,并比较连接两端的端口和流方向。
  • 文本就是模型:编辑之后,其他每个视图是否都能看到更改,还是说文本只是工具不时导入的一个文件?
  • 不是工具写出的文本:加载手写的或由其他工具写出的文本。注释、文档和文本的排版都应当保留。

图形视图,以及文本与图的同步

在 SysML v2 中,视图是一个模型元素:它声明自己暴露和过滤的内容,由工具负责渲染。标准库定义了一般视图、互连视图、动作流视图、状态转换视图、序列视图和网格视图。检查工具能绘制其中哪些、能在哪些中进行编辑,以及它如何处理规范留给工具决定的布局。

关键的测试是双向同步。在文本中重命名一个部件,然后查看显示它的每张图。在图中添加一个连接,然后阅读它生成的文本。接着,如果可以两个人同时操作,就同时修改两边,看看工具如何处理冲突。

标准库

SysML v2 的大部分含义存在于其标准库中:标量值、国际量制、SI 和美国习惯单位、标准视图定义以及 KerML 内核库。工具应当附带该库,根据它解析名称,并用它进行求值。检查 ISQ 量的种类和 SI 单位能否解析,库是否不会被意外修改,以及工具使用的是哪个版本的库。

Systems Modeling API

Systems Modeling API 是模型存储库的标准 REST 接口:项目、分支、提交和元素。它使工具无需文件即可交换模型,也使您自己的脚本能够读取模型。工具可以扮演两种角色,任何一种都可能是只读的:

  • 客户端:工具从另一个提供该 API 的存储库拉取,并向其推送。
  • 服务器:工具提供该 API,使其他工具可以读取(也许还可以写入)它的模型。

询问是哪种角色、哪些路由,以及是否提供写入、查询、差异比较和旧提交。只读服务器对报告和为分析工具提供数据仍然有用;但当另一个工具必须更改模型时,它就不够了。

JSON 交换与往返

除文本外,模型还以 SysML v2 JSON 在工具之间传递:这是 API 的元素格式,每个元素都有一个 id。id 很重要:文本不带 id,因此重新导入文本的工具只能按名称匹配元素,而 JSON 能在交换过程中保留身份。测试一次往返:从工具 A 导出,导入工具 B,再导出并导入 A。然后比较元素数量、名称、带单位的值和关系,并阅读每个工具如何报告它丢弃了什么。工具不支持的元素种类正是往返中丢失数据的地方。

从 SysML v1 迁移

从 v1 到 v2 不存在无损的自动翻译:两种语言的结构不同,而 v1 图带有在 v2 中没有单一对应物的布局和构造型。询问工具如何引入 v1 模型(通常是带有 SysML 1.x 配置文件的 XMI),它将块、部件、端口、活动、状态机和需求映射为什么,以及它是否生成一份未转换内容的报告。用您自己的一个 v1 模型来试,而不是用厂商的示例。

协作与版本控制

系统模型是团队工作。检查多人能否同时编辑,冲突如何显示和解决,有哪些角色(编辑、评审、查看),历史和基线如何运作,以及能否逐元素和以文本形式比较两个版本。如果您的组织将模型保存在存储库中,请检查分支、合并,以及工具自身的版本历史与存储库提交之间的关系。

基于模型的需求与验证

SysML v2 使需求成为针对主体的约束,并通过 satisfy 和 verify 关系连接到设计和验证用例。检查工具是否将需求文本和约束放在一起,是否根据模型的值计算约束,以及是否根据 verify 关联构建验证矩阵。还要检查工具在语言之外保存了什么:需求状态、审批、测试结果以及变更后的可疑关联。这些不属于 SysML v2 文本,因此要询问它们存储在哪里,以及是否随导出一起传递。

带单位的分析与求值

SysML v2 模型中的每个值都可以带单位,表达式会将它们组合起来。检查工具能否计算带单位的表达式(由三个部件质量得出以千克为单位的总质量),能否将量纲错误报告为错误,以及能否根据结果计算需求约束。然后检查您需要的更大的分析功能:参数求解、预算和汇总、权衡研究、动作流或状态机的仿真。询问哪些内容是根据模型计算的,哪些需要额外的工具特定数据。

部署:云端或自托管

检查模型存放在哪里,以及由谁运行工具:托管服务、桌面安装,还是您自己环境中的服务器。对于受控或受出口限制的数据,询问自托管、数据位置、登录选项,以及 AI 功能(如果有)如何配置或关闭。

许可与成本

比较您团队的总成本,而不是每个席位的标价:查看者和评审者、学术或评估用途、API 或服务器选项的成本,以及停止付费后您的模型会怎样。检查是否每个方案都提供标准格式的导出,以确保您的模型始终归您所有。

培训

对大多数工程师来说,SysML v2 都是新的,包括熟练掌握 v1 的工程师。寻找能涵盖工具所支持表示法的参考文档、实例、可供探索的演示模型,以及针对工具自身界面的引导材料。语言培训和工具培训是不同的需求;检查两者是否都有覆盖。

评估检查清单

用相同的问题和相同的输入为每个候选工具打分。“已演示”指您亲眼看到它在测试模型或您自己的模型上运行,而不是在幻灯片上。

领域需要提出的问题如何测试
语言覆盖范围是否有公开的覆盖范围表并列出已知差距?在其中查找您的模型所使用的构造;加载测试模型
文本表示法编辑器是否在输入时检查名称、重定义、单位和方向?加载两个探针;每个都应报告一个问题
图形视图哪些标准视图可以绘制和编辑?打开测试模型的互连视图和状态转换视图
文本与图的同步任一侧的更改是否会立即出现在另一侧?在文本中重命名 controller;在图中添加一个连接并阅读文本
标准库ISQ 量、SI 单位和标准视图能否解析?测试模型导入了 ISQ、SI 和 StandardViewDefinitions
Systems Modeling API客户端、服务器还是两者兼有?只读还是可读写?从另一个工具或用脚本读取测试模型的元素
JSON 往返元素 id 是否保留?丢弃了什么,是否有报告?导出,导入第二个工具,再导出,然后比较
v1 迁移是否有从 SysML v1 导入的途径,并附报告?转换您自己的一个 v1 模型
协作并发编辑、角色、基线、比较?两个人编辑同一个包;与基线进行比较
需求与验证是否计算约束并构建验证矩阵?将质量限值降低到 20 kg,看需求是否不满足
带单位的分析值是否带单位求值?还计算哪些内容?检查 totalMass 的计算结果是否为 23 kg
部署托管、桌面还是自托管?索取书面的选项说明,包括数据位置
许可与成本作者、评审者和查看者的总成本;是否每个方案都可导出?为您的团队(包括评审者)估算价格
培训语言参考、示例、工具指南?让一位新用户仅凭文档为测试系统建模

可加载到任何候选工具中的测试模型

这个模型小到可以手工输入,却仍然涉及评估所需的大部分内容:从标准库导入、带有重定义值和单位的部件定义和用法、共轭端口、连接和一个绑定、一个状态机、一个带有后继的动作、两条带约束的需求、一个 satisfy、一个验证用例以及两个视图。将其保存为 pump-station.sysml 并加载到每个工具中。

该系统是一台太阳能水泵:太阳能板为控制器供电,控制器驱动水泵。整机重量不得超过 25 kg,太阳能板的峰值功率必须比水泵的额定功率至少高出 20%。如果您不熟悉这种表示法,SysML v2 教程介绍了本模型使用的每个构造。

package PumpStation {
  doc /* A solar-powered water pump: a small probe model for evaluating SysML v2 tools. */

  private import ScalarValues::*;
  private import ISQ::*;
  private import SI::*;

  port def PowerPort {
    out attribute voltage : ElectricPotentialValue;
  }

  port def WaterPort {
    out attribute pressure : PressureValue;
  }

  part def SolarPanel {
    attribute mass : MassValue;
    attribute peakPower : PowerValue;
    port powerOut : PowerPort;
  }

  part def Controller {
    attribute mass : MassValue;
    port powerIn : ~PowerPort;
    port motorOut : PowerPort;
  }

  part def Pump {
    attribute mass : MassValue;
    attribute ratedPower : PowerValue;
    port powerIn : ~PowerPort;
    port outlet : WaterPort;
  }

  item def StartSignal;
  item def StopSignal;

  state def PumpModes {
    entry; then idle;
    state idle;
    state pumping;
    transition first idle accept StartSignal then pumping;
    transition first pumping accept StopSignal then idle;
  }

  action def DeliverWater {
    action convertSunlight;
    action regulatePower;
    action driveImpeller;
    first start then convertSunlight;
    first convertSunlight then regulatePower;
    first regulatePower then driveImpeller;
    first driveImpeller then done;
  }

  part def PumpUnit {
    part panel : SolarPanel {
      attribute redefines mass = 12 [kg];
      attribute redefines peakPower = 400 [W];
    }
    part controller : Controller {
      attribute redefines mass = 2 [kg];
    }
    part pump : Pump {
      attribute redefines mass = 9 [kg];
      attribute redefines ratedPower = 300 [W];
    }
    port outlet : WaterPort;

    connect panel.powerOut to controller.powerIn;
    connect controller.motorOut to pump.powerIn;
    bind outlet = pump.outlet;

    attribute totalMass : MassValue = panel.mass + controller.mass + pump.mass;
    exhibit state modes : PumpModes;
  }

  part pumpUnit : PumpUnit {
    perform action delivery : DeliverWater;
  }
}

package PumpRequirements {
  private import PumpStation::*;
  private import ScalarValues::*;
  private import ISQ::*;
  private import SI::*;

  requirement def <'PS-1'> MassLimit {
    doc /* The pump unit shall weigh no more than the mass limit, so that one person can carry it. */
    subject unit : PumpUnit;
    attribute limit : MassValue;
    require constraint { unit.totalMass <= limit }
  }

  requirement def <'PS-2'> PowerMargin {
    doc /* The panel's peak power shall exceed the pump's rated power by at least 20 %. */
    subject unit : PumpUnit;
    require constraint { unit.panel.peakPower >= 1.2 * unit.pump.ratedPower }
  }

  requirement pumpSpec {
    subject unit : PumpUnit;
    requirement mass : MassLimit {
      attribute redefines limit = 25 [kg];
    }
    requirement power : PowerMargin;
  }

  satisfy pumpSpec by pumpUnit;

  verification def <'VC-1'> WeighUnit {
    doc /* Weigh the assembled pump unit on a calibrated scale. */
    subject unit : PumpUnit;
    objective {
      verify pumpSpec.mass;
    }
    return verdict : Boolean = unit.totalMass <= pumpSpec.mass.limit;
  }
}

package PumpViews {
  private import PumpStation::*;
  private import StandardViewDefinitions::*;

  view unitConnections : InterconnectionView {
    expose PumpStation::PumpUnit;
  }

  view pumpStates : StateTransitionView {
    expose PumpStation::PumpModes;
  }
}

支持这些构造的工具应当显示:

  • 没有错误,也没有警告。如果工具在这里报告问题,要么是缺少某个构造,要么是对标准库的读取方式不同;请询问是哪一种。
  • totalMass 的计算结果为 23 kg:12 kg + 2 kg + 9 kg。
  • 两条需求都成立:23 kg 在 25 kg 以内,400 W 大于 1.2 × 300 W = 360 W。
  • unitConnections 绘制太阳能板、控制器和水泵及其端口、两个连接,以及绑定到整机边界的出口。
  • pumpStates 绘制两个状态,带有一个初始转换和两个由触发器触发的转换。
  • 验证矩阵列出由 VC-1 验证的 PS-1,以及没有验证用例的 PS-2。

检查器的两个探针

检查器的价值体现在发现错误上。单独加载每个探针;每个探针恰好包含一个问题。

第一个探针给功率赋了一个以千克为单位的值。检查量纲的工具会在该值上报告错误:

package UnitProbe {
  private import ISQ::*;
  private import SI::*;

  part def Pump {
    attribute ratedPower : PowerValue;
  }

  part pump : Pump {
    attribute redefines ratedPower = 300 [kg];
  }
}

第二个探针可以干净地完成语法解析和名称解析,但它的需求不成立:整机重 11 kg,而限值为 10 kg。能够计算需求约束的工具会报告这一点;只做解析的工具则会默默接受。

package RequirementProbe {
  private import ISQ::*;
  private import SI::*;

  part def Pump {
    attribute mass : MassValue;
  }

  part def Unit {
    part pump : Pump {
      attribute redefines mass = 9 [kg];
    }
    attribute totalMass : MassValue = pump.mass + 2 [kg];
  }

  requirement def Light {
    subject unit : Unit;
    require constraint { unit.totalMass <= 10 [kg] }
  }

  part unit : Unit;
  requirement light : Light;
  satisfy light by unit;
}

与测试模型一样,两个探针都已用语言引擎检查过:模型没有问题,每个探针恰好产生所述的那一个问题。

开展评估

  1. 先写下您的需要。您的模型使用哪些构造,评审者阅读哪些视图,哪些工具必须交换模型,以及数据可以存放在哪里。据此为检查清单的各行设定权重。
  2. 阅读每个厂商的覆盖范围说明和已知差距。将检查清单的每一行标记为已声明、未声明或未说明。
  3. 将测试模型和探针加载到每个候选工具中。逐字记录每个工具报告的内容。
  4. 加载您自己的一个模型。真实模型能发现示例发现不了的问题:规模、命名、少见的构造。
  5. 进行一次往返,对象是与您交换最多的工具。
  6. 让一位新用户仅凭工具的文档构建测试模型,并记录所用时间。

将证据(截图、导出的文件、每个工具给出的消息)与评分一起保存。对评审委员会来说,一份显示测试内容的决策记录,比从厂商材料中复制的功能矩阵更有价值。

Holarch 对检查清单的回答

本页的截图使用的是 Holarch,因此这里给出它自己的回答,每条都附有支持它的页面。“部分支持”和“尚未支持”就是字面意思。

领域级别Holarch 目前
语言覆盖范围部分支持一张公开的表格,列出每个领域及其级别、限制和已知差距。可变性、个体和时间切片、用户定义关键字和语义元数据会被检查和求值;.kerml 文件尚不能导入;SysML 和 KerML 中的文本表示会被检查,其他语言作为文本保留。SysML v2 语言覆盖范围
文本表示法已支持在输入时进行检查(语法、名称、类型、多重性、单位、方向、求值)的编辑器,提供补全、转到定义、重命名以及查找和替换。编辑器、检查
图形视图部分支持一般视图、互连视图、动作流视图、状态转换视图、序列视图和网格视图,均可编辑。序列视图绘制生命线之间的消息以及组合片段(alt、opt、loop 和 par)。SysML v2 视图
文本与图的同步已支持文本和每个视图背后是同一个模型;任一侧的编辑都会显示在另一侧。文本与视图保持同步
标准库已支持已加载且只读,包含 ISQ、SI 和美国习惯单位以及标准视图定义。标准库
Systems Modeling API部分支持作为客户端:从提供该 API 的存储库的一个分支拉取并向其推送。作为服务器:其他工具读取当前模型并提交到变更请求分支,由审批人在 Holarch 中应用。拉取和推送、Systems Modeling API
JSON 往返部分支持SysML v2 JSON 导入和导出,保留元素 id。Holarch 不解释的元素种类按导入时的原样保留,并在导出时原样写回。交换 SysML v2 模型
v1 迁移部分支持将 SysML 1.x 模型(Cameo 或 MagicDraw .mdzip,或来自 Cameo、Enterprise Architect、Rhapsody 或 Papyrus 的 XMI)直接导入 SysML v2 项目,转换为 SysML v2 文本并进行检查,并附一份报告,说明哪些内容已转换、近似转换或未包含,以及原因。图及其布局不会被转换。导入 SysML v1 模型
协作已支持实时编辑,编辑器中按成员逐一合并,角色,保存模型的基线,以及按元素和按包文本进行比较。协作、基线
需求与验证已支持根据模型计算需求约束,根据 verify 关联构建 RVTM 和测试中心,审批、TBD/TBR 以及待检查的链接。需求与验证
带单位的分析部分支持带单位的求值、每个约束求解一个未知数的参数视图、预算、权衡研究,以及动作流和状态机的仿真。只有当每个输入都有值时,才会对分析用例求值。求值、单位与分析
部署已支持托管的 Web 应用,并可应要求在您自己的环境中进行自托管部署。安全、联系我们
许可与成本已支持面向学生、教师、个人项目和个人评估的 Free 方案;公司可以免费试用 Individual 方案 1 个月;付费方案用于商业用途;每个方案都提供免费的评审者和查看者。价格
培训部分支持涵盖每个 SysML v2 页面的文档参考、分步教程、Hybrid Car 演示、九个应用内 SysML v2 引导式教程,以及一套构建 Hybrid Car 模型的 SysML v2 视频教程系列。视频培训课程涵盖 LML 项目。入门、SysML v2 教程、SysML v2 教程

在 Holarch 中试用

  1. 将测试模型保存为 pump-station.sysml。
  2. 打开模型 → 导入和导出,选择导入到新的 SysML v2 项目,然后拖放该文件。参见将文件导入新项目。
  3. 打开模型 → 编辑器。状态行显示“No problems”(没有问题),每个包都是一个文档。
  4. 打开图列表,点击 unitConnections 或 pumpStates。
  5. 打开验证 → RVTM,查看需求及验证它们的用例。
编辑器中的测试模型,没有问题。
unitConnections 视图:共轭端口、两个连接和一个绑定。
由模型的 verify 关联构建的 RVTM。

后续阅读