Holarch

SysML v2

在 LML 和 SysML v2 之间转换

生成 LML 项目的 SysML v2 副本,或 SysML v2 项目的 LML 副本,并附带一份报告,说明哪些内容可以转换、哪些不能。

使用方法 →

本页内容
  1. 概述
  2. 概念
    1. 是副本,而不是更改类型
    2. 两种语言如何对应
    3. Holarch 数据随之复制
    4. 不转换的内容
  3. 如何使用
    1. 何时使用及原因
    2. 创建转换后的副本
    3. 检查副本
    4. 实例:将 Hybrid Car 演示转换为 LML 副本
    5. 提示和良好做法
    6. 常见错误
  4. 报告参考
    1. LML 到 SysML v2
    2. SysML v2 到 LML
    3. 报告 CSV
  5. 消息
  6. 限制
  7. 相关页面

概述

项目的类型(LML 或 SysML v2)在创建时就已确定。要在 SysML v2 中处理 LML 模型,或在 LML 页面中处理 SysML v2 模型,请创建转换后的副本:

  • LML 项目上的创建 SysML v2 副本…会将其模型以 SysML v2 文本写入一个新的 SysML v2 项目。
  • SysML v2 项目上的创建 LML 副本…会将其模型转换为新 LML 项目中的 LML 实体和关系。

原始项目永远不会被更改。在创建副本之前,报告会列出哪些内容会转换(附数量)以及哪些不会转换(附原因)。同一份报告会保存在新项目中。

概念

是副本,而不是更改类型

转换总是创建一个新项目。您可以继续在原始项目中工作,之后再次转换;每次转换都会生成另一个新项目。副本与原始项目之间没有任何关联。

两种语言如何对应

LML 和 SysML v2 用不同的方式描述许多相同的事物。转换在两个方向上都使用以下对应关系:

LMLSysML v2
Asset部件定义,在每处使用它的地方都有一个部件用法
Asset 的分解(decomposed by)父级定义中的部件用法
Port端口用法
Asset 的 Characteristic属性用法
Conduit连接用法;两端都是端口时为接口用法
Input/Output项定义,带 in 和 out 项参数及流
Requirement(Number、Name、Description)需求用法(短名称、名称、doc)
satisfied bysatisfy
Test Case带 verify 目标的验证用法
Test Suite验证用例的包
Action 及其流带后继关系的动作用法
SYNC 和并行块分叉和汇合
OR决策和合并
LOOP循环动作
performed byperform
状态特征和转换带转换的状态定义,由部件展示(exhibit)
Equation 及其变量带参数的约束定义

Holarch 数据随之复制

有些数据在两种语言中都没有对应位置。它们是 Holarch 数据,会连同其关联一起复制:

  • 风险、决策、任务、成本、进度计划、问题、文档和白板都会被复制,并与转换后的元素保持关联。
  • 需求状态和验证方法随每项需求保留;测试结果随每个测试用例保留。类工作流的自定义状态也会保留。
  • 架构更改在两个方向上都会带过去,包括类工作流及其状态、已退役状态、转换和审批人。
  • 讨论评论跟随其元素。
  • 决策的分支概率随其分支保留,供仿真器使用。
  • 从 SysML v2 副本创建的 LML 副本会取回第一次转换所保留的 LML 属性和标签。

不转换的内容

  • 图布局。视图和图会在副本中重新绘制。
  • 历史记录、基线和变更请求。副本在没有它们的情况下开始。
  • 一种语言中没有对应位置的元素,例如 LML 的 Measure 和 Resource,或 SysML v2 的枚举、计算和分析用例。

报告会列出每个此类项并给出原因。请参阅报告参考。

如何使用

何时使用及原因

当项目的语言不再适合工作时,请进行转换:

  • LML 到 SysML v2:您的团队或客户现在使用 SysML v2,或模型必须与 SysML v2 工具交换。转换后,导出 .sysml 或 JSON(请参阅交换 SysML v2 模型)。
  • SysML v2 到 LML:您需要 SysML v2 项目没有的 LML 页面或图,或者您希望以 Holarch 的生命周期形式呈现模型以供评审。

在模型稳定后再转换,并在依赖副本之前阅读报告。

