Holarch

SysML v2

文本编辑器和浏览器

在编辑器中编写和检查 SysML v2 文本,在浏览器中浏览模型树,使文本和视图保持同步,并从回收站恢复已删除的元素。

使用方法 →

本页内容
  1. 概述
  2. 概念
    1. 文本文档
    2. 将文本应用到模型
    3. 错误和草稿
  3. 如何使用
    1. 打开包的文本
    2. 编辑并应用文本
    3. 插入构造
    4. 补全名称和关键字
    5. 转到定义并重命名
    6. 查找和替换
    7. 修正错误
    8. 浏览模型树
    9. 删除和恢复元素
  4. 实例:为 Hybrid Car 添加车轮传感器
  5. 提示和常见错误
  6. 编辑器
    1. 布局
    2. 插入 ▾ 构造
    3. 键盘快捷键
  7. 文本和视图保持同步
  8. 与他人协作
  9. 浏览器
    1. 页面标题和筛选器
    2. 行
    3. 属性面板
    4. 行菜单
    5. 键盘
    6. 不被解释的元素
    7. 错位元素
  10. 已删除的元素
  11. 无障碍
  12. 消息
  13. 限制
    1. 检查器已暂停
  14. 相关页面

概述

编辑器(模型 → 编辑器)以文本形式编辑 SysML v2 模型。浏览器(模型 → 浏览器)将同一模型显示为由包及其成员组成的树。

两者处理的是同一个模型。您键入的文本在能够解析时即应用到模型。在其他任何地方(例如视图、表格或属性面板)所做的更改会立即出现在文本中。应用中各处的在文本中显示和打开文本按钮会在某个元素处打开编辑器。

概念

文本文档

编辑器为每个顶层包显示一个文本文档。左侧的包列表用于在它们之间切换。不在任何包中的顶层元素共用一个额外的文档:包外。

项目不保存文件:文档是从模型输出的。要获取 .sysml 文件,请导出模型(请参阅交换 SysML v2 模型)。

将文本应用到模型

键入起初只改变文本。文本在提交点应用到模型:

  • 当您停止键入片刻时(约 0.6 秒);
  • 当您离开编辑器时;
  • 当您按 ⌘S / Ctrl+S 或 ⌘↩ / Ctrl+Enter 时。

每次提交都可通过一次撤销撤回。Holarch 会将文本与模型进行比较,只更改不同之处,因此元素会保持其身份。重命名的元素仍是同一个元素:其视图位置、评论、追溯和关联都会随之保留。

错误和草稿

有错误的文本不会丢失。能够解析的成员会被应用;有错误的成员不会被应用,并在模型中保持其上一个正确状态。状态行显示未应用:请修正第 N 行。

尚未应用的文本会作为草稿保留在此浏览器中,直到它能够解析。再次打开该包时,横幅会显示此文本有来自 <date> 的更改尚未应用到模型。修正文本即可应用,或点击放弃草稿回到模型的文本。

草稿只保存在您键入它们的浏览器中。其他人看到的是模型的上一个正确状态。

如何使用

打开包的文本

  1. 打开模型 → 编辑器。第一个包会打开。如果模型中没有包,请点击+ 新建包。
  2. 点击包列表中的某个包即可打开其文本。
  3. 要跳转到某个元素,请使用浏览器、属性面板或视图中的在文本中显示。编辑器会打开其所在的包并选中其声明。

编辑并应用文本

  1. 像在任何代码编辑器中一样键入。Enter 会保留缩进,并在 { 之后增加缩进;键入 } 会使其与对应的起始行对齐。
  2. 停止键入。文本下方的状态行依次显示尚未应用、正在应用…和已应用。浏览器、视图和页面现在都会显示该更改。
  3. 按 ⌘Z / Ctrl+Z 撤销键入。当编辑器中没有可撤销的键入时,⌘Z / Ctrl+Z 会撤销项目的上一次更改,与 Holarch 中其他任何地方一样。

只重新排版文本的更改会显示无模型更改。

插入构造

