Holarch

SysML v2

SysML v2 教學課程

適用於 SysML v2 專案的九個引導式教學課程,從第一個套件到埠、動作、狀態、需求、驗證、約束與變體,並有步驟面板檢查您的成果。

使用方式 →

本頁內容
  1. 使用方式
    1. 開始 SysML v2 教學課程
    2. 輸入步驟的文字
    3. 提示
  2. 入門
  3. 定義與屬性
  4. 埠與介面
  5. 動作與流
  6. 狀態與轉換
  7. 需求
  8. 驗證與可追溯性
  9. 約束與計算
  10. 變體與組態
  11. 教學專案
  12. 相關內容

Holarch 有一系列適用於 SysML v2 專案的引導式教學課程。每個教學課程都會建立一個小型 SysML v2 起始專案,並在頁面旁開啟步驟面板。面板會在您作業時檢查模型:當模型具備步驟所要求的內容時,該步驟就會變成綠色。此頁面以文字列出每個步驟,因此您也可以在這裡跟著做。

第一個教學課程與 LML 教學課程一樣使用 WS-1 Weather Station。其他教學課程則建構混合動力車的各部分,也就是 Hybrid Car 示範專案的模型:值類型與元件、動力系統的埠與介面、行駛循環、動力系統的狀態、車輛的需求、需求的驗證、對轎車數值的檢查,以及產品線。每個教學課程都有自己的起始專案,因此您可以依任意順序進行。每個起始專案與每個完成的教學課程檢查結果都是 0 個問題。

教學課程時間您將學會
入門15 分鐘撰寫 SysML v2 文字、以樹狀結構與檢視查看它、在檢視中繪製,並新增需求
定義與屬性20 分鐘撰寫列舉、值類型與抽象定義,以數值與單位進行特化,並使用自動完成、插入與重新命名
埠與介面20 分鐘定義埠與介面、共軛埠、連接零件,並在 Interconnection View 中繪製介面
動作與流20 分鐘撰寫動作定義與包含分叉、流與匯合的行駛循環,新增泳道,並在 FFBD 中建立步驟
狀態與轉換20 分鐘撰寫訊號與包含觸發條件、防護條件與狀態動作的狀態機,並繪製定時轉換
需求20 分鐘撰寫限值、需求定義與用法,滿足它們,並查看未達成的需求
驗證與可追溯性15 分鐘撰寫驗證案例,在可追溯性矩陣中追溯步驟,並衍生需求
約束與計算20 分鐘撰寫約束與計算,在 Parametric View 中繫結數值,執行分析案例,並標示 TBD 與 TBR 值
變體與組態15 分鐘撰寫變化與變體、含規則的產品線、組態,以及您自己的關鍵字

使用方式

開始 SysML v2 教學課程

  1. 在側欄中開啟說明 → 教學課程,或按 ⌘K / Ctrl+K 並輸入 tutorial。在專案之外,教學課程頁面會先列出 LML 教學課程,再列出 SysML v2 專案教學。在 SysML v2 專案中,只會列出 SysML v2 教學課程。
  2. 按一下卡片上的開始。Holarch 會建立專案,例如 Tutorial: SysML v2 Ports and Interfaces (Hybrid Car),並在右側開啟步驟面板。

步驟面板的運作方式與 LML 教學課程相同:示範給我看會框出步驟所需的控制項,前往會開啟該頁面,閱讀更多會開啟說明主題,而重新開始…、標記為已完成與 × 的運作方式相同。請參閱教學課程。

輸入步驟的文字

大多數步驟會提供要在模型 → 編輯器中輸入的 SysML 文字。步驟會說明這些行要放在哪裡,例如「在套件最後一個右大括號之前」。當您停止輸入時,文字會套用到模型;編輯器下方的狀態會顯示這一點,步驟也會變成綠色。

  • 依顯示的內容輸入這些行。縮排對模型沒有影響;編輯器會保留您的縮排。
  • 紅色底線標示錯誤:將指標指向它即可閱讀訊息。含有語法錯誤的文字會維持為草稿,在您修正之前不會套用。
  • ⌘Z / Ctrl+Z 會復原上一個已套用的變更。

提示

  • 第一次請依序進行教學課程:每個教學課程都會說明它使用的文字,後面的教學課程會假設您已了解前面的概念(定義與用法、:> 與 :>>)。
  • 一直未完成的步驟通常是名稱有錯字。請將您的文字與步驟的各行比較;在 SysML v2 中名稱區分大小寫。
  • 這些教學課程教授的語言與 SysML v2 基礎相同;文字表示法頁面有詳細資訊。

入門

撰寫 Weather Station 的第一個模型:開啟文字,新增含數值與單位的零件定義,在另一個定義中使用它,在瀏覽器與 General View 中查看模型,在檢視中繪製零件並看它出現在文字中,新增含 satisfy 的需求,並將模型匯出為 .sysml 檔案。步驟說明請參閱 SysML v2 專案入門。

