Holarch

SysML v2

SysML v2 文字表示法

Holarch 所支援的 SysML v2 語言,附有 Hybrid Car 示範專案的範例、它執行的檢查,以及唯讀的標準庫。

使用方式 →

本頁內容
  1. 概觀
  2. 概念
    1. 元素、擁有者與限定名稱
    2. 套件
    3. 匯入與可見性
    4. 定義與用法
    5. 類型化、特化與重新定義
    6. 多重性
    7. 值與單位
    8. 結構:埠、連接、介面、繫結與流
    9. 行為:動作
    10. 行為:狀態
    11. 需求、約束與驗證
    12. 使用案例
    13. 檢視
    14. 註解、說明文件與中繼資料
    15. 個體、快照與時間切片
    16. 變化、變體與組態
    17. 文字表示
  3. 使用方式
    1. 為結構建模
    2. 提供含單位的數值
    3. 描述行為
    4. 撰寫需求並追溯
    5. 將數值標示為 TBD 或 TBR
    6. 尋找庫名稱
  4. 實作範例:閱讀轎車的需求
  5. 提示與常見錯誤
  6. Holarch 支援的內容
    1. 依原樣保留,不加解譯
    2. 尚未提供
  7. 檢查
  8. 標準庫
  9. 限制
  10. 相關頁面

概觀

SysML v2 將系統描述為以文字撰寫、由具名元素組成的樹狀結構。Holarch 支援以 OMG SysML v2 規格為基礎的 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 …;針對數值的 Boolean 條件
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;。
  • 在模型中,轉換的觸發條件與效果是各自獨立的元素:一個 accept 動作與一個動作(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):特化該定義的個體定義,以及以它指定類型的個體用法。個體(是)與部分(portion)(快照或時間片段)也是欄(欄 ▾ → SysML v2)。模型有個體之後,零件預設會顯示執行個體,而表格(CSV)匯出也會包含這三欄;定義匯出會為具有這些資訊的每個元素列出它們。
  • 在屬性面板中,特徵下的事件會設定個體,對用法而言則設定整個生命週期、時間片段或快照。瀏覽器的種類篩選有 Individuals,而列的 ⋯ 選單有新增快照…與新增時間片段…。General View 會在方塊標題中顯示 «individual part def»、«snapshot» 與 «timeslice»,在方塊自己的區隔中列出其快照與時間片段,並將方塊之間的接續繪製為虛線箭頭;排列 ▾ → 排列為時間軸會將它們由左至右排列。在 Hybrid Car 示範專案中,General View 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 本體以程式碼方式醒目提示在淡色底上。其他語言則顯示為註解文字。
  • 屬性面板的表示形式區段會列出每個表示及其語言與本體。在定義或用法上按一下新增表示即可新增一個,按一下移除則可刪除一個。
  • Action Flow 檢視會將定義具有表示的動作,以大括號中的語言標示,例如 {Python}。
  • 已知語言:SysML、KerML、OCL、Alf、Python、JavaScript、MATLAB、Modelica、C、自然語言(naturalLanguage、English、text)。名稱後面的版本會被忽略(OCL2.0、Python 3)。
  • 本體不能包含 */,因為那會結束註解。

Holarch 自己的討論留言、標籤、指派對象與到期日都保存在模型旁邊,不會寫入文字中。

使用方式

為結構建模

  1. 在編輯器中開啟一個套件(或按一下 + 新增套件)。
  2. 為每種連接點撰寫 port def,含有方向的特徵(out attribute torque : TorqueValue;)。
  3. 為每種元件撰寫 part def,含其屬性與埠。
  4. 為組件撰寫 part def,為每個元件加上一個 part。
  5. 連接零件:connect a.p to b.q;,或 interface name : Def connect a.p to b.q;。
  6. 暫停輸入。狀態列會顯示已套用,瀏覽器會顯示新元素。

插入 ▾(或 ⌃⇧Space / Ctrl+Shift+Space)會為您撰寫以上每種結構,並提供待填入的欄位。請參閱插入結構。