插入 ▾ 会为您写入 SysML 构造,例如带有类型和多重性的部件。

  1. 将光标放在主体中该构造所属位置的空行上。
  2. 点击页面标题中的插入 ▾,或按 ⌃⇧Space / Ctrl+Shift+Space。列表只显示适合光标位置的构造,分为四组:结构、行为、需求和其他。其标题会说明您所在的位置,例如包级别或部件定义内部。
  3. 键入以筛选列表。预览会显示文本及其含义。
  4. 按 Enter(或点击)将其插入到单独的一行中。
  5. 在所选字段(名称、类型或多重性)上直接键入覆盖,然后按 Tab 转到下一个字段。⇧Tab / Shift+Tab 返回上一个字段。类型字段会列出模型中的定义:按 Enter(或用 ↑ ↓ 选取)采用其中一个;Tab 保留您键入的内容。
  6. 在最后一个字段之后按 Tab,或按 Esc,即可离开代码片段。该构造会应用到模型。

自动补全也提供相同的代码片段:键入 par 会提供关键字 part 和部件代码片段。

补全名称和关键字

  1. 键入名称或关键字的两个字母,或在名称后键入 :: 或 .。也可以按 ⌃Space / Ctrl+Space。列表会提供适合光标位置的关键字、名称和代码片段。
  2. 用 ↑ 和 ↓ 移动(PageUp 和 PageDown 一次跳 8 行)。
  3. 按 Enter 或 Tab 接受,或按 Esc 关闭列表。在键入时打开的列表,在 4 秒内没有按键、名称已完整、没有匹配项,或您将光标移开或离开编辑器时,也会关闭。

转到定义并重命名

  1. 将指针指向某个名称,即可看到一张卡片,显示其种类、限定名和文档,以及其上的任何问题。⌘I / Ctrl+I 可通过键盘显示同一张卡片。当您编辑、按 Esc、滚动、离开编辑器或移开指针时,卡片会关闭,并且它从不遮挡补全列表。
  2. 按住 ⌘ / Ctrl 点击某个名称,或按 F12,即可转到其声明。位于另一个包中的声明会打开该包。
  3. 要重命名,请将光标放在已声明的名称上并按 F2。输入新名称并确认。所有包中对它的每个引用都会更改,一次撤销即可全部撤回。提示消息显示已重命名为“name”。

查找和替换

  1. 按 ⌘F / Ctrl+F,或点击页面标题中的查找。
  2. 键入要查找的文本。栏中显示 第 n 个,共 m 个匹配项。
  3. 根据需要开启 Aa(区分大小写)、W(全字匹配)或 .*(正则表达式)。
  4. 按 Enter 或 ⌘G / Ctrl+G 转到下一个匹配项,按 ⇧Enter / Shift+Enter 或 ⇧⌘G / Ctrl+Shift+G 转到上一个匹配项。
  5. 点击替换…,键入替换文本,然后点击替换(当前匹配项)或全部替换。
  6. 按 Esc 或点击 ✕ 关闭该栏。

修正错误

  1. 查看状态行:它会统计问题数量,例如 2 个错误,1 个警告,或显示无问题。
  2. 按 F8 转到下一个问题(⇧F8 / Shift+F8:上一个问题),或点击边栏中的标记。该问题会被选中并显示其消息:先说明问题,再给出修正方法。
  3. 修正文本。当该成员能够解析时,它就会被应用。

浏览模型树

  1. 打开模型 → 浏览器。
  2. 点击包旁边的 ▸ 将其展开,或点击全部展开。
  3. 在按名称筛选中键入内容,或在所有类型中选择一种类型,例如 part def。树会显示匹配项及其所有者。计数显示 n / N 个元素。
  4. 选择一个元素,即可在属性面板中查看其详细信息。
  5. 双击它,或按 Enter,即可在编辑器中显示它。

删除和恢复元素

  1. 在浏览器中打开行菜单(⋯、右键单击或 Shift+F10),然后选择删除…并确认。该元素及其成员会移到项目的回收站。在编辑器中删除其文本具有相同的效果。
  2. 要将其恢复,请打开导航栏底部的回收站工具,然后点击其所在行上的恢复。它会以相同的身份恢复,因此对它的引用会再次解析。

实例:为 Hybrid Car 添加车轮传感器