定義與屬性

起始專案有套件 Vehicles,其中含一個零件定義 Car。

  1. 開啟套件。按一下模型 → 編輯器。每個宣告都是一個關鍵字與一個名稱,接著是大括號中的本體或分號。
  2. 撰寫列舉。在 part def Car { 上方新增 enum def DriveMode { enum economy; enum normal; enum sport; }(每行一個值)。
  3. 定義值類型。在其下方新增 attribute def TirePressure :> ScalarValue;。:> 表示特化。
  4. 撰寫抽象定義。新增 abstract part def Component,含 doc 註解以及屬性 mass : MassValue、partNumber : String 與 power : PowerValue。// 會開始一則只留在文字中的備註。
  5. 讓檢查器找出錯誤。新增 part def Battery :> Component,含 attribute redefines mass = 45 [kg];,並刻意加入 attribute redefines power = 60 [kg];。檢查器會在單位下加底線:公斤不是功率。
  6. 修正單位。將其改為 60 [W]。
  7. 完成名稱。在電池中輸入 attribute capacity : Ener,以 Enter 從自動完成清單接受 EnergyValue,並以 ; 結尾。
  8. 在標準庫中查詢。按一下側欄底部的設定 → 標準庫,並在尋找方塊中輸入 EnergyValue。
  9. 插入定義。在編輯器中,於空白行上按 ⌃⇧Space / Ctrl+Shift+Space(或按一下插入 ▾),選擇零件定義,並以 attribute redefines mass = 110 [kg]; 與 attribute cylinders : Integer; 完成 part def Engine :> Component。
  10. 使用這些定義。在 Car 中新增 attribute mode : DriveMode;、part battery : Battery; 與 part engine : Engine;。
  11. 全面重新命名。將游標放在 cylinders 上,按 F2,並將其重新命名為 cylinderCount。

埠與介面

起始專案有動力系統的元件及其扭矩與功率埠、埠定義 TorquePort 與 PowerPort,以及介面定義 Shaft 與 HighVoltageBus。

  1. 定義埠。在 port def TorquePort 上方新增 port def FuelPort,含 out attribute flowRate : Real; 與 attribute kind : FuelKind;。out 表示數值離開擁有該埠的零件。
  2. 為零件加上埠。將 port fuelOut : FuelPort; 新增到 FuelTank,並將 port fuelIn : ~FuelPort; 新增到 Engine。~ 會共軛該埠:輸入與輸出互換。
  3. 定義介面。新增 interface def FuelLine { end supply : FuelPort; end consumer : ~FuelPort; }。
  4. 建構動力系統。在套件結尾新增 part def Powertrain,含零件 tank、engine、motor、battery 與 transmission、一個埠 output : TorquePort,以及 bind output = transmission.output;。
  5. 連接兩個零件。在動力系統中新增 interface fuel : FuelLine connect tank.fuelOut to engine.fuelIn;。
  6. 新增傳動軸。新增 interface engineShaft : Shaft connect engine.output to transmission.engineIn; 與 interface motorShaft : Shaft connect motor.output to transmission.motorIn;。
  7. 建立 Interconnection View。按一下架構 → Interconnection 檢視,再按一下 + 新增圖。在顯示下選擇 Powertrain,然後按一下建立。
  8. 繪製介面。從電池的埠 powerOut 的控點拖曳到馬達的埠 powerIn,並放在 Interface : HighVoltageBus 上。
  9. 為介面命名。選取新的線,並在屬性面板中輸入 hvBus 作為其名稱。
  10. 在文字中查看。按一下模型 → 編輯器:介面位於動力系統中,含其名稱、類型與端點。

動作與流

起始專案有套件 VehicleBehavior,含項 Fuel 與 Torque、功能 ProduceTorque(F.2)與 DriveWheels(F.3),以及三個零件定義。

  1. 定義功能。新增 action def <'F.1'> SupplyFuel,含 in attribute fuelDemand : Real; 與 out item fuel : Fuel;。角括號中的簡短名稱是功能編號。
  2. 撰寫行駛循環。新增 action def <'F'> DriveCycle,含 first start then split;、fork split;、then supply;、then produce;,以及步驟 action supply : SupplyFuel 與 action produce : ProduceTorque,每個都有 duration。
  3. 新增流。在行駛循環中新增 flow of Fuel from supply.fuel to produce.fuel;。
  4. 匯合分支。新增 first supply then ready;、first produce then ready;、join ready;、then action drive : DriveWheels { … }、then done; 與 flow produce.torque to drive.torque;。
  5. 建立 Action Flow View。按一下行為 → 動作流程,再按一下 + 新增圖,並在顯示下選擇 DriveCycle。
  6. 指出每個步驟由誰執行。新增 part def DrivenCar,含 perform action trip : DriveCycle; 以及零件 tank、engine 與 transmission,每個分別含 perform trip.supply;、perform trip.produce; 或 perform trip.drive;。檢視會為每個零件加上一條泳道。
  7. 開啟功能分析。按一下行為 → 功能分析,按一下選擇…並挑選 DriveCycle。
  8. 宣告另一個動作。新增 action def EmergencyShutdown;。
  9. 在 FFBD 中建立步驟。按一下行為 → FFBD,再按一下 + 新增圖,並選擇 EmergencyShutdown。在新增面板中輸入 Open Contactors 並按 Enter,接著輸入 Cut Fuel。
  10. 在文字中查看步驟。按一下模型 → 編輯器:FFBD 已寫入這些步驟及其接續。

狀態與轉換

起始專案有套件 PowertrainBehavior,含一個空的 part def Car。

  1. 定義訊號。新增 attribute def StartRequest;,並以相同方式新增 StopRequest、PlugIn 與 Unplug。
  2. 撰寫狀態定義。新增 state def PowertrainStates,含 in attribute charge : Real;、entry; then off; 以及狀態 off、electric 與 hybrid。
  3. 新增轉換。在 state off; 之後新增 accept StartRequest if charge > 20 then electric; 與 accept StartRequest then hybrid;。
  4. 為狀態加上動作。將 state electric; 取代為包含 entry action spinUpMotor;、do action driveElectric; 與 exit action holdMotor; 的本體。
  5. 離開電動狀態。在其後新增 if charge < 15 then hybrid; 與 accept StopRequest then off;;也在 state hybrid; 之後新增 accept StopRequest then off;。
  6. 新增含具名轉換的狀態。新增 state charging { do action chargeBattery; }、transition plugIn first off accept PlugIn then charging; 與 transition unplugged first charging accept Unplug then off;。
  7. 建立 State Transition View。按一下行為 → 狀態機,再按一下 + 新增圖,並在顯示下選擇 PowertrainStates。
  8. 繪製定時轉換。從 charging 的控點拖曳到 off,並放在轉換上。在轉換面板中輸入名稱 charged 與觸發條件 after 30 [min]。
  9. 在文字中查看。按一下模型 → 編輯器:轉換會寫成具名轉換。
  10. 讓車輛展現這些狀態。在 Car 中新增 exhibit state powertrainStates : PowertrainStates;。

需求

起始專案有套件 VehicleRequirements,含設計的小型副本:Battery、Car 以及車隊中整備質量為 1580 kg 的 sedan。

  1. 為限值命名。新增 attribute maxCurbMass : MassValue = 1650 [kg]; 與 attribute minBatteryCapacity : EnergyValue = 1.2 [kW*h];。
  2. 撰寫需求定義。新增 requirement def <'VR-1'> CurbMass,含 doc 陳述、subject car : Car;、attribute limit : MassValue; 與 require constraint { car.curbMass <= limit }。
  3. 插入需求。在空白行上按 ⌃⇧Space / Ctrl+Shift+Space,選擇需求定義,並撰寫 VR-3 BatteryCapacity,含主體 battery : Battery 與 require constraint { battery.capacity >= minBatteryCapacity }。
  4. 將需求巢狀放入規格中。新增 requirement carSpec,含 subject car : Car; 與 requirement <'VR-1.1'> sedanMass : CurbMass { attribute :>> limit = maxCurbMass; }。
  5. 指出由什麼滿足它們。新增 satisfy carSpec by fleet.sedan; 與 satisfy requirement batterySpec : BatteryCapacity by fleet.sedan.battery;。
  6. 破壞一個需求。將轎車的整備質量改為 1700 [kg]。編輯器會標示該 satisfy:轎車不再符合 VR-1.1。
  7. 再次符合需求。按 ⌘Z / Ctrl+Z,或將其改回 1580 [kg]。
  8. 查看需求表格。按一下需要與需求 → 需求。
  9. 建立 Requirement View。在圖頁面上按一下 + 新增圖,選擇需求檢視,並在顯示下選擇 carSpec。
  10. 檢查陳述。按一下需要與需求 → 品質,再按一下檢查品質。

驗證與可追溯性

起始專案有整備質量需求與車輛規格、含步驟 cruise 與 brake 的行駛循環、VR-6 batteryMassLimit 與 VR-7 stopFromCruise。

  1. 撰寫驗證案例。新增 verification def <'VC-1'> CurbMassTest,含 subject car : Car;、objective massObjective { verify carSpec.sedanMass; } 與 return verdict : Boolean = car.curbMass <= maxCurbMass;。
  2. 將其套用到轎車。新增 verification <'VC-1.1'> sedanWeighing : CurbMassTest { subject car = fleet.sedan; }。
  3. 開啟驗證案例。按一下驗證 → 驗證案例。步驟、結果與狀態是模型旁的 Holarch 資料。在 Sedan Weighing 這一列中按一下 + 步驟,再按一下 + 新增步驟,在動作下輸入 Weigh the car,然後按一下套用。接著按一下其狀態按鈕中的通過。
  4. 閱讀 RVTM。按一下驗證 → RVTM。
  5. 將步驟追溯到需求。按一下驗證 → 可追溯性矩陣,以需求為列、動作為欄顯示,按一下 stopFromCruise 與 brake 的儲存格,並選擇 satisfied by。
  6. 衍生需求。新增 private import RequirementDerivation::*; 與 connection batteryMassDerivation : Derivation connect carSpec.sedanMass to batteryMassLimit;。
  7. 執行模型檢查。按一下驗證 → 模型檢查。

約束與計算

起始專案有套件 VehicleAnalysis,含引擎、電池、車輛與轎車的數值,以及目標 maxCurbMass 與 minPowerToWeight。

  1. 撰寫約束定義。新增 constraint def MassLimit,含 in mass : MassValue;、in limit : MassValue; 與運算式 mass <= limit。
  2. 撰寫計算。新增 calc def PowerToWeight,含參數 power 與 mass,以及 return ratio = power / mass;。
  3. 繫結轎車的數值。新增 constraint sedanMassCheck : MassLimit { in mass = fleet.sedan.curbMass; in limit = maxCurbMass; }。
  4. 建立 Parametric View。在圖頁面上按一下 + 新增圖,選擇參數檢視,並在顯示下選擇 VehicleAnalysis。檢查通過:1580 kg 在 1650 kg 以內。
  5. 讓檢查失敗。將轎車的整備質量改為 1700 [kg];檢視會顯示檢查失敗。
  6. 讓它再次通過。復原,或將其改回 1580 [kg]。全部求解會再次檢查每個約束。
  7. 執行分析案例。新增 analysis def PowerToWeightAnalysis,含要求 ratio >= minPowerToWeight 的目標,以及 analysis sedanPowerToWeight : PowerToWeightAnalysis { subject car = fleet.sedan; }。
  8. 標示未定的數值。新增 private import HolarchMetadata::*; 與需求 VR-5 ChargeTime,在其時間限值上加上 #TBR,並在充電器功率上加上含擁有者、到期日與理由的 @TBD。TBD 與 TBR 來自 Holarch 的 HolarchMetadata 庫,而非 SysML v2 標準庫;它們特化標準的 StatusInfo 中繼資料。
  9. 開啟 TBD/TBR 登錄表。按一下需要與需求 → TBD/TBR。充電時間會連同其 @TBD 中繼資料的擁有者與到期日一起列出。登錄表為唯讀:請在編輯器中變更中繼資料裡的擁有者或日期。
  10. 彙總質量。按一下架構 → 預算和 TPM,並選取根零件 sedan。

變體與組態

起始專案有 Component、Battery、Controller、Car 與 Powertrain。

  1. 匯入變異性套件。新增 private import HolarchVariability::*;。
  2. 撰寫變化。在空白行上按 ⌃⇧Space / Ctrl+Shift+Space(或按一下插入 ▾),選擇變化,並以變體 standardPack(1.4 kWh)與 largePack(12 kWh、120 kg)完成 variation part def BatteryPack :> Battery。
  3. 撰寫產品線。新增 part def CarLine :> Car,含 part pack : BatteryPack;、含變體 noCharger 與 wallbox 的 variation part charger,以及 assert constraint wallboxNeedsLargePack { charger == charger::wallbox implies pack == BatteryPack::largePack }。
  4. 開始一個組態。選擇插入 ▾ → 組態並填入 part plugInHybrid : CarLine { @HolarchConfiguration; }。編輯器會註明仍未決定的變化點。
  5. 選擇變體。在 plugInHybrid 中,為每個點選擇插入 ▾ → 變體選擇,並填入 part :>> pack = BatteryPack::largePack; 與 part :>> charger = charger::wallbox;。
  6. 新增第二個組態。以相同方式新增 selfChargingHybrid,使用標準電池組且沒有充電器。
  7. 定義您自己的關鍵字。新增 metadata def <safetyCritical> SafetyCritical。
  8. 使用該關鍵字。在 Powertrain 中撰寫 #safetyCritical part controller : Controller;。
  9. 查看產品線。建立 Vehicles 的 General View:電池組會標示為 variation。

教學專案

SysML v2 教學專案遵循與其他教學專案相同的規則:它們不計入您方案的作用中專案數,最多可容納 300 個項目,每個教學課程可以有一個。請參閱教學課程。

SysML® 與 OMG® 是 Object Management Group, Inc. 在美國及其他國家的註冊商標。