提供含單位的數值

  1. 在套件頂端匯入量值種類與單位:private import ISQ::*; 與 private import SI::*;。
  2. 以量值種類為屬性指定類型並提供數值:attribute mass : MassValue = 45 [kg];。
  3. 在繼承該屬性的定義中,以其自己的數值重新定義它:attribute redefines mass = 18 [kg];。
  4. 將指標指向數值。如果單位不符合量值種類,會出現錯誤卡片。

描述行為

  1. 撰寫含 in 與 out 參數的 action def。
  2. 為每個 action 用法新增一個步驟,並以 first … then …; 或 then 排序。
  3. 平行步驟使用 fork 與 join,替代路徑使用 decide 與 merge。
  4. 在傳遞項的步驟之間新增 flow of Item from a.out to b.in;。
  5. 在執行該行為的零件中撰寫 perform action name : Def;,並在其零件中撰寫 perform name.step;。
  6. 在 Action Flow View 中開啟該動作即可看到其圖形(請參閱 SysML v2 檢視)。

撰寫需求並追溯

  1. 撰寫 requirement <'ID'> name { doc /* The system shall … */ subject s : Def; }。
  2. 當需求可以對照數值檢查時,新增 require constraint { … }。
  3. 在設計符合需求之處撰寫 satisfy name by somePart;。
  4. 撰寫一個 verification,其目標以 verify 驗證該需求。
  5. 開啟需要與需求 → 需求:需求會連同其編號列出,驗證 → RVTM 則顯示其驗證方式。請參閱 SysML v2 專案中的需求與驗證。

將數值標示為 TBD 或 TBR

以 TBD 取代數值並不是有效的 SysML。請改用 Holarch 的中繼資料。

  1. 匯入它:private import HolarchMetadata::*;。
  2. 為屬性加上前置詞:#TBD attribute chargerPower : PowerValue;(尚無數值)或 #TBR attribute limit : TimeValue = 0.5 [h];(待審查的數值)。
  3. 若要記錄擁有者與理由,請在屬性本體中撰寫完整形式:@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 值會為您撰寫它們。

尋找庫名稱

  1. 從側欄工具開啟標準庫。
  2. 在尋找套件或定義…中輸入名稱的一部分,例如 MassValue。
  3. 按一下該列上的複製名稱。限定名稱(此處為 ISQBase::MassValue)會被複製。
  4. 將它貼到編輯器中,或匯入其套件並使用簡短名稱。

實作範例:閱讀轎車的需求

此範例會在 Hybrid Car 示範專案的文字中追蹤一個需求。

  1. 開啟示範專案,並在編輯器的套件清單中選擇 VehicleRequirements。
  2. 找到 requirement def <'VR-1'> CurbMass。其 require constraint { car.curbMass <= limit } 會將主體的整備質量與 limit 比較。
  3. 找到 requirement carSpec。它包含 requirement <'VR-1.1'> sedanMass : CurbMass { attribute :>> limit = maxCurbMass; }。此用法以套件層級的目標 maxCurbMass = 1650 [kg] 重新定義 limit。
  4. 找到 satisfy carSpec by fleet.sedan;。按住 ⌘ / Ctrl 並按一下 sedan:編輯器會在 part sedan : Car 處開啟 Vehicles,其中 attribute redefines curbMass = 1580 [kg]; 提供了數值。
  5. 回到 VehicleRequirements,找到 verification def CurbMassTest。其目標 verify carSpec.sedanMass; 讓它成為 VR-1.1 的驗證案例,而 verification sedanWeighing : CurbMassTest { subject car = fleet.sedan; } 將它套用到轎車。
  6. 在 Vehicles 中將 1580 [kg] 改為 1700 [kg] 並暫停輸入。轎車現在超過 1650 kg 的限值,編輯器會在 VehicleRequirements 中顯示警告,指出 sedan 未達成該需求,並附上為假的約束及其數值。以 ⌘Z / Ctrl+Z 復原。