本示例使用 Hybrid Car (SysML v2) 演示。

  1. 打开模型 → 编辑器,然后点击包列表中的 Vehicles。
  2. 找到 part def Wheel :> Component。将光标放在其主体内 port hub : ~TorquePort; 之后新的空行上。
  3. 按 ⌃⇧Space / Ctrl+Shift+Space。标题显示部件定义内部。键入 att 并按 Enter 插入属性。
  4. 在名称字段上键入 speedSensorMass,按 Tab,在类型字段上键入 MassValue,再按一次 Tab 离开代码片段。该行为 attribute speedSensorMass : MassValue;,并已应用。
  5. 在 ; 之前键入 = 0.2 [kg] 并停止键入。状态行显示已应用。
  6. 打开模型 → 浏览器,在按名称筛选中键入 speedSensor。该属性显示在 Vehicles › Wheel 下;其属性面板显示所有者 Wheel 和类型 MassValue。
  7. 回到编辑器,在 speedSensorMass 上按 F2,输入 sensorMass 并确认。浏览器会显示新名称。
  8. 删除该行并停止键入。该属性会移到回收站;可在那里用恢复将其恢复。

提示和常见错误

  • 保存是自动的。⌘S / Ctrl+S 只会立即应用文本;没有其他需要保存的内容。
  • 一个错误不会阻塞其余部分。出错成员之前和之后的成员仍会被应用。
  • 与协作者同时编辑。如果模型在您键入时发生了变化,Holarch 会将您的文本与新模型合并。当双方更改了同一个成员时,请选择保留我的或采用对方的。
  • 通过重新键入来重命名。就地更改名称也会保留该元素(Holarch 按位置和种类进行匹配),但其他地方的引用仍使用旧名称,不再能够解析。请使用 F2 进行全局重命名。
  • 删除被使用的元素。当删除的文本移除了其他元素或视图正在使用的元素时,Holarch 会先询问。取消即可保留它;此后文本保持未应用状态,直到您按 ⌘S / Ctrl+S 重新决定。
  • 达到条目上限时。当文本添加的元素会使项目超出其方案的条目上限时,该更改中的任何内容都不会被应用。文本保持为草稿,状态行显示未应用:项目将超出其 1,000 个条目的上限。请移除新的声明或删除未使用的条目。在 SysML v2 项目中,条目是除关系以外的模型元素:包、定义和用法(部件、属性、引用、端口、动作、状态、需求……)计入;关系不计入(导入和暴露、连接、接口、流、绑定、后继、转换、分配、满足和验证、依赖、子分类、类型定义、取子集、重定义)。Hybrid Car 演示有 549 个条目,Earth Observation Satellite 演示有 1,549 个,因此在 Free 方案上,新建演示项目会禁用 Earth Observation Satellite 项,并显示“需要 Individual 方案(1,549 个条目)”。请参阅方案和限制。

编辑器

布局

  • 包(左侧):每个顶层包一个条目,需要时再加上包外。打开的包后面的数字表示其错误数。在共享项目中,姓名首字母显示还有谁打开了某个包。
  • 页面标题:+ 新建包、插入 ▾和查找。
  • 文本区域:语法高亮、行号以及带有问题标记的边栏。点击行号可选中该行;点击标记可选中问题并显示其消息。
  • 状态行(文本下方):光标位置(Ln 12, Col 5)、问题数量和应用状态。

查看者看到的文本是只读的。

插入 ▾ 构造

组构造
结构包、部件定义、部件、属性、属性定义、端口定义、端口、接口、连接、分配定义、分配、项、枚举、变化、变体、配置、变体选择
行为动作定义、动作、后继、状态定义、状态、转换、流、then 动作、执行、分叉、决策、汇合、合并、接受、发送、赋值、如果、While 循环、for 循环、状态动作、初始状态、accept 转换、并行状态定义、展现状态、消息
需求需求定义、需求、TBD 值、TBR 值、验证定义、满足、验证、约束、计算、主体、参与者、干系人、假设、用例、分析案例、关注点、视点、视图
其他导入、别名、注释、文档

每种构造只在有效的位置提供。TBD 值和 TBR 值需要在包中写有 private import HolarchMetadata::*;(请参阅将值标记为 TBD 或 TBR)。变体只在变化内部提供,变化中只包含其变体。配置会写入一个标记为 @HolarchConfiguration 的用法,并需要 private import HolarchVariability::*;;在配置内部,变体选择为一个变化点选取变体(请参阅变化、变体和配置)。

键盘快捷键

