Holarch

面向开发者

Holarch Language Engine

面向 SysML v2 和 KerML 的语言引擎,可获得授权使用。

支撑 Holarch 的 SysML v2 项目的引擎,可用于您自己的产品。它对 SysML v2 和 KerML 文本进行解析、名称解析、检查和求值,以 WebAssembly 在浏览器中运行,或在您的服务器上运行。

Holarch Language Engine 的运行演示:输入数值时出现单位错误,修正后错误消失;转到定义跳转到另一个 package 中的 part 定义;在命令行中检查一个 250,000 行的模型,并显示诊断代码和耗时

适用对象

希望在自己的产品中使用 SysML v2 文本,而无需自行编写和维护语言实现的团队。

工具厂商

为建模、绘图或架构工具添加 SysML v2 编辑、检查和导入功能。

PLM、需求和仿真产品

读取 SysML v2 模型,跟踪需求和带单位的数值,并与其他工具交换模型。

企业内部工程工具团队

在评审流水线中检查模型、生成报告,并在公司工具中为工程师提供 SysML v2 编辑器。

功能

一个引擎覆盖从文本到经过检查的模型的整个过程,JSON 输入,JSON 输出。

解析

SysML v2 和 KerML 文本表示法,具备错误恢复能力:一处错误不会掩盖文件其余部分。标准库随引擎一起加载。

名称解析

跨 package 和文件的名称、import、别名、特化、类型定义和重定义,并提供悬停提示、转到定义、自动补全和重命名。

检查

135 个诊断代码,每个都带有严重级别、精确范围、消息以及编辑器可作为快速修复提供的建议修复。

求值

带单位和量的表达式,例如将 body + 4 * 12 [kg] 求值为 348 [kg],以及需求约束和验证用例。需求阈值及其追求的目标值从模型中读取。

边输入边重新分析

文档会话只重新解析更改的部分并发送 token 增量,因此编辑器在大型模型上也能保持响应。

编辑文本而不丢失格式

来自图或表单的更改会写回文本。未更改的文本、注释和排版完全保持用户原来的写法。

差异比较、合并和变基

将模型的两个版本作为更改列表进行比较并应用这些更改,还可将文本编辑变基到较新的模型更改之上。

变体

检查变化点、变体和配置,并可列出所有变体组合,依据模型的约束逐一判断。

仿真(附加组件)

在仿真时间上运行动作流和状态机,可单次运行、结合您产品的输入逐步运行,或进行蒙特卡洛研究。相同的种子在浏览器和服务器上给出相同的结果。

JSON 交换

导入和导出 SysML v2 JSON,并以带稳定 ID 的普通记录读取模型。文本可以携带每个元素的 ID,因此读回编辑后的文本时,每个元素在重命名和移动后仍保持其身份。

已在 Holarch 中得到验证

Holarch 中的每个 SysML v2 项目都运行同一个引擎:编辑器、视图和生命周期页面。

附加组件

引擎本身即可检查、分析和编辑模型。三个附加组件对其进行扩展,每个单独授权,由您的许可证令牌启用,无需重新构建,也无需更改代码。

仿真

在仿真时间上运行动作流和状态机:单次运行、结合您产品的输入逐步运行,或进行蒙特卡洛研究。相同的种子在浏览器和服务器上给出相同的结果。带仿真注解的模型无需该组件也能通过检查。

SysML v1 到 SysML v2 迁移

将 SysML v1 模型转换为经过检查的 SysML v2 文本,并为每个元素提供报告:已转换、已近似或已丢弃。迁移附加组件的工作方式。

服务器端使用

在浏览器页面之外运行引擎:Node.js、Deno、无服务器函数或 Python 扩展。在构建流水线中检查模型、批量转换模型,或响应您自己服务的请求。

附加组件:SysML v1 到 SysML v2 迁移

迁移附加组件依据 OMG SysML 2.0 规范中的 SysML v1 到 SysML v2 转换,将 SysML v1 模型转换为 SysML v2 文本。它是 Holarch 的 SysML v1 导入背后的转换器,与引擎分开授权。

  • 输入:以 JSON 表示的 SysML v1 模型,采用 API 参考中说明的中立形式。由您的产品读取 XMI 文件(来自 Cameo 或 MagicDraw、Enterprise Architect、Rhapsody 或 Papyrus)并发送模型;引擎不读取 XML,也不读取文件。
  • 输出:SysML v2 文本、引擎对该文本的检查结果,以及一份报告,列出每个元素为已转换、已近似或已丢弃,并附有稳定的原因代码和其对应的 SysML v2 名称。
  • 可重复:同一个模型每次都转换为相同的文本。
  • 有界:模型最多 250,000 个元素和 8 MiB 文本;更大的模型会得到错误响应,而不会挂起。