提示與常見錯誤

  • “…” is not defined here.(此處未定義「…」。)名稱拼錯,或未匯入其套件。請新增 private import Package::*;,或寫出限定名稱。
  • 缺少 ;。每個宣告都以 ; 或 { … } 本體結尾。The declaration does not end. Add ; or a { … } body.(宣告沒有結尾。請加上 ; 或 { … } 本體。)
  • :> 與 :>> 的差別。使用 :> 進行特化或取子集;使用 :>> 取代繼承的特徵。重新定義非繼承的特徵會出現 “x” is not inherited by “y”.(「y」未繼承「x」。)
  • 單位需要匯入。5 [kg] 只在看得見 SI 的地方才能解析。
  • 兩個成員同名。“x” is already used in this namespace.(「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 會在您輸入時檢查文字。每個問題都會在編輯器的邊欄中標示並加上底線;訊息會先陳述問題,再說明修正方式。錯誤會阻止成員被套用;警告則不會。

領域檢查內容訊息範例
語法字元、註解、字串、大括號、;、預期的名稱與語彙單元This brace has no partner. Add the matching { or }, or delete this one.
名稱無法解析、模稜兩可、無效、重複(警告)與私有的名稱“Batery” is not defined here. Check the spelling, or import its package.
類型化與特化循環;以正確種類的定義指定類型與特化;取子集與重新定義特徵;只能重新定義繼承的特徵“capacity” is not inherited by “Car”. Specialize its type, or subset it with :> instead.
多重性有效且為整數的界限;重新定義不得比被重新定義者更寬Multiplicity [3..1] is not valid. Use a lower bound from 0 up to the upper bound.
單位與數值相符的因次、缺少的單位、單位名稱、數字類型The units do not match: kg and s. Convert one side to a compatible unit.
運算式語法、運算元類型、計算引數、Boolean 條件The condition must be true or false; it is a number. Write a comparison such as x > 0.
結構連接端點為特徵、介面連接埠、埠、流與訊息的方向、流的項類型、繫結類型These port directions do not fit together. Conjugate one port (~) or change a direction.
動作同一本體中動作之間的接續、控制節點的輸入/輸出數、決策防護條件與 else、start 與 done、指派、perform 目標、for 迴圈所迭代的數值與迴圈變數類型的比對then needs an earlier action. Add an action or first … then ….
狀態同一本體中狀態之間的轉換、各一個 entry/do/exit、初始轉換、平行區域、exhibit 目標、轉換的 do 效果(send 給可以接收的對象、assign、accept、action 或具名動作)、觸發條件的酬載與其埠之項的比對、針對 Real 等單純庫數值的觸發條件(警告)、命名時間的 at 觸發條件“electric” has substates but no initial transition, so none of them is entered. Add entry; then <first state>;.
需求、案例與檢視成員位於正確位置、單一主體、satisfy/verify/require 目標、主體類型、expose 與 import 目標、frame 目標verify belongs in the objective of a verification case. Move it into objective { … }.
文字表示SysML 與 KerML 本體可以剖析,並宣告其所表示的元素;未知語言會被註明The representation of “SpeedLimit” declares a part definition, not a constraint definition. Make the body declare “SpeedLimit” itself.
個體、快照與時間切片individual 只用於事件,且剛好有一個個體定義;snapshot/timeslice 只用於事件中的事件用法;快照中的時間片段(警告)“parked” is individual, but none of its definitions is. Type it by an individual definition, or remove individual.
變異性變化只擁有變體;變體位於變化中且屬於其種類;選擇是其點的變體;變化上的 abstract 為多餘(註記);組態的未決定點(註記)“compact” is not a variant of “pack”. Choose one of: standardPack, largePack.
使用者定義的關鍵字#Name 命名中繼資料定義;不含語言關鍵字的宣告使用語意中繼資料(警告);中繼資料只標示其 annotatedElement 允許的種類;語意基底類型是定義或用法、符合其所標示的元素(警告)且不形成循環“safetyCritical” applies to PartDefinition, not to “invert” (ActionUsage). Move it, or remove it.
中繼資料值使用者定義中繼資料定義的每個必要特徵都有數值(警告);每個數值與預設值都符合其特徵的類型(Boolean、String、整數、列舉);定義的約束對所提供的數值成立;中繼資料本體只重新定義定義的特徵;抽象中繼資料定義不會被套用;以 about 撰寫的語意中繼資料(警告)The values of “SafetyRating” break its constraint levelRange: level >= 1 and level <= 4. Change the values.
計算對目前數值不成立的約束、需求與目標“sedanMass” is not met by “sedan”: … is false (…). Change the design values or the requirement.

標準庫

標準庫頁面會列出每個 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. 在美國及其他國家的註冊商標。