在 Windows 和 Linux 上,用 Ctrl 代替 ⌘。 / Ctrl+.

按键Action
⌘S / Ctrl+S 或 ⌘↩ / Ctrl+Enter立即应用文本
⌘Z / Ctrl+Z / ⇧⌘Z / Ctrl+Shift+Z撤销 / 重做(在 Windows 和 Linux 上 Ctrl+Y 也可重做)
⌃Space / Ctrl+Space在光标处补全
⌃⇧Space / Ctrl+Shift+Space打开插入 ▾
Tab / ⇧Tab / Shift+Tab增加缩进 / 减少缩进;在代码片段中为下一个 / 上一个字段
Esc,然后 Tab离开编辑器(否则 Tab 会缩进)
⌘/ / Ctrl+/用 // 注释或取消注释所选行
⌘F / Ctrl+F查找;⌥⌘F / Ctrl+Alt+F 打开带替换功能的查找
⌘G / Ctrl+G 或 F3 / ⇧⌘G / Ctrl+Shift+G下一个 / 上一个匹配项
F8 / ⇧F8 / Shift+F8下一个 / 上一个问题
F12 或按住 ⌘ / Ctrl 点击转到声明
F2全局重命名光标处的名称
⌘I / Ctrl+I显示光标处的信息卡片

文本和视图保持同步

文本、视图、表格和属性面板都是编辑同一个模型的方式。

  • 文本到模型。文本在每个提交点应用,一次撤销即可全部撤回。视图、表格和页面会立即更新。
  • 模型到文本。在视图、浏览器、表格、属性面板、变更请求中所做的更改或一次撤销会立即写入文本。如果您在同一个包中有未应用的文本,Holarch 会将其与该更改合并;请参阅与他人协作。
  • 每项更改都会先经过检查。视图中的编辑会先写成 SysML 文本并经过检查,然后才会应用。如果它无法写成有效的文本,就会被拒绝:该更改无法写成 SysML 文本:…。例如,在动作流视图中,不是有效表达式的守卫会被拒绝。
  • 您的格式保持不变。您未更改的元素会保留其原样文本,包括注释、空行和关键字写法(例如 subsets 与 :>)。元素中被更改的部分或新元素会以标准布局写入,缩进与相邻内容一致。
  • 布局保持不变。视图位置按元素身份存储。在文本中编辑或重命名元素会保留其在每个视图中的位置。

Holarch 数据(状态、结果、标签、布局、仿真器设置)从不写入文本。请参阅模型数据和 Holarch 数据。

与他人协作

在共享项目中,多个人可以同时编辑模型。

  • 包列表会显示打开了某个包文本的其他人的姓名首字母。将指针指向它们即可查看姓名。
  • 当模型在您键入时发生变化,Holarch 会逐个成员地将您未应用的文本与该更改合并。顺利合并时,您可以继续键入。
  • 当您和其他人更改了同一个成员时,横幅会显示<Package> 在您键入时已更改。点击保留我的可用您的文本覆盖对方的更改,点击采用对方的可用模型的文本替换您的文本。
  • 如果有人删除或移动了您打开的包,横幅会显示此包已被删除或移动。在您离开页面之前,其文本会保留在这里。

浏览器

浏览器将模型显示为树:先是顶层包,然后按顺序列出其成员。

页面标题和筛选器

  • 全部展开和全部折叠会展开或折叠每个元素。浏览器会在此浏览器中记住哪些元素处于展开状态。
  • 按名称筛选匹配名称和短名称。
  • 所有类型将树限制为一种类型,例如 part def、requirement 或 port。只列出模型中存在的类型。Individuals(模型中有个体时列出)显示所有声明为 individual 的元素,不论类型。
  • 使用筛选器时,树会显示匹配项及其所有者,并全部展开。计数显示 n / N 个元素。

行

每一行显示元素的种类、名称以及尖括号中的短名称(<VR-1.1>)。没有名称的元素显示为(未命名的种类),例如(未命名的 succession),但以下情况除外:

  • 仅用用户关键字声明的元素只显示该关键字作为其种类,例如 #fault def BatteryOverheat; 显示为 #fault def。
  • 转换的触发器和效果是该转换的成员。它们显示为 trigger 和 effect,并以其文本命名,例如 trigger StartRequest。
  • 未命名的 terminate 动作显示为 terminate;当它指明所终止的对象时,显示为 terminate drive。
  • 个体、快照和时间片会在图标之后显示其关键字和种类,例如 individual part def、snapshot 或 timeslice part:个体为一个圆环,快照为时间线上的一个点,时间片为时间线上的一段横条。