创建转换后的副本

  1. 在管理项目中,点击项目所在行上的 ⋯。
  2. 选择创建 SysML v2 副本…(适用于 LML 项目)或创建 LML 副本…(适用于 SysML v2 项目)。

    Holarch 会检查转换;在大型项目中,窗口底部的进度条显示“正在检查转换…”。然后会打开带有报告的对话框。

  3. 阅读报告:
    • 已转换列出每种项、其数量以及它会变成什么,例如“Requirements 24 个需求用法”。
    • 未转换列出每种不转换的项、其数量及原因。
  4. 如需在 Holarch 之外使用报告,请点击下载报告 (CSV),将报告保存为每项一行的形式。
  5. 输入新项目名称。默认为原始项目名称后接“(SysML v2)”或“(LML)”。
  6. 点击创建副本。

    提示消息显示“已创建‘<name>’”。副本会在其主页上打开。

  7. 在副本中打开文档转换报告。它按编号和名称列出每个未转换的项。

检查副本

  1. 在 SysML v2 副本中,打开模型 → 编辑器。

    模型是一个以项目命名的顶层包。它包含 Architecture、System、Items、Requirements、Verification、Behavior、Constraints 和 Views 这些包(仅限有内容的包)。

  2. 查看行号栏中的问题标记。如果转换后的文本有问题,对话框会在您创建副本之前说明:“转换后的文本有 N 个问题。副本会在其编辑器中显示这些问题。”
  3. 在视图中打开各视图(Architecture Overview、System Connections),查看重新绘制的结构。
  4. 在 LML 副本中,打开数据库和各个图,检查 Asset、Requirement 和动作流。

实例:将 Hybrid Car 演示转换为 LML 副本

先创建演示项目:在管理项目中,点击项目文件 ▾ → 新建演示项目 → Hybrid Car (SysML v2)。

  1. 在管理项目中,点击 Hybrid Car (SysML v2 demo) 上的 ⋯,然后选择创建 LML 副本…。副本将命名为“Hybrid Car (SysML v2 demo) (LML)”。
  2. 阅读报告。

    在已转换下:部件用法变为 Asset,端口用法变为 Port,属性变为 Characteristic,连接用法和接口用法变为 Conduit,需求用法和需求定义变为 Requirement,验证用法变为 Test Case,动作变为 Action,状态和转换变为其 LML 对应项。

    在未转换下,包括以下内容:

    • 特化:LML 没有特化;部件会复制其通用定义的特征。SportCar :> Car 就是一例。
    • 重定义:在每个复制的部件中,重定义特征会替换继承的特征。轿车的电池以 48 kg 复制。
    • 枚举(DriveMode、FuelKind):属性值以文本形式保留。
    • 计算(PowerToWeight、ElectricRange)和分析用例(PowerToWeightAnalysis)。
    • 绑定连接器(bind output = transmission.output;):LML 没有特征之间的绑定。
    • 属性值:以文本形式保留在每个 Characteristic 的 Value 中;单位和表达式不会求值。
    • 视图:图会在 LML 副本中重新绘制。
  3. 点击创建副本。

    LML 副本会打开。fleet.sedan 及其部件都是 Asset;需求 Sedan Mass(VR-1.1)是一个由轿车的 Asset 满足的 Requirement。演示中的风险、决策和任务也会被复制,并与转换后的元素关联。

要尝试另一个方向,请创建 CubeSat EO-1 演示(一个 LML 项目),并在其上选择创建 SysML v2 副本…。

提示和良好做法

  • 转换前整理 LML 项目:将每个 Conduit 恰好连接到两个 Asset 或 Port,将每个 Characteristic 附加到一个 Asset 或 Equation,并移除空的 Test Suite。否则它们会被报告为未转换。
  • 在 LML 中,如果希望 OR 分支标签变为守卫,请将其写成基于模型值的布尔表达式(例如 speed > 3)。其他标签会变为后继关系上的文档注释。
  • 在 SysML v2 中,为参与者指定部件定义类型,为项参数指定项定义类型。未类型化的不会转换。
  • 保留原始项目。在较大的更改之后,从原始项目重新转换,而不是并行编辑两个项目。

常见错误

  • 以为原始项目会更改。它不会更改。副本是一个独立的项目。
  • 以为图会保留其布局。布局不会被转换;请重新排列新的视图或图。
  • LML 副本中缺少部件。没有任何部件使用的部件定义在 LML 中没有对应的 Asset,因为 LML 只有实例。请在某个部件中使用该定义,然后再次转换。
  • 报告中出现“无法解析”项。SysML v2 文本中的某个名称没有指向任何内容。在编辑器中修正该名称,然后再次转换。

