SysML v2
SysML v2 教程
九个面向 SysML v2 项目的引导式教程,从第一个包到端口、动作、状态、需求、验证、约束和变体,并配有检查您操作的步骤面板。
Holarch 为 SysML v2 项目提供一组引导式教程。每个教程都会创建一个小型 SysML v2 起始项目,并在页面旁打开一个步骤面板。面板会在您操作时检查模型:当模型具备步骤所要求的内容时,该步骤就会变绿。本页以文本形式列出了每一步,因此您也可以在这里跟着操作。
第一个教程与 LML 教程一样使用 WS-1 Weather Station。其他教程构建混合动力汽车(即 Hybrid Car 演示中的模型)的各个部分:值类型和组件、动力总成的端口和接口、驾驶循环、动力总成的状态、汽车的需求及其验证、对轿车数值的检查以及产品线。每个教程都有自己的起始项目,因此您可以按任意顺序学习。每个起始项目和每个完成的教程在检查时都是 0 个问题。
| 教程 | 时间 | 您将学会 |
|---|---|---|
| 入门 | 15 分钟 | 编写 SysML v2 文本,以树和视图查看它,在视图中绘图并添加需求 |
| 定义和属性 | 20 分钟 | 编写枚举、值类型和抽象定义,用值和单位进行特化,并使用自动补全、插入和重命名 |
| 端口和接口 | 20 分钟 | 定义端口和接口,共轭端口,连接部件,并在互连视图中绘制接口 |
| 动作和流 | 20 分钟 | 编写动作定义以及带有分叉、流和汇合的驾驶循环,添加泳道并在 FFBD 中构建步骤 |
| 状态和转换 | 20 分钟 | 编写信号以及带有触发器、守卫和状态动作的状态机,并绘制定时转换 |
| 需求 | 20 分钟 | 编写限值、需求定义和用法,满足它们,并查看一个未满足的需求 |
| 验证和可追溯性 | 15 分钟 | 编写验证用例,在可追溯性矩阵中追溯一个步骤并派生需求 |
| 约束和计算 | 20 分钟 | 编写约束和计算,在参数视图中绑定数值,运行分析用例并标记 TBD 和 TBR 值 |
| 变体和配置 | 15 分钟 | 编写变化和变体、带规则的产品线、配置以及您自己的关键字 |
如何使用
开始 SysML v2 教程
- 在导航栏中打开帮助 → 教程,或按 ⌘K / Ctrl+K 并键入
tutorial。在项目之外,教程页面先列出 LML 教程,然后是 SysML v2 项目教程。在 SysML v2 项目内,它只列出 SysML v2 教程。 - 点击卡片上的开始。Holarch 会创建项目,例如 Tutorial: SysML v2 Ports and Interfaces (Hybrid Car),并在右侧打开步骤面板。
步骤面板的用法与 LML 教程相同:演示给我看会框出步骤所需的控件,前往会打开相应页面,了解更多会打开帮助主题,重新开始…、标记为已完成和 × 的用法也相同。请参阅教程。
键入步骤的文本
大多数步骤会给出要在模型 → 编辑器中键入的 SysML 文本。步骤会说明这些行放在哪里,例如“在包的最后一个右花括号之前”。您停止键入时,文本会应用到模型;编辑器下方的状态会说明这一点,步骤也会变绿。
- 按所示内容键入这些行。缩进对模型没有影响;编辑器会保留您的缩进。
- 红色下划线标记错误:将指针指向它即可阅读消息。含语法错误的文本保持为草稿,在您修正之前不会应用。
- ⌘Z / Ctrl+Z 撤销上一次应用的更改。
提示
- 第一次请按顺序学习这些教程:每个教程都会解释其使用的文本,后面的教程会假定您已了解前面的概念(定义和用法、
:>和:>>)。 - 一直未完成的步骤通常是某个名称有拼写错误。将您的文本与步骤中的行进行比较;在 SysML v2 中名称区分大小写。
- 这些教程所讲的语言与 SysML v2 基础相同;文本表示法页面提供详细信息。
入门
编写气象站的第一个模型:打开文本,添加一个带有值和单位的部件定义,在另一个定义中使用它,在浏览器和一般视图中查看模型,在视图中绘制一个部件并观察它出现在文本中,用 satisfy 添加需求,然后将模型导出为 .sysml 文件。这些步骤的说明见 SysML v2 项目入门。
定义和属性
起始项目包含包 Vehicles,其中有一个部件定义 Car。
- 打开包。点击模型 → 编辑器。每个声明都由一个关键字和一个名称组成,后跟花括号中的主体或一个分号。
- 编写枚举。在
part def Car {上方添加enum def DriveMode { enum economy; enum normal; enum sport; }(每行一个值)。 - 定义值类型。在其下方添加
attribute def TirePressure :> ScalarValue;。:>表示特化。 - 编写抽象定义。添加
abstract part def Component,带有一个doc注释以及属性mass : MassValue、partNumber : String和power : PowerValue。//开始一条只保留在文本中的注记。 - 让检查器发现错误。添加
part def Battery :> Component,带有attribute redefines mass = 45 [kg];,并故意写上attribute redefines power = 60 [kg];。检查器会在单位下划线:千克不是功率。 - 修正单位。将其改为
60 [W]。 - 补全名称。在电池中键入
attribute capacity : Ener,用 Enter 从补全列表中接受EnergyValue,并以;结尾。 - 在标准库中查找。点击导航栏底部的设置 → 标准库,并在查找框中键入
EnergyValue。 - 插入定义。在编辑器中的空行上按 ⌃⇧Space / Ctrl+Shift+Space(或点击插入 ▾),选择部件定义,并用
attribute redefines mass = 110 [kg];和attribute cylinders : Integer;完成part def Engine :> Component。 - 使用定义。在
Car中添加attribute mode : DriveMode;、part battery : Battery;和part engine : Engine;。 - 全局重命名。将光标放在
cylinders上,按 F2 并将其重命名为cylinderCount。
端口和接口
起始项目包含动力总成的各个组件及其扭矩和功率端口、端口定义 TorquePort 和 PowerPort,以及接口定义 Shaft 和 HighVoltageBus。
- 定义端口。在
port def TorquePort上方添加port def FuelPort,带有out attribute flowRate : Real;和attribute kind : FuelKind;。out表示该值离开拥有该端口的部件。 - 为部件添加端口。向
FuelTank添加port fuelOut : FuelPort;,向Engine添加port fuelIn : ~FuelPort;。~将端口共轭:输入和输出互换。 - 定义接口。添加
interface def FuelLine { end supply : FuelPort; end consumer : ~FuelPort; }。 - 构建动力总成。在包的末尾添加
part def Powertrain,带有部件tank、engine、motor、battery和transmission、一个端口output : TorquePort以及bind output = transmission.output;。 - 连接两个部件。在动力总成中添加
interface fuel : FuelLine connect tank.fuelOut to engine.fuelIn;。 - 添加传动轴。添加
interface engineShaft : Shaft connect engine.output to transmission.engineIn;和interface motorShaft : Shaft connect motor.output to transmission.motorIn;。 - 创建互连视图。点击架构 → 互连视图,然后点击+ 新建图。在显示下选择
Powertrain,然后点击创建。 - 绘制接口。从电池端口
powerOut的手柄拖到电机的端口powerIn,并放在 Interface : HighVoltageBus 上。 - 为接口命名。选择新连线,并在属性面板中输入
hvBus作为其名称。 - 在文本中查看。点击模型 → 编辑器:接口位于动力总成中,带有其名称、类型和端。
动作和流
起始项目包含包 VehicleBehavior,其中有项 Fuel 和 Torque、功能 ProduceTorque(F.2)和 DriveWheels(F.3),以及三个部件定义。
- 定义功能。添加
action def <'F.1'> SupplyFuel,带有in attribute fuelDemand : Real;和out item fuel : Fuel;。尖括号中的短名称就是功能编号。 - 编写驾驶循环。添加
action def <'F'> DriveCycle,带有first start then split;、fork split;、then supply;、then produce;以及步骤action supply : SupplyFuel和action produce : ProduceTorque,每个步骤都带有duration。 - 添加流。在驾驶循环中添加
flow of Fuel from supply.fuel to produce.fuel;。 - 汇合分支。添加
first supply then ready;、first produce then ready;、join ready;、then action drive : DriveWheels { … }、then done;和flow produce.torque to drive.torque;。 - 创建动作流视图。点击行为 → 动作流,然后点击+ 新建图,并在显示下选择
DriveCycle。 - 说明每个步骤由谁执行。添加
part def DrivenCar,带有perform action trip : DriveCycle;以及部件tank、engine和transmission,每个部件分别带有perform trip.supply;、perform trip.produce;或perform trip.drive;。视图会为每个部件生成一条泳道。 - 打开功能分析。点击行为 → 功能分析,点击选择…并选取
DriveCycle。 - 声明另一个动作。添加
action def EmergencyShutdown;。 - 在 FFBD 中构建步骤。点击行为 → FFBD,然后点击+ 新建图,并选择
EmergencyShutdown。在添加面板中键入Open Contactors并按 Enter,然后键入Cut Fuel。 - 在文本中查看步骤。点击模型 → 编辑器:FFBD 已写入步骤及其后继。
状态和转换
起始项目包含包 PowertrainBehavior,其中有一个空的 part def Car。
- 定义信号。添加
attribute def StartRequest;,并以同样方式添加StopRequest、PlugIn和Unplug。 - 编写状态定义。添加
state def PowertrainStates,带有in attribute charge : Real;、entry; then off;以及状态off、electric和hybrid。 - 添加转换。在
state off;之后添加accept StartRequest if charge > 20 then electric;和accept StartRequest then hybrid;。 - 为状态添加动作。将
state electric;替换为一个包含entry action spinUpMotor;、do action driveElectric;和exit action holdMotor;的主体。 - 离开 electric 状态。在其后添加
if charge < 15 then hybrid;和accept StopRequest then off;;也在state hybrid;之后添加accept StopRequest then off;。 - 添加带有命名转换的状态。添加
state charging { do action chargeBattery; }、transition plugIn first off accept PlugIn then charging;和transition unplugged first charging accept Unplug then off;。 - 创建状态转换视图。点击行为 → 状态机,然后点击+ 新建图,并在显示下选择
PowertrainStates。 - 绘制定时转换。从
charging的手柄拖到off,并放在转换上。在转换面板中,输入名称charged和触发器after 30 [min]。 - 在文本中查看。点击模型 → 编辑器:该转换被写为命名转换。
- 让汽车展现这些状态。在
Car中添加exhibit state powertrainStates : PowertrainStates;。
需求
起始项目包含包 VehicleRequirements,其中有设计的一个小副本:Battery、Car 以及车队中整备质量为 1580 kg 的 sedan。
- 为限值命名。添加
attribute maxCurbMass : MassValue = 1650 [kg];和attribute minBatteryCapacity : EnergyValue = 1.2 [kW*h];。 - 编写需求定义。添加
requirement def <'VR-1'> CurbMass,带有一条doc陈述、subject car : Car;、attribute limit : MassValue;和require constraint { car.curbMass <= limit }。 - 插入需求。在空行上按 ⌃⇧Space / Ctrl+Shift+Space,选择需求定义,并编写
VR-3 BatteryCapacity,带有主体battery : Battery和require constraint { battery.capacity >= minBatteryCapacity }。 - 在规格中嵌套需求。添加
requirement carSpec,带有subject car : Car;和requirement <'VR-1.1'> sedanMass : CurbMass { attribute :>> limit = maxCurbMass; }。 - 说明由什么满足它们。添加
satisfy carSpec by fleet.sedan;和satisfy requirement batterySpec : BatteryCapacity by fleet.sedan.battery;。 - 使需求不满足。将轿车的整备质量改为
1700 [kg]。编辑器会标记该 satisfy:轿车不再满足 VR-1.1。 - 再次满足。按 ⌘Z / Ctrl+Z,或将其改回
1580 [kg]。 - 查看需求表。点击需要与需求 → 需求。
- 创建需求视图。在图页面上点击+ 新建图,选择需求视图,并在显示下选择
carSpec。 - 检查陈述。点击需要与需求 → 质量,然后点击检查质量。
验证和可追溯性
起始项目包含整备质量需求和汽车规格、带有步骤 cruise 和 brake 的驾驶循环、VR-6 batteryMassLimit 和 VR-7 stopFromCruise。
- 编写验证用例。添加
verification def <'VC-1'> CurbMassTest,带有subject car : Car;、objective massObjective { verify carSpec.sedanMass; }和return verdict : Boolean = car.curbMass <= maxCurbMass;。 - 将其应用于轿车。添加
verification <'VC-1.1'> sedanWeighing : CurbMassTest { subject car = fleet.sedan; }。 - 打开验证用例。点击验证 → 验证用例。步骤、结果和状态是模型旁边的 Holarch 数据。在 Sedan Weighing 所在行中点击+ 步骤,然后点击+ 添加步骤,在动作下键入
Weigh the car并点击应用。然后点击其状态按钮中的通过。 - 阅读 RVTM。点击验证 → RVTM。
- 将步骤追溯到需求。点击验证 → 可追溯性矩阵,将需求显示为行、动作显示为列,点击
stopFromCruise与brake交叉的单元格,然后选择 satisfied by。 - 派生需求。添加
private import RequirementDerivation::*;和connection batteryMassDerivation : Derivation connect carSpec.sedanMass to batteryMassLimit;。 - 运行模型检查。点击验证 → 模型检查。
约束和计算
起始项目包含包 VehicleAnalysis,其中有发动机、电池、汽车和轿车的数值,以及目标值 maxCurbMass 和 minPowerToWeight。
- 编写约束定义。添加
constraint def MassLimit,带有in mass : MassValue;、in limit : MassValue;和表达式mass <= limit。 - 编写计算。添加
calc def PowerToWeight,带有参数power和mass以及return ratio = power / mass;。 - 绑定轿车的数值。添加
constraint sedanMassCheck : MassLimit { in mass = fleet.sedan.curbMass; in limit = maxCurbMass; }。 - 创建参数视图。在图页面上点击+ 新建图,选择参数视图,并在显示下选择
VehicleAnalysis。检查通过:1580 kg 在 1650 kg 以内。 - 使检查失败。将轿车的整备质量改为
1700 [kg];视图显示检查失败。 - 使检查再次通过。撤销,或将其改回
1580 [kg]。全部求解会再次检查每个约束。 - 运行分析用例。添加
analysis def PowerToWeightAnalysis,带有要求ratio >= minPowerToWeight的目标,以及analysis sedanPowerToWeight : PowerToWeightAnalysis { subject car = fleet.sedan; }。 - 标记待定值。添加
private import HolarchMetadata::*;和需求 VR-5ChargeTime,在其时间限值上标注#TBR,在充电器功率上标注带有负责人、截止日期和理由的@TBD。TBD和TBR来自 Holarch 的HolarchMetadata库,而不是 SysML v2 标准库;它们特化标准的StatusInfo元数据。 - 打开 TBD/TBR 登记册。点击需要与需求 → TBD/TBR。充电时间会连同其
@TBD元数据中的负责人和截止日期一起列出。登记册是只读的:请在编辑器中修改元数据里的负责人或日期。 - 汇总质量。点击架构 → 预算和 TPM,然后选择根部件
sedan。
变体和配置
起始项目包含 Component、Battery、Controller、Car 和 Powertrain。
- 导入可变性包。添加
private import HolarchVariability::*;。 - 编写变化。在空行上按 ⌃⇧Space / Ctrl+Shift+Space(或点击插入 ▾),选择变化,并用变体
standardPack(1.4 kWh)和largePack(12 kWh,120 kg)完成variation part def BatteryPack :> Battery。 - 编写产品线。添加
part def CarLine :> Car,带有part pack : BatteryPack;、带变体noCharger和wallbox的variation part charger,以及assert constraint wallboxNeedsLargePack { charger == charger::wallbox implies pack == BatteryPack::largePack }。 - 开始一个配置。选择插入 ▾ → 配置并填写
part plugInHybrid : CarLine { @HolarchConfiguration; }。编辑器会注明仍未确定的变化点。 - 选择变体。在
plugInHybrid中,为每个变化点选择插入 ▾ → 变体选择,并填写part :>> pack = BatteryPack::largePack;和part :>> charger = charger::wallbox;。 - 添加第二个配置。以同样方式添加
selfChargingHybrid,使用标准电池包且不带充电器。 - 定义您自己的关键字。添加
metadata def <safetyCritical> SafetyCritical。 - 使用该关键字。在
Powertrain中编写#safetyCritical part controller : Controller;。 - 查看产品线。创建
Vehicles的一般视图:电池包被标记为 variation。
教程项目
SysML v2 教程项目遵循与其他教程项目相同的规则:它们不计入您方案的活动项目数,最多可容纳 300 个条目,并且每个教程可以有一个。请参阅教程。
相关内容
SysML® 和 OMG® 是 Object Management Group, Inc. 在美国和其他国家/地区的注册商标。