属性面板

选择一个元素即可在属性面板中查看它,该面板与数据库页面上的元素面板相同。其分组如下:

  • 定义(需求则为 Requirement):短名称、名称、文档说明和标签。
  • 工作流:需求的评审条、负责人、截止日期和关注。
  • 特性:类型或特化、多重性、值、定义或其用法,以及事件:一个 Individual 复选框,对于用法还有整个生命周期、时间片或快照。属性、枚举和普通引用不是事件,因此这些控件处于关闭状态。
  • 连接(连接的端名称和多重性)、转换(转换的触发器、守卫和效果)以及终止(terminate 动作所终止的对象),在适用时显示。
  • 表示形式:元素的文本表示,每个表示由一种语言(例如 Python)及其正文组成,并带有添加表示和移除。检查器对 SysML 和 KerML 正文的发现项显示在其下方。
  • 仿真(适用时)、追溯、讨论和详细信息(种类、限定名、所有者、历史记录)。

编辑会写入模型,每次编辑都可通过一次撤销撤回。请参阅 Holarch 功能。

行菜单

通过行上的 ⋯、右键单击、Shift+F10、上下文菜单键或 F2 打开它。

项作用
打开条目视图在单独的页面上打开该元素,就像 LML 条目的条目视图一样
在文本中显示在编辑器中打开该元素所在的包并选中其声明
在 Spider 图中显示打开以该元素为中心的 Spider 图(适用时)
导出为 .sysml、导出为 JSON对于包:将其下载为 SysML 文本或 SysML v2 JSON
新建快照…、新建时间片…对于事件定义或用法:询问名称,并添加一个快照或时间片作为其最后一个成员
重命名…重命名该元素;引用随之更新
删除…确认后,将该元素及其成员删除到项目的回收站

键盘

按键Action
↑ / ↓上一行 / 下一行
Home / End第一行 / 最后一行
→打开该元素,或转到其第一个成员
←关闭该元素,或转到其所有者
Enter在文本中显示
F2, Shift+F10打开行菜单

不被解释的元素

Holarch 不解释的种类的元素(保留自 SysML v2 JSON 导入)会在浏览器中显示其原始种类(例如 behavior)和一个未解释标签。它们没有文本:编辑器会略去它们及其成员,并在文本上方说明数量;它们的行菜单中没有在文本中显示或重命名…。其属性面板显示种类、文件中的 ID 以及其关系所指向的对象。请参阅 Holarch 不解释的元素。

错位元素

所有者缺失的元素(例如协作者在同一时刻删除了其所在的包之后)会列在 Misplaced (owner missing): move them into a package(位置错误(所有者缺失):将其移入某个包)下。主页也会显示一张位置错误的元素卡片。在编辑器中打开该元素,并将其文本移入一个包中。

已删除的元素

在 SysML v2 项目中删除元素会将其移到项目的回收站。它会一并带走其拥有的所有内容、指明它的连接和 satisfy 关系、其视图布局以及其评论。

  • 打开导航栏底部的回收站工具。每一行显示元素的种类、名称、删除时间、原因(Deleted with 3 members)以及保留时长。
  • 恢复会以相同的标识恢复该元素,因此对它的引用会重新解析。全部恢复会恢复所有条目。
  • ⋯ → 预览会显示其种类、短名称、文档说明、成员,以及仍引用它的元素(Referenced by)。
  • ⋯ → 永久删除…会立即移除一个条目。清空回收站会移除所有条目。两者都可以用 ⌘Z / Ctrl+Z 撤销。
  • 条目会在 30 天后自动移除。

当删除文本会移除一个仍在使用的元素时,编辑器会先询问:<n> references and <m> views use <name>. Delete it?(<n> 个引用和 <m> 个视图使用了 <name>。是否删除?)

无障碍