报告参考

LML 到 SysML v2

已转换的项包括 Asset(部件定义及其部件用法)、Characteristic(属性)、Port、Conduit(连接或接口)、Input/Output(项定义)、Requirement、Action 和用例、动作之间的项流、State、Transition、Equation(约束定义)、Performs、Test Suite、Test Case、Verifies、Satisfies,以及 Holarch 条目(连同其关联一起复制):工件、陈述、任务、风险、进度条目、成本、问题、决策、危险源和失效模式。类工作流(项目的架构更改)会连同其自定义状态、转换和审批人一起带过去,因此需求和测试用例会保留其自定义 Status 值。副本保留项目的正式项目群和安全性与可靠性开关。

未转换原因
处于分解循环中的 Asset包含自身的 Asset 在部件树中没有位置。其部件定义会被转换;但它不会被用作部件。
端点不恰好为两个的 ConduitSysML 连接连接两个端点。将该 Conduit 连接到两个 Asset 或 Port,然后再次转换。
Conduit 传输的项此转换中的连接不携带项。这些项会转换为项定义以及动作之间的流。
分解为其他 Conduit 的 Conduit此处 SysML 连接不嵌套;每个 Conduit 都变为自己的连接。
循环次数和循环脚本此处的 SysML 循环会一直重复,直到满足某个条件;次数作为 Holarch 数据保留,并由“创建 LML 副本”恢复。
决策分支标签和概率当决策的每个标签都是基于模型值的布尔表达式时,这些标签会成为其守卫;否则会成为后继关系上的文档注释。概率作为 Holarch 数据保留供仿真器使用,两者都由“创建 LML 副本”恢复。
OR、SYNC 和 LOOP 条目这些结构会转换为决策/合并、分叉/汇合和循环节点;为它们命名的条目不保留。
状态的进入、执行和退出动作这些动作会转换为动作;此转换不会填充 SysML 状态主体。
并非连接同一状态机两个状态的转换SysML 转换连接同一状态定义中的两个状态。
转换守卫和触发器它们在 LML 中以自由文本编写;它们作为 Holarch 数据而不是 SysML 表达式保留,并由“创建 LML 副本”恢复。
未由 Asset 指定的状态状态需要有其所描述行为的 Asset。
Equation 表达式这些表达式使用的名称不是 SysML 特征;每个表达式都作为注释保留在其约束定义中。
没有测试用例的 Test SuiteTest Suite 会变为其验证用例的包;空的 Test Suite 没有可容纳的内容。
验证需求以外内容的测试用例SysML 验证用例只验证需求。
测试周期记录在 Test Suite 上的测试运行不属于模型;保留每个用例的最新结果。
由其他种类条目满足的需求例如,在 SysML 中一项需求不满足另一项需求;请在文本中使用派生。
其他关系此转换没有对应的 SysML 关系;报告会列出每一个。
Measure效能度量在此转换中没有 SysML 元素。
Resource资源数量(消耗、产生)属于 LML 仿真器,在此处没有 SysML 元素。
未附加到 Asset 或 Equation 的 Characteristic属性需要所有者:由某个 Asset 指定它,或将其设为方程变量。
其他类的条目该类在 SysML v2 项目中没有 SysML 元素,也没有 Holarch 位置。
特性和配置尚不支持:产品线的特性和配置不会变为 SysML v2 的变化点、变体和配置。报告将它们列为 Feature 条目和 Configuration 条目;请在副本中重新对变体建模(请参阅SysML v2 变体和配置)。
基线LML 项目的基线不适用于新模型;副本在没有基线的情况下开始。
历史记录变更历史记录在副本中重新开始。
变更请求LML 变更请求提议对 LML 条目进行更改,而副本中没有这些条目。
图布局图会重新绘制为 SysML v2 视图;位置不会带过去。
文档大纲中已转换的条目文档会被复制;其大纲中的需求和其他模型条目现在是 SysML 元素,出现在模型中,而不在大纲中。

SysML v2 到 LML