该请求为 API 参考中的 v1_convert。未购买该附加组件时,引擎以 feature-not-licensed 响应该请求,其他所有请求照常工作。

一个请求及其响应

// Request (the model shortened)
{ "op": "v1_convert",
  "model": { "format": "holarch-xmi-model", … } }

// Answer (shortened)
{ "text": "package 'Rover Model' { … }",
  "diagnostics": [],
  "report": {
    "summary": { "elements": 31, "converted": 27,
                 "approximated": 2, "dropped": 2 },
    "items": [ { "kind": "Association",
                 "status": "dropped",
                 "reason": "association" }, … ] } }

由引擎转换的一个小型测试模型:31 个元素,转换后的文本中没有诊断。

运行方式

在浏览器中,引擎是运行在 Web Worker 中的 WebAssembly 模块,因此分析从不阻塞页面。一个小型 JavaScript 集成层负责发送请求,并以 Promise 返回响应。可应要求提供用于 Node.js 或 Python 的服务器构建。

How the engine fits into a browser applicationYour application calls the JavaScript integration layer with JSON requests. The layer passes them to a Web Worker that runs the WebAssembly engine with the standard library loaded, and returns JSON answers. The engine has no network or file access. Your application editor, views, pipeline JavaScript integration layer requests as promises WEB WORKER Holarch Language Engine WebAssembly, no network or file access Standard library JSON

一个请求及其响应

// Request
{ "op": "analyze",
  "text": "package P { part a : Engine; part b }" }

// Answer (tokens left out)
{ "diagnostics": [
    { "code": "syntax.expected-token",
      "args": { "expected": ";", "found": "}" },
      "range": { "from": 35, "to": 35 },
      "severity": "error" },
    { "code": "name.unresolved",
      "args": { "name": "Engine" },
      "field": "typedBy",
      "range": { "from": 21, "to": 27 },
      "severity": "error" } ] }

引擎集成指南中的一个真实请求及响应:一个语法错误和一个无法解析的名称,各自带有稳定的代码和文本中的精确范围。

性能

在一个生成的 10,000 行模型上测得:

  • 从零开始分析整个 10,000 行模型(解析、名称解析和检查)需要 150 毫秒;在 Safari 中以 WebAssembly 运行需要 215 毫秒。
  • 编辑后再次检查该 10,000 行模型需要 1.3 至 6.8 毫秒(第 95 百分位);在 Safari 中以 WebAssembly 运行需要 3 至 4 毫秒。
  • 引擎基准(已加载标准库):17 MiB。整模型分析每 10,000 行约增加 29 MiB,完整的编辑会话每 10,000 行约增加 33 MiB。
  • WebAssembly 压缩后约 0.74 MB。

使用最多 250,000 行的生成模型进行了测试:各规模的结果。

实际数值取决于模型和计算机。评估期间可以在您自己的模型上进行测量。

安全

  • 无网络或文件访问。WebAssembly 模块不从页面导入任何内容:它读取您传入的文本和记录,并返回 JSON。
  • 输入限制。输入大小、行长度、嵌套和表达式深度均有上限,因此恶意文件无法耗尽内存或栈。
  • 经过模糊测试。请求、词法分析器和解析器入口、仿真器以及语言操作都经过模糊测试。
  • 隔离运行。在浏览器中,它运行在自己的 Worker 中。故障只会停止该 Worker,由您的页面重新启动它。

您将获得

  • 引擎:WebAssembly 构建,含标准库。
  • JavaScript 集成层:Worker 以及供您页面使用的客户端。
  • 开发者文档:集成指南、包含真实请求和响应的所有请求的参考、诊断代码列表,以及可运行的示例(最小页面、编辑器、模型浏览器、Node.js 和 Python)。
  • 许可期内的更新。
  • 由构建引擎的团队通过电子邮件提供支持。

授权

  • 年度许可证,每次一年,按您产品中由引擎支持的功能的月活跃用户数定价。
  • 在您自己的计算机上进行的免费 60 天评估,附文档和示例。
  • 面向大学和研究团体的学术和研究许可证。
  • 企业使用可应要求提供:适用于多个产品或大量用户。
  • 附加组件:仿真、SysML v1 到 SysML v2 迁移以及服务器端使用,每个单独授权。

告诉我们您的产品和预期用户数,我们将发送报价。

语言支持

当前版本为 Holarch Language Engine 2.1.2。它基于 OMG SysML v2 规范,支持 SysML v2 和 KerML 的一个子集。SysML v2 语言覆盖范围列出了在 Holarch 中可用的受支持构造和已知缺口。评估文档中包含针对引擎的相同列表。

引擎在官方示例模型上与 OMG 试点实现的比较,以及它在损坏文本和大型模型上的表现(包括失败情况):Language Engine 测试结果。

在您自己的模型上试用引擎。

评估在 60 天内免费。