编辑器和浏览器可以仅用键盘操作,也可以配合屏幕阅读器使用。

  • 编辑器是一个带标签的文本框。Tab 用于缩进;要离开编辑器,请按 Esc,然后按 Tab。
  • F8 和 Shift+F8 移到下一个和上一个问题,并连同其所在行一起朗读。问题发生变化后约一秒也会播报。
  • F12 转到定义,F2 重命名,⌘F / Ctrl+F 查找,Ctrl+Space 自动补全,Ctrl+Shift+Space 打开插入。自动补全和插入都是会播报所选条目的列表。在代码片段中,每个字段都会被播报(“Field 1 of 3: name”)。
  • 浏览器是一棵树。每一行按其自身的名称和种类朗读,例如“Car, part definition”。方向键用于在树中移动;→ 展开包,← 将其折叠。Shift+F10 打开行菜单。

消息

留言含义和解决方法
尚未应用您正在输入;暂停时文本即会应用。
已应用 / 无模型更改文本已在模型中 / 文本已与模型一致。
未应用:请修正第 N 行。某个成员有错误。修复第 N 行;其余文本已应用。
未应用:您输入时模型已更改。请选择“保留我的”或“采用对方的”。您的文本与另一项更改涉及同一个成员。
未应用:已取消删除 <name>。按 ⌘S / Ctrl+S 重新决定。您拒绝了一次删除。请恢复文本,或按 ⌘S / Ctrl+S 并确认。
SysML 检查器已停止。您的文本已保留;检查器已重新启动。检查器已重新启动。继续输入即可;您的文本是安全的。
检查已暂停:SysML 检查器已停止两次。您的文本已保留。在通知中选择“重试”,或重新加载页面。检查器连续停止了两次(通常是因为模型过大),现已暂停。在通知中选择重试,或重新加载页面。请参阅检查器已暂停。
将光标放在名称上即可重命名。在关键字或空白处按下了 F2。
重命名前请修复此文本中的错误。重命名需要可解析的文本。
库元素无法重命名。请重命名您自己的元素。该名称属于标准库。
该声明位于库或其他文件中,无法在此处打开。转到定义找到的是标准库元素。请在标准库页面上查找它。
未找到“name”的声明。该名称无法解析。请检查其拼写或导入。
<Snippet> 不适用于此处。请将光标移到允许它的正文中的空行上。该构造在光标位置无效。
注释或字符串内不适用任何代码片段。请将光标移出。在注释或字符串内打开了“插入 ▾”。
此模式不是有效的正则表达式。请修正它,或关闭 .*开启 .* 时,查找模式无效。
此模型尚无包。请创建一个包以开始编写 SysML。点击+ 新建包。
没有匹配的元素。请更改筛选条件。浏览器筛选未匹配到任何内容。
未恢复:该元素已在模型中。具有该标识的元素已存在。
仅查看:请向所有者申请编辑权限。您拥有查看权限;文本为只读。

检查器关于 SysML 文本本身的消息列在 SysML v2 文本表示法中。

限制

  • 每个顶层包对应一个文本文档;项目内没有文件。
  • 大于 8 MB 的文档、长于 64 KB 的行或嵌套深度超过 256 层的内容不会被检查。
  • 跨越超过 512 层嵌套导入或特化的名称(包 P2 导入 P1,后者又导入 P0,依此类推)只会被部分检查;问题列表会指出位置。请缩短该链。
  • 草稿只保存在您输入它们的浏览器中。
  • 查找最多显示 10,000 个匹配项(10,000+)。
  • 已删除的元素在回收站中保留 30 天。
  • SysML 检查器在您的浏览器中运行。在 Safari 中,它可容纳最多约 750,000 行 SysML 文本的模型。

检查器已暂停

您在带有重试的通知中看到 This model is too large for the SysML checker in this browser. Editing and diagrams still work; checks are paused.(此模型对此浏览器中的 SysML 检查器来说过大。编辑和图仍可使用;检查已暂停。)(或 The SysML checker stopped twice on this model…)。

  • 原因:检查器在此模型上连续停止了两次,最常见的原因是模型超出了它能容纳的大小。它会暂停,而不是再次重新启动。
  • 解决方法:继续工作:编辑器之外的页面、图和编辑仍然可用。检查、名称查找以及应用编辑器文本会等到检查器再次运行。在通知中选择重试,或重新加载页面。如果它再次停止,请将模型拆分为多个项目,或发送附有项目大小的支持请求。

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