每个部件用法都会变为一个 Asset,并复制其定义(以及它所特化的定义)的部件、端口和属性。重定义会替换其所重定义的内容。连接和接口变为这些 Asset 之间的 Conduit。需求、验证用例、satisfy、verify、perform、项参数、状态和转换按上表反向映射。后继关系变为动作流;决策的守卫(或其后继关系上的文档注释)变为 OR 分支标签,并附带其概率。项目的架构更改会带过去,包括类工作流及其自定义状态、转换和审批人,因此需求和测试用例会保留其自定义 Status 值。

未转换原因
端点无法解析的连接在文本中修正端点的名称,然后再次转换。
位于无部件使用的定义内部的连接每个连接都会在拥有它的每个部件的各部件之间变为一个 Conduit;没有任何内容使用此定义。
绑定连接器LML 没有特征之间的绑定(相等)。
无法解析的 verify 关系修正验证目标中的需求名称,然后再次转换。
没有项定义的项参数用 item def 为该参数指定类型,以便转换。
模型中没有部件定义的参与者用 part def 为该参与者指定类型,以便转换。
无法解析为某个动作和某个部件的 perform 用法从部件定义或部件用法执行(perform)动作,然后再次转换。
无法解析的 satisfy 关系修正 satisfy 语句中的名称,然后再次转换。
不是结构化流的后继关系LML 动作流是带有并行、决策和循环块的序列;其他后继关系图会被线性化。
无部件展示的状态定义这些状态在转换时没有其所描述行为的 Asset。
无法解析为两个状态的转换修正状态名称,然后再次转换。
转换触发器(accept)LML 转换仅将触发器保留为自由文本;所接受的信号不会被关联。
端口、接口和连接定义在部件使用它们的地方,它们会转换为 Port 和 Conduit;LML 没有端口、接口或连接类型。
属性定义(值类型)LML 特征没有类型。
枚举和枚举值LML 没有枚举;属性值以文本形式保留。
计算、分析用例、关注点LML 没有计算、分析用例或干系人关注点。
视图和视点图会在 LML 副本中重新绘制。
赋值、if、send 和 accept 动作LML 动作没有语句。
依赖LML 没有通用依赖。
分配对于由部件执行的动作,请在文本中使用 perform。
元数据LML 没有元数据。
事件发生(occurrence)LML 没有事件发生(occurrence)。
被包含的用例用例之间的包含关系不会被转换。
别名每个 LML 实体只有一个名称。
引用用法(计算和用例的参数)除方程变量外,LML 没有参数。
特化LML 没有特化;部件会复制其通用定义的特征。
重定义在每个复制的部件中,重定义特征会替换继承的特征。
子集化LML 没有子集化。
导入LML 没有命名空间;每个实体在项目中都可见。
区别于用法的定义LML 只有实例:部件定义会变为使用它的部件的 Asset,其文本会写入这些 Asset 的描述中。
部件以外的多重性只有部件的多重性在 LML 中有位置(decomposed by 的 Multiplicity)。
属性值值以文本形式保留在每个特征的 Value 中;单位和表达式不会求值。
基线SysML v2 项目的基线不适用于 LML 副本;副本在没有基线的情况下开始。
历史记录变更历史记录在副本中重新开始。
变更请求SysML 变更请求提议的文本更改不适用于 LML 实体。

报告 CSV

下载报告 (CSV)会为每种已转换的项写一行,并为每个未转换的项写一行。其列为结果(已转换或未转换)、内容、计数、变为或原因、编号和名称。

消息

留言含义和解决方法
正在检查转换…(进度条)正在准备报告。
这已经是一个 SysML v2 项目。请改为选择“创建 LML 副本…”。选择了错误的方向。
这已经是一个 LML 项目。请改为选择“创建 SysML v2 副本…”。选择了错误的方向。
转换后的文本有 N 个问题。副本会在其编辑器中显示这些问题。可以创建副本;请在其编辑器中修正这些问题。
转换后的文本无法解析(…)。项目未复制;请连同项目文件一起报告此问题。转换失败。请携带项目文件联系支持人员。
SysML 检查器未启动。请重新加载页面并重试。重新加载并重试。
无法读取项目。请重新加载页面并重试。重新加载并重试。
未创建副本:… 请重新加载页面并重试。重新加载并重试。
已创建“<name>”副本已创建并打开。

限制

  • 图布局、历史记录、基线和变更请求不会被转换。
  • 尚不支持:将 LML 产品线(特性和配置)转换为 SysML v2 变体。
  • 报告文档中每种项最多列出 500 个。

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