SysML v2
SysML v2 文本表示法
Holarch 所支持的 SysML v2 语言,附有 Hybrid Car 演示中的示例、它执行的检查以及只读的标准库。
本页内容
概述
SysML v2 将系统描述为一棵由命名元素组成的树,以文本形式编写。Holarch 支持 SysML v2 文本表示法,基于 OMG SysML v2 规范。您在编辑器中编写文本,Holarch 会在浏览器、视图、表格和生命周期页面中显示相同的元素。
本页通过 Hybrid Car (SysML v2) 演示中的示例讲解该表示法,然后列出 Holarch 所支持的内容、它对您的文本运行的检查以及标准库。
概念
元素、所有者和限定名
除顶层包外,每个元素都有一个所有者。元素的限定名是其各级所有者名称组成的链,用 :: 连接。在演示中,动力总成定义中的电池是 Vehicles::Powertrain::battery。
含空格或其他特殊字符的名称放在单引号中:'Fuel Tank'。尖括号中的短名称为元素提供第二个简短标识符:requirement def <'VR-1'> CurbMass。Holarch 将需求的短名称用作其编号。
包
包像文件夹一样对元素进行分组。包可以嵌套。每个顶层包在编辑器中是一个文档。
package Vehicles {
doc /* A hybrid passenger car: structure, interfaces and variants. */
private import ScalarValues::*;
private import ISQ::*;
private import SI::*;
}
导入和可见性
导入使另一个包的成员可以通过其短名称访问。
import ISQ::*;导入ISQ的成员。import VehicleRequirements::**;还会导入嵌套元素的成员(递归)。import Vehicles::Car;导入一个元素。import Vehicles::*[@SysML::PartDefinition];只导入某一类型的成员(筛选导入)。
private、protected 和 public 设置还有谁能看到某个成员或导入。演示中写的是 private import,这样导入就不会传递给再导入该包的其他包。
没有导入时,请写限定名:ISQ::MassValue 在任何地方都能解析,而 MassValue 只在导入了 ISQ 的地方才能解析。
alias 为元素提供第二个名称:alias Hybrid for Car;。
定义和用法
定义描述一类事物。用法是某个定义在另一个元素内部的一次使用。大多数关键字都有这两种形式:
| 定义 | 用法 | 含义 |
|---|---|---|
part def Battery; | part battery : Battery; | 系统、子系统或组件 |
attribute def TirePressure; | attribute mass : MassValue = 45 [kg]; | 值,通常带单位 |
item def Fuel; | item fuel : Fuel; | 流动或被处理的事物 |
port def FuelPort { … } | port fuelOut : FuelPort; | 部件上的连接点 |
connection def … / interface def FuelLine { … } | interface fuel : FuelLine connect …; | 部件或端口之间的链接 |
action def ProduceTorque { … } | action produce : ProduceTorque; | 行为:接收输入并给出输出的步骤 |
state def PowertrainStates { … } | state off; | 行为:状态及其转换 |
constraint def MassLimit { … } | constraint …; | 关于数值的布尔条件 |
calc def PowerToWeight { … } | calc …; | 带有 return 值的计算 |
requirement def <'VR-1'> CurbMass { … } | requirement <'VR-1.1'> sedanMass : CurbMass; | 需求 |
use case def DriveToWork { … } | use case commute : DriveToWork; | 用例 |
analysis def PowerToWeightAnalysis { … } | analysis sedanPowerToWeight : …; | 分析用例 |
verification def CurbMassTest { … } | verification sedanWeighing : CurbMassTest; | 验证用例 |
view def RequirementsView { … } | view driveCycleFlow : ActionFlowView { … } | 模型的视图 |
enum def DriveMode { … } | attribute mode : DriveMode; | 一组固定的值 |
嵌套在定义中的成员属于该定义的每个用法。part frontAxle : Axle; 拥有 Axle 的 differential、leftWheel 和 rightWheel,无需重复声明。
类型定义、特化和重定义
有四个运算符将定义和用法联系起来。每个运算符也都有关键字形式。
| 运算符 | 关键字 | 含义 | 示例 |
|---|---|---|---|
: | defined by | 用定义为用法指定类型 | part engine : Engine; |
定义上的 :> | specializes | 该定义是另一个定义的一种,并继承其成员 | part def FuelTank :> Component |
用法上的 :> | subsets | 该用法是另一个用法的子集 | part spareWheel :> wheels; |
:>> | redefines | 替换继承的用法,例如为其赋值 | attribute redefines mass = 18 [kg]; |
~ | 共轭端口:其 in 和 out 特征互换 | port fuelIn : ~FuelPort; |
重定义是变体或已配置部件改变其继承内容的方式。在演示中,SportCar 通过重定义去掉了备用车轮:
part def SportCar :> Car {
attribute topSpeed : SpeedValue = 210 [km/h];
part redefines spare [0];
}
abstract 标记没有直接实例的定义(abstract part def Component)。ref 标记不被拥有的引用。in、out 和 inout 设置特征或参数的方向。end 标记连接或接口定义的端。
多重性
方括号中的多重性表示有多少个。
[2]:恰好两个。part runabout : CityCar [2];[0..1]:可选。part spare : Wheel [0..1];[1..*]和[*]:一个或多个、任意数量。[0]:没有,用于移除继承的部件。- 边界可以是表达式。
ordered和nonunique写在方括号之后。
值和单位
= 绑定一个值。:= 给出可以改变的初始值。default 给出可由重定义替换的默认值。
attribute maxCurbMass : MassValue = 1650 [kg];
attribute minBatteryCapacity : EnergyValue = 1.2 [kW*h];
attribute minPowerToWeight = 40 [W/kg];
attribute topSpeed : SpeedValue = 210 [km/h];
量是一个数字加上方括号中的单位。单位可用 *、/ 和 ^ 组合([m/s^2])。MassValue 等量的种类来自 ISQ,kg 等单位来自 SI(或 USCustomaryUnits)。Holarch 会检查量纲:将 5 [s] 赋给 MassValue 是错误的。
表达式可使用算术运算、比较(<=、==)、逻辑运算符(and、or、not、implies)、条件表达式 if c ? a else b、特征链(car.powertrain.battery.capacity)、计算调用(PowerToWeight(power, mass))以及 ->sum、->size、->select 和 ->collect 等序列操作。Holarch 会带单位对它们求值,用于数值、约束、视图和分析页面。
结构:端口、连接、接口、绑定和流
部件通过其端口连接。
part def Powertrain {
part tank : FuelTank;
part engine : Engine;
interface fuel : FuelLine connect tank.fuelOut to engine.fuelIn;
connect controller.engineCtl to engine.ecu;
port output : TorquePort;
bind output = transmission.output;
}
connect a to b;连接两个部件或端口。- 接口是端口之间的有类型连接。其定义会命名它的端:
interface def FuelLine { end supply : FuelPort; end consumer : ~FuelPort; }。 - 连接或接口的每一端都可以有名称和多重性:
interface motorShaft : Shaft connect [1] driver ::> motor.output to [1] driven ::> transmission.motorIn;。命名端是连接的一个特征,因此motorShaft.driver引用的就是它。 bind a = b;表示两个特征相同(绑定连接器)。flow of Fuel from supply.fuel to produce.fuel;将一个项从一个特征传送到另一个特征。message以事件的形式在部件之间发送项。
行为:动作
动作定义包含其步骤(动作用法)、参数以及步骤的顺序。
action def DriveCycle {
in attribute targetSpeed : Real;
first start then switchOn;
action switchOn { attribute duration : DurationValue = 2 [s]; }
then fork split;
then supply;
then produce;
action supply : SupplyFuel;
action produce : ProduceTorque;
flow of Fuel from supply.fuel to produce.fuel;
first supply then ready;
first produce then ready;
join ready;
}
- 后继为步骤排序:
first a then b;,或紧跟在a之后的then b;。start和done分别是开始和结束。 - 控制节点:
fork和join用于并行路径;decide和merge用于备选路径。决策之后带守卫的后继写作if speed > 30 then cruise;,else brake;是默认分支。 - 终止:
terminate;立即结束外层动作及其仍在运行的所有步骤;then terminate;将其放在上一个步骤之后。terminate x;结束事件x。 - 其他动作:
accept等待一个信号,send发送一个信号,assign x := expr;更改一个值,if运行或跳过一个块,while … { … } until …;和for v in seq { … }重复执行一个块。 - 行为分配:部件通过
perform执行动作(perform action trip : DriveCycle;、perform trip.supply;),allocate a to b;将一个元素分配给另一个元素。
行为:状态
状态定义包含状态及其之间的转换。
state def PowertrainStates {
entry; then off;
state off;
accept StartRequest then hybrid;
state hybrid {
entry action startEngine;
do action driveHybrid;
exit action stopEngine;
}
transition recharged first hybrid if charge > 60 then electric;
}
entry; then off;设置初始状态。- 转换具有触发器(
accept StartRequest)、可选的守卫(if charge > 20)和可选的效果(do …)。短形式写在源状态之后;长形式为transition name first a … then b;。 - 在模型中,转换的触发器和效果是独立的元素:一个接受动作和一个动作(
send、assign、perform、terminate或命名动作)。浏览器在转换下方将它们显示为 trigger 和 effect。它们是转换自身的accepter和effect,因此模型的其他部分可以引用它们:chargerStates.plugIn.effect.sentMessage就是该效果发送的消息,正如序列模型所绑定的那样。 - 通过端口的触发器必须接受该端口传送的内容:在演示的
ChargeManager中,accept connectCharger : ChargerConnected via chargePort与该端口的in connected : ChargerConnected相匹配。效果send new ChargeRequest() to controller发送给一个部件;属性等值无法接收消息。 entry、do和exit动作分别在进入状态时、处于状态期间和离开状态时运行。parallel状态具有同时处于活动状态的多个区域。- 部件通过
exhibit展现一个状态:exhibit state powertrainStates : PowertrainStates;。
需求、约束和验证
需求在 doc 中保存其陈述,以 subject 表示其适用的元素,以 require constraint 表示可检查的条件。
requirement def <'VR-1'> CurbMass {
doc /* The car's curb mass shall not exceed the mass limit. */
subject car : Car;
attribute limit : MassValue;
require constraint { car.curbMass <= limit }
}
satisfy carSpec by fleet.sedan;
assume constraint说明需求所假定的条件。当该条件不成立时,该需求及其中嵌套的需求都算作已满足;外层的需求和其他嵌套需求仍会被检查。actor、stakeholder和frame concern说明需求是为谁以及为什么而设。satisfy R by part;表示某个部件满足一个需求。- 验证用例在其目标中验证需求:
objective { verify carSpec.sedanMass; }。它可以return verdict : Boolean = …;。 - 分析用例具有主体、目标和
return结果,当每个输入都有值时 Holarch 会对结果求值。用例中没有值的属性会根据其目标中的==方程求解(含未知量的分析用例)。 connection : Derivation connect original to derived;记录一个派生需求。#refinement dependency x to R;记录一个细化。dependency from a to b;记录一般的追溯关系。
用例
use case def DriveToWork { subject car : Car; actor driver : Driver; objective { … } include use case startCar : StartCar; }。用例用法沿用其定义的主体和参与者。
视图
视图显示模型的一部分。它由标准视图定义指定类型,并通过 expose 暴露其显示的内容:
view driveCycleFlow : StandardViewDefinitions::ActionFlowView {
expose DriveCycle;
}
filter 缩小元素范围(filter @SysML::RequirementUsage;)。render 选择一种渲染方式。viewpoint 规定视图必须处理的关注点。SysML v2 视图介绍了每种视图。
注释、文档和元数据
doc /* text */为其所有者编写文档。它是模型的一部分;对需求而言,它就是需求文本。comment about x /* text */是模型中关于另一个元素的注释。// text和//* text */是仅存在于文本中的注记。Holarch 会在文本中保留它们,但它们不是模型元素。- 元数据为元素添加标注:在主体中写
@TBD { owner = "Powertrain lead"; },作为前缀写#TBR attribute limit …,或从外部写metadata Capability about Vehicles::Car;。 - 用户自定义关键字:任何元数据定义都可以用作关键字:
#safetyCritical part controller : Controller;用元数据SafetyCritical(短名称<safetyCritical>)标记控制器。元数据定义可以限制其标记的对象::>> annotatedElement : SysML::PartDefinition;只允许部件定义。 - 语义元数据:特化
SemanticMetadata的元数据定义会设置一个基类型,:>> baseType = faults meta SysML::Usage;。此后它标记的每个元素都会特化该基类型:用法成为基用法的子集,定义特化基定义或基用法的定义。因此#fault def BatteryOverheat;和#fault overheat : BatteryOverheat;都是故障,并具有Fault的特征。使用语义元数据时,可以省略语言关键字,如这两行所示;浏览器会连同其关键字一起显示它们(#fault def)。从外部写的metadata Fault about x;不会使x成为故障:检查会发出警告,并建议用#fault直接标记x。 - 具有自身含义的元数据:元数据定义的特征是每次使用它时都必须说明的内容,其约束必须对这些特征成立。对于
metadata def SafetyRating { attribute level : Natural; assert constraint { level >= 1 and level <= 4 } },检查会报告@SafetyRating;(没有 level)和@SafetyRating { level = 7; }(超出范围);@SafetyRating { level = 4; }则没有问题。在定义中带有值或default的特征,或声明为[0..1]的特征,可以省略。每个值都必须符合其特征的类型:Boolean 为true或false,String 为引号中的文本,Integer 为整数(Natural 为 0 或以上,Positive 为大于 0),枚举则为其中一个值,例如HazardAnalysis::fmea;检查会报告任何其他值,以及定义中不符合类型的默认值。元数据主体只为定义的特征赋值(level = 4;),并且abstract metadata def不能被应用。Hybrid Car 演示将其控制器评级为@SafetyRating { level = 4; },并将电池的评审记录为@SafetyReview { method = HazardAnalysis::fmea; closed = true; }。在编辑器中,插入 ▾ → 元数据定义会开始一个带有特征和规则的定义,应用元数据会在主体中应用一个元数据。无需编写文本的方法:选择一个定义或用法,然后使用属性面板的元数据部分。添加元数据会应用项目中的某个元数据定义;随后每个特征都有一个字段(枚举或 Boolean 为值列表,String 为纯文本,由 Holarch 加上引号写入;定义的默认值显示为提示,没有默认值的特征标记为必需);检查对该元数据的发现项显示在其下方;移除会将其去掉。每次更改都可通过一次撤销撤回。来自标准库的元数据和 Holarch 自己的元数据(仿真、目标、可变性)保留各自的控件,不在此处列出。
个体、快照和时间切片
个体是贯穿其整个生命周期的某个特定事物,例如一辆带有序列号的汽车,而不是一类事物。快照是该事物在某一瞬间的状态;时间片是其生命周期中的一段时期。两者都属于拥有它们的事件,并具有该事件的特征,因此可以为这些特征赋予各自的值。
individual part def Car_VIN1234 :> Car {
snapshot atDelivery { attribute :>> mileage = 0 [km]; }
timeslice firstOwner { attribute ownerName : String = "Dana Reyes"; }
snapshot atService { attribute :>> mileage = 15000 [km]; }
first atDelivery then atService;
assert constraint mileageGrows { atDelivery.mileage <= atService.mileage }
}
individual写在类型关键字之前(individual part def、individual item def)或单独使用(individual def Plate_77;)。写作individual的用法恰好由一个个体定义指定类型:individual car1 : Car_VIN1234;。snapshot和timeslice写在类型关键字之前或单独使用,位于部件、项、动作或其他事件内部。then timeslice secondOwner;将时间片排在其前一个成员之后。- 快照或时间片中的值首先在其内部读取,然后从个体读取,再从其定义读取。在示例中,
atService.mileage为 15,000 km,约束成立。 - 只有事件才能是个体、快照或时间片:属性和枚举是值。
- 在架构 → 部件以及数据库和网格视图中,实例列列出每个部件的定义的个体(对于
part sedan : Car:Car_VIN1234):特化该定义的个体定义,以及由该定义指定类型的个体用法。Individual(是)和部分(portion)(快照或时间片)也是列(列 ▾ → SysML v2)。模型中有个体后,部件页面默认显示实例,此时 Table (CSV) 导出会包含这三列;定义导出会为具有这些内容的每个元素列出它们。 - 在属性面板中,特征下的事件用于设置 Individual,对于用法还可设置整个生命周期、时间片或快照。浏览器的类型筛选中有 Individuals,行的 ⋯ 菜单中有新建快照…和新建时间片…。一般视图在框标题中显示 «individual part def»、«snapshot» 和 «timeslice»,在单独的分隔区中列出框的快照和时间片,并以虚线箭头绘制框之间的后继;排列 ▾ → 排列为时间线会将它们从左到右排成一行。在 Hybrid Car 演示中,一般视图
carLifeline显示Car_VIN1234的快照和时间片。
变化、变体和配置
变化列出设计中某一点上允许的选项;每个选项是一个变体。变化定义(variation part def)是一组可复用的选项;变化用法(variation part charger)是某个设计中的一个点。配置为每个点选择一个变体。
variation part def BatteryPack :> Battery {
variant part standardPack { attribute :>> capacity = 1.4 [kW*h]; }
variant part largePack { attribute :>> capacity = 12 [kW*h]; }
}
part def CarLine :> Car {
part pack : BatteryPack;
variation part charger : Component {
variant part noCharger;
variant part wallbox;
}
assert constraint wallboxNeedsLargePack { charger == charger::wallbox implies pack == BatteryPack::largePack }
}
part plugInHybrid : CarLine {
@HolarchConfiguration;
part :>> pack = BatteryPack::largePack;
part :>> charger = charger::wallbox;
}
- 变体具有其变化的特征,并可以重定义它们:
largePack有capacity,因为BatteryPack是一种Battery。 - 不带类型关键字的
variant x;使现有用法x成为选项之一;它以x命名。 - 变化只拥有变体(以及定义、注释、元数据和导入)。变化本身已经是抽象的,因此在其上写
abstract会被注明为多余。 - 用值来选择变体:
part :>> pack = BatteryPack::largePack;。不是该点变体的选择会报错。 - 当某个点尚未选择时,其值是未知的,因此关于它的断言既不满足也不违反。在配置中,会使用所选变体的值。
- 用
@HolarchConfiguration(包HolarchVariability,位于标准库的 Holarch 下)标记配置:编辑器随后会注明配置中尚未选择的每个点。 - 在编辑器中,插入 ▾ 可写入以下每一项:变化(在包级别为定义,在部件内为一个点)、变体(在变化内)、配置和变体选择(在配置内)。
- 在 Hybrid Car 演示中,
CarLine有两个点(pack和charger),selfChargingHybrid和plugInHybrid是它的配置;断言排除了壁挂式充电器与标准电池包的组合。
文本表示
文本表示用另一种语言编写元素:在元素主体中写 rep language "Python" /* … */。主体保留为文本。模型由其周围的 SysML 所声明的内容构成;Holarch 从不运行主体。
- 在 Hybrid Car 演示中,
DriveWheels用 Python 承载其计算:rep language "Python" /* wheel_speed = torque.value * GEAR_RATIOS[gear] / WHEEL_RADIUS */。 "sysml"或"kerml"中的主体会被检查。SpeedLimit写作rep language "sysml" /* speed <= limit */,Holarch 会像对直接编写的约束一样对其求值。- 编辑器将 SysML 和 KerML 主体作为代码在带底色的背景上高亮显示。其他语言显示为注释文本。
- 属性面板的表示形式部分列出每个表示及其语言和主体。在定义或用法上点击添加表示可添加一个表示,点击移除可删除一个表示。
- 动作流视图会用花括号中的语言标记其定义带有表示的动作,例如 {Python}。
- 已知语言:SysML、KerML、OCL、Alf、Python、JavaScript、MATLAB、Modelica、C、自然语言(
naturalLanguage、English、text)。名称后的版本号会被忽略(OCL2.0、Python 3)。 - 主体不能包含
*/,否则会结束注释。
Holarch 自己的讨论评论、标签、负责人和截止日期保存在模型旁边,不会写入文本。
如何使用
对结构建模
- 在编辑器中打开一个包(或点击+ 新建包)。
- 为每种连接点编写一个
port def,带有有方向的特征(out attribute torque : TorqueValue;)。 - 为每种组件编写一个
part def,带有其属性和端口。 - 为装配体编写一个
part def,为每个组件写一个part。 - 连接部件:
connect a.p to b.q;或interface name : Def connect a.p to b.q;。 - 停止键入。状态行显示已应用,浏览器显示新元素。
插入 ▾(或 ⌃⇧Space / Ctrl+Shift+Space)会为您写入以上每种构造,并提供待填写的字段。请参阅插入构造。
给出带单位的值
- 在包的顶部导入量的种类和单位:
private import ISQ::*;和private import SI::*;。 - 用量的种类为属性指定类型并赋值:
attribute mass : MassValue = 45 [kg];。 - 在继承该属性的定义中,用其自身的值重定义它:
attribute redefines mass = 18 [kg];。 - 将指针指向该值。如果单位与量的种类不符,会出现错误卡片。
描述行为
- 编写一个带有
in和out参数的action def。 - 每个步骤添加一个
action用法,并用first … then …;或then为它们排序。 - 并行步骤使用
fork和join,备选路径使用decide和merge。 - 在传递项的步骤之间添加
flow of Item from a.out to b.in;。 - 在执行该行为的部件中编写
perform action name : Def;,并在其部件中编写perform name.step;。 - 在动作流视图中打开该动作即可查看其图形(请参阅 SysML v2 视图)。
编写需求并追溯它
- 编写
requirement <'ID'> name { doc /* The system shall … */ subject s : Def; }。 - 当需求可以根据数值进行检查时,添加
require constraint { … }。 - 在设计满足需求之处编写
satisfy name by somePart;。 - 编写一个其目标通过
verify验证该需求的verification。 - 打开需要与需求 → 需求:该需求会连同其编号一起列出,验证 → RVTM 显示其验证方式。请参阅 SysML v2 项目中的需求与验证。
将值标记为 TBD 或 TBR
用 TBD 代替值不是有效的 SysML。请改用 Holarch 的元数据。
- 导入它:
private import HolarchMetadata::*;。 - 为属性添加前缀:
#TBD attribute chargerPower : PowerValue;(尚无值)或#TBR attribute limit : TimeValue = 0.5 [h];(待复核的值)。 - 要记录负责人和理由,请在属性主体中使用长形式:
@TBD { owner = "Powertrain lead"; rationale = "The charging standard is not chosen yet."; due = "2026-12-01"; }。
TBD/TBR 登记册列出这些值。TBD 和 TBR 特化 ModelingMetadata::StatusInfo,因此其他 SysML v2 工具会将它们读作状态标注。插入 ▾ → TBD 值和 TBR 值会为您写入它们。
查找库名称
- 从导航栏工具中打开标准库。
- 在查找包或定义…中键入名称的一部分,例如
MassValue。 - 点击该行上的复制名称。限定名(此处为
ISQBase::MassValue)即被复制。 - 将其粘贴到编辑器中,或导入其包并使用短名称。
实例:阅读轿车的需求
本示例在 Hybrid Car 演示文本中追踪一个需求。
- 打开演示,并在编辑器的包列表中选择 VehicleRequirements。
- 找到
requirement def <'VR-1'> CurbMass。其require constraint { car.curbMass <= limit }将主体的整备质量与limit进行比较。 - 找到
requirement carSpec。它包含requirement <'VR-1.1'> sedanMass : CurbMass { attribute :>> limit = maxCurbMass; }。该用法用包级目标值maxCurbMass = 1650 [kg]重定义了limit。 - 找到
satisfy carSpec by fleet.sedan;。按住 ⌘ / Ctrl 点击sedan:编辑器会在part sedan : Car处打开 Vehicles,其中attribute redefines curbMass = 1580 [kg];给出了该值。 - 回到 VehicleRequirements,找到
verification def CurbMassTest。其目标verify carSpec.sedanMass;使它成为 VR-1.1 的验证用例,verification sedanWeighing : CurbMassTest { subject car = fleet.sedan; }将其应用于轿车。 - 在 Vehicles 中将
1580 [kg]改为1700 [kg]并停止键入。轿车现在超出 1650 kg 的限值,编辑器会在 VehicleRequirements 中显示一条警告,说明sedan不满足该需求,并给出为假的约束及其数值。用 ⌘Z / Ctrl+Z 撤销。
提示和常见错误
- “…”在此处未定义。名称拼写错误或其包未导入。请添加
private import Package::*;,或写出限定名。 - 缺少
;。每个声明都以;或{ … }主体结尾。The declaration does not end. Add ; or a { … } body.(声明没有结束。请添加 ; 或 { … } 主体) :>与:>>。用:>进行特化或取子集;用:>>替换继承的特征。重定义未继承的特征会得到 “x”不是由“y”继承的。- 单位需要导入。
5 [kg]只在SI可见的地方才能解析。 - 两个成员同名。“x”已在此命名空间中使用。请重命名其中一个;变体则应改用重定义。
- 在目标之外使用
verify。将其放入验证用例的objective { verify R; }中。 - 用关键字作名称。
part、state或action等词是保留字。请为它们加引号('state')或另选名称。
Holarch 支持的内容
Holarch 支持 SysML v2 文本表示法的以下部分。编辑器会检查所有这些部分,模型也会保留它们。
| 领域 | 已支持 |
|---|---|
| 包和命名空间 | package、嵌套包、library package(只读)、doc、comment … about、注记 // 和 //* */、alias … for …、public/private/protected、短名称 <'1.2'>、带引号的名称 |
| 导入 | 成员导入和命名空间导入、::*、递归 ::**、筛选导入 [@Kind] |
| 定义和用法 | part, attribute, item, port, connection, interface, flow, action, state, requirement, constraint, calc, use case, analysis, verification, view, viewpoint, concern, enum, occurrence, allocation, metadata; ref, abstract, in/out/inout, end |
| 特化 | :>/specializes、:/defined by、:>/subsets、:>>/redefines、共轭 ~、disjoint、特征链 a.b.c |
| 多重性 | [n]、[n..m]、[*]、[0..*]、ordered、nonunique、作为边界的表达式 |
| 值和单位 | =、:=、default、量 5 [kg]、单位表达式 [m/s^2]、标准库中的 ISQ 量的种类以及 SI 和美国惯用单位、量纲检查 |
| 结构 | 端口和共轭端口、connect、带端的接口、带多重性的命名连接器端、bind、flow of T from … to …、message |
| 动作 | 参数、perform、后继(first … then …、then)、fork、join、decide、merge、守卫、accept、send、assign、if、while、for、loop、start、done、terminate |
| 状态 | entry/do/exit、带触发器、守卫和效果的转换、parallel 状态、嵌套状态、exhibit |
| 需求 | subject、actor、stakeholder、require constraint、assume constraint、frame concern、satisfy … by …、verify、短名称作为 ID、doc 作为需求文本 |
| 约束和计算 | 约束和计算的定义与用法、return、assert constraint、调用、带算术、比较、逻辑、if ? else 和序列操作的 KerML 表达式、带单位的求值 |
| 用例、分析和验证 | subject、actor、objective、include use case、带 return 结果的分析用例、带 verify 和判定结果的验证用例 |
| 视图 | view、view def、expose(带 ::*、::** 和筛选器)、filter、viewpoint、frame、render、标准视图定义 |
| 分配和追溯 | allocate a to b、分配定义、dependency from … to … |
| 个体 | individual 定义和用法、snapshot 和 timeslice(也可在 then 之后)、它们的值和后继 |
| 可变性 | variation 定义和用法、variant 成员和变体引用(variant x;)、按值选择、标记为 @HolarchConfiguration 的配置(HolarchVariability) |
| 元数据 | @Name { … }、#Name 前缀、metadata Name about …、Holarch 的 HolarchMetadata(TBD、TBR)和 HolarchFrameworks 包;用户自定义的 metadata def;用户自定义关键字和语义元数据(#fault def …) |
按原样保留,不作解释
Holarch 会完全按原样读取并保留以下构造,但不赋予它们自身的含义:
- SysML 和 KerML 以外语言的文本表示(保留为文本;请参阅文本表示)。
尚未提供
- 导入 KerML 文件(
.kerml)。 - 通过 Systems Modeling API 向
main提交、创建标签和合并:其他工具提交到变更请求分支,由审批人在 Holarch 中应用(请参阅 SysML v2 项目中的 API 和 MCP)。 - 超出用户自定义关键字和语义元数据范围的语言扩展。
检查
Holarch 会在您键入时检查文本。每个问题都会在编辑器的边栏中标记并加下划线;消息先说明问题,再给出修正方法。错误会阻止成员被应用;警告不会。
| 领域 | 检查内容 | 示例消息 |
|---|---|---|
| 语法 | 字符、注释、字符串、花括号、;、预期的名称和记号 | 此花括号没有配对。请添加对应的 { 或 },或删除此花括号。 |
| 名称 | 无法解析、有歧义、无效、重复(警告)和私有的名称 | “Batery”在此处未定义。请检查拼写,或导入其包。 |
| 类型定义和特化 | 循环;由正确种类的定义指定类型和特化;特征的取子集和重定义;仅可重定义继承的特征 | “capacity”不是由“Car”继承的。请特化其类型,或改用 :> 取其子集。 |
| 多重性 | 有效的整数边界;重定义的范围不宽于被重定义的对象 | 多重性 [3..1] 无效。请使用从 0 到上界之间的下界。 |
| 单位和值 | 量纲匹配、缺少单位、单位名称、数字类型 | 单位不匹配:kg 和 s。请将一侧转换为兼容的单位。 |
| 表达式 | 语法、操作数类型、计算参数、布尔条件 | 条件必须为真或假;它是一个数字。请写一个比较式,例如 x > 0。 |
| 结构 | 连接端是特征、接口连接端口、端口、流和消息的方向、流的项类型、绑定类型 | 这些端口方向不匹配。请共轭其中一个端口(~)或更改方向。 |
| 动作 | 同一主体中动作之间的后继、控制节点的入/出数量、决策守卫和 else、start 和 done、赋值、perform 目标、for 循环所迭代的值与循环变量类型的匹配 | then 需要一个前面的动作。请添加一个动作或 first … then …。 |
| 状态 | 同一主体中状态之间的转换、每种 entry/do/exit 各一个、初始转换、并行区域、exhibit 目标、转换的 do 效果(向可接收的对象 send、assign、accept、action 或命名动作)、触发器的负载与其端口的项的匹配、对 Real 等裸库值的触发器(警告)、指定时间的 at 触发器 | “electric”有子状态但没有初始转换,因此不会进入其中任何子状态。请添加 entry; then <first state>;。 |
| 需求、用例和视图 | 成员位置正确、一个主体、satisfy/verify/require 目标、主体类型、expose 和 import 目标、frame 目标 | verify 应位于验证用例的目标中。请将其移入 objective { … }。 |
| 文本表示 | SysML 和 KerML 主体能够解析,并声明其所表示的元素;未知语言会被注明 | “SpeedLimit”的表示声明的是部件定义,而不是约束定义。请让主体声明“SpeedLimit”本身。 |
| 个体、快照和时间切片 | individual 只能用于事件,且恰好有一个个体定义;snapshot/timeslice 只能用于事件内部的事件用法;快照中的时间片(警告) | “parked”是 individual,但其定义都不是。请用个体定义为其指定类型,或移除 individual。 |
| 可变性 | 变化只拥有变体;变体位于变化中且属于其种类;选择是其点的变体;变化上的 abstract 是多余的(注记);配置中未确定的点(注记) | “compact”不是“pack”的变体。请从以下选项中选择一个:standardPack、largePack。 |
| 用户自定义关键字 | #Name 指向一个元数据定义;没有语言关键字的声明使用语义元数据(警告);元数据只标记其 annotatedElement 允许的种类;语义基类型是定义或用法,适合其标记的元素(警告),且不构成循环 | “safetyCritical”适用于 PartDefinition,而不是“invert”(ActionUsage)。请移动它,或将其移除。 |
| 元数据值 | 用户自定义元数据定义的每个必需特征都有值(警告);每个值和默认值都符合其特征的类型(Boolean、String、整数、枚举);定义的约束对给定的值成立;元数据主体只重定义定义的特征;抽象元数据定义不被应用;用 about 编写的语义元数据(警告) | “SafetyRating”的值违反了其约束 levelRange:level >= 1 and level <= 4。请更改这些值。 |
| 求值 | 对当前值不成立的约束、需求和目标 | “sedanMass”未被“sedan”满足:… 为假(…)。请更改设计值或需求。 |
标准库
标准库页面列出每个 SysML v2 项目都可以使用的包和定义:值和单位、量、部件、端口、动作、状态、需求、分析等。它是只读的。
- 打开方式:在导航栏工具中点击设置 → 标准库。LML 项目没有标准库。
- 文件夹。左侧按文件夹列出库文件:Kernel Libraries、Systems Library、Domain Libraries(Analysis、Cause and Effect、Geometry、Metadata、Quantities and Units、Requirement Derivation)和 Holarch(包含 TBD 和 TBR 的
HolarchMetadata包、包含HolarchConfiguration的HolarchVariability,以及包含Objective的HolarchRequirements)。 - 文件。选择一个文件即可查看其中的包,每个包都附有其文档以及定义表:名称、种类和文档。
- 查找。在查找包或定义…中键入内容,即可搜索每个文件的名称和文档。结果会显示所在文件;点击即可打开该文件。按 Esc 清除。
- 复制名称会复制元素的限定名(例如
ISQ::MassValue),以便在编辑器中使用。 - 显示文本显示库文件的原文;显示定义返回到表格。
该库是 SysML v2 发布版的库,只做了一处更正:tonne(别名 'metric ton')换算为 1000 kg,而发布版文件中写的是 0.001 kg。您的模型按名称引用它;它不会被复制到项目中,也不属于 .sysml 导出的内容。
限制
- 大于 8 MB 的文本文档不会被检查:This text is larger than 8 MB and is not checked. Split it into several packages.(此文本大于 8 MB,不会被检查。请将其拆分为多个包)
- 长度超过 64 KB 的行不会被检查。
- 嵌套深度超过 256 层的内容不会被检查。
- 标准库无法编辑。
相关页面
SysML® 和 OMG® 是 Object Management Group, Inc. 在美国和其他国家/地区的注册商标。