指南 · SysML v2
將 SysML v1 模型移轉到 SysML v2:逐步遷移
SysML v1 模型可以自動轉換為 SysML v2,但遷移不只是檔案轉換:必須有人決定轉換後的模型應該是什麼樣子,並檢查它是否仍表達了 v1 模型所表達的內容。本指南以八個步驟逐步說明一次遷移,從盤點 v1 模型到正式切換,並轉換一個小型模型、逐行閱讀。
本頁內容
開始之前:這是翻譯,不是升級
SysML v2 是一種新語言,而不是 SysML v1 檔案格式的新版本。區塊變成零件定義,埠由埠定義指定型別,需求帶有條件,而圖則變成由模型定義的檢視。SysML v1 與 v2 逐一說明這些差異。
轉換器負責機械性的部分:每個在 SysML v2 中有對應的元素都會以 SysML v2 寫出,其餘的則會被回報。轉換器無法做的,是決定您的團隊想如何使用新語言。請將遷移規劃為一項建模任務,要有負責人、審查,以及 v2 模型成為參考依據的時間點。
本指南使用 Holarch 的轉換器,它會將 SysML 1.x 模型匯入 SysML v2 專案,並將每個元素回報為 已轉換、已近似 或 已省略。無論您使用哪種轉換器,規劃步驟都適用。
1. 盤點 v1 模型
在匯出任何東西之前,先弄清楚模型包含什麼,以及誰依賴它。一份簡短的清單可以省下日後的重做。
- 套件與負責人。列出最上層的套件、各由誰維護,以及哪些套件被其他模型或文件引用。套件是您轉換與審查的單位。
- 重要的圖。記下大家在審查與文件中實際使用的圖。圖的版面配置不會帶到 SysML v2,因此這些圖會變成需要重建的檢視。
- 設定檔與構造型。列出您自己的構造型及其標記值。它們會變成中繼資料定義,而它們在新模型中的意義必須重新議定。
- 以程式碼撰寫的行為。以 OCL、動作語言或工具腳本撰寫的不透明行為、防護條件與約束,會以其原始語言保留為文字;它們不會被翻譯。
- 未命名的元素。指向沒有名稱之元素的關係,無法以 SysML v2 文字撰寫,因為 SysML v2 文字以名稱引用元素。現在就在 v1 工具中為您要追溯的元素命名。
- 大小。Holarch 一次轉換一個最多 64 MB、250,000 個元素的檔案。較大的模型一次匯出一個套件。
2. 從 SysML v1 工具匯出模型
轉換器從 XMI 讀取模型,這是 SysML v1 工具所寫出的交換格式。每個工具的匯出方式略有不同:
| 工具 | 要匯入的內容 |
|---|---|
| Cameo Systems Modeler、MagicDraw | .mdzip 專案檔,或使用 File → Export To → Eclipse UML2 (v5.x) XMI File 產生的 .xmi 檔案 |
| Enterprise Architect | 選取套件,使用 Publish → Export XML,選擇 XMI 2.1,然後匯入 .xml 檔案。專案檔(.eap、.qea)無法直接讀取。 |
| IBM Rhapsody | 從 XMI 工具組匯出的 XMI 2.x |
| Eclipse Papyrus | 模型的 .uml 檔案 |
將匯出的檔案與遷移紀錄一起保存:它正是您的審查所依據的 v1 輸入。
3. 轉換試行套件
從一個具代表性但不是最大的套件開始:一個包含結構、介面、一些行為及其需求的子系統。試行會在您讓整個團隊投入之前,先顯示您的模型轉換後的樣子。
- 建立一個 SysML v2 專案,或開啟轉換後的模型要放入的專案,然後按一下 模型 → 匯入和匯出。
- 在 匯入 下,試行時選擇 匯入到新的 SysML v2 專案,這樣其他內容都不會受到影響。
- 將匯出的檔案拖放到方框上。進度卡片會顯示各階段:讀取 XMI 檔案、轉換為 SysML v2、檢查結果。
此時還沒有匯入任何內容。下一個畫面是附有轉換報告的預覽。
4. 閱讀轉換報告
預覽頂端的 從 SysML v1 轉換 會列出已轉換、已近似與已省略的元素數量,以及 SysML v2 文字的檢查是否沒有問題。v1 模型的每個元素都有一個結果:
- 已轉換:該元素在 SysML v2 中有直接的對應,例如變成
part def的區塊。 - 已近似:該元素以改變後的形式保留,例如經過選擇節點的轉移,變成每條路徑各一個轉移。這些是意義可能與 v1 模型不同的地方。
- 已省略:SysML v2 中沒有對應,或該元素指向檔案中不存在的內容。
使用 顯示 列出已近似與已省略的元素。每一列提供元素、其 SysML v1 種類、它變成了什麼及其 SysML v2 名稱,以及原因。開啟 顯示 SysML v2 文字 閱讀結果,並按一下 下載報告 將報告保存為 CSV 檔案。這個 CSV 就是步驟 5 的工作清單:依原因排序,並為每一組指定負責人。
完整範例:一個小型探測車模型
一個行星探測車電源路徑的小型 SysML v1 模型,分為三個套件:
| 套件 | SysML v1 元素 |
|---|---|
| Types | 一個單位為 W 的值型別 Power;一個區塊 Charge;一個介面區塊 Power Interface,具有兩個向外的流動屬性 charge(一個 Charge)與 voltage(一個 Real) |
| 結構 | 一個封裝區塊 Rover,具有零件屬性 battery 與 computer、值為 120 W 的值屬性 power budget、連接兩者埠的連接器 power bus,以及其上 Charge 的項目流 power flow。一個具有代理埠 out 的區塊 Battery;一個具有共軛代理埠 in 與完整埠 raw 的區塊 Computer。兩者都帶有使用者構造型 «Hardware» 及其標記值。一個關聯,其端點由該關聯擁有。 |
| 需求 | 需求 R-1 Mission 與 R-2 Power Margin;R-2 衍生自 R-1;R-2 由 battery 零件滿足;一條從 Computer 到 Battery 的追溯 |
轉換後的內容如下。清單是轉換器的輸出,未經修改:
package 'Rover Model' {
package Types {
attribute def Power :> ISQ::PowerValue;
part def Charge;
port def 'Power Interface' {
out item charge : Charge;
out attribute voltage : ScalarValues::Real;
}
}
package Structure {
part def Rover {
doc /* Six-wheeled science rover. */
@SysMLv1Library::BlockData { isEncapsulated = true; }
part battery : Battery;
part computer : Computer;
attribute 'power budget' : Types::Power = 120 [SI::W];
connection 'power bus' connect battery.'out' to computer.'in';
satisfy Requirements::'Power Margin' by battery;
flow 'power flow' of Types::Charge from battery.'out' to computer.'in';
}
part def Battery {
@'SysML v1 Profiles'::rov::Hardware { qualified = "true"; vendor = "Acme Cells"; }
port 'out' : Types::'Power Interface';
attribute capacity : Types::Power;
}
part def Computer {
@'SysML v1 Profiles'::rov::Hardware { vendor = "Orbital Logic"; }
port 'in' : ~Types::'Power Interface';
part raw : Types::Charge {
@SysMLv1Library::PortData { isFullPort = true; }
}
}
}
package Requirements {
requirement <'R-1'> Mission {
doc /* The rover shall explore the landing site. */
}
requirement <'R-2'> 'Power Margin' {
doc /* Keep a 50 % power margin. */
}
connection : DerivationConnections::Derivation connect 'Power Margin' to Mission;
dependency from Structure::Computer to Structure::Battery {
@SysMLv1Library::TraceData { isTrace = true; }
}
}
}
package 'SysML v1 Profiles' {
package rov {
metadata def Hardware {
attribute qualified : ScalarValues::String;
attribute vendor : ScalarValues::String;
}
}
}
v1 模型各部分的轉換結果:
- 帶有單位的值型別。以瓦特為單位的 Power 特化了標準庫的
ISQ::PowerValue,預設值連同其單位寫出:120 [SI::W]。單位不是已對應之 SI 單位的值型別會保持為實數,單位寫在其文件說明中,並回報為已近似。 - 區塊與屬性。區塊變成
part def,零件屬性變成part。區塊的 isEncapsulated 在 SysML v2 中沒有關鍵字,因此保留為SysMLv1Library::BlockData中繼資料。 - 介面區塊與埠。介面區塊變成
port def,其流動屬性是有方向的特徵:區塊型別的那一個為out item,值的那一個為out attribute。共軛代理埠的型別為~Types::'Power Interface'。完整埠則變成帶有SysMLv1Library::PortData中繼資料的零件,因為 SysML v2 的埠是由埠定義指定型別的。 - 連接器與項目流。連接器變成兩個埠之間的
connection,其上的項目流則變成相同兩個埠之間 Charge 的flow。 - 需求。每項需求以短名稱保留其 id,即
<'R-1'>,並以doc保留其文字。滿足關係位於擁有該滿足零件的區塊中;衍生關係變成衍生連接;追溯則變成帶有SysMLv1Library::TraceData的相依。 - 使用者構造型。«Hardware» 變成套件
'SysML v1 Profiles'中的metadata def,連同其標記值套用到每個區塊。它的兩次套用回報為 已近似:無論標記值在設定檔中是什麼型別,都變成了文字屬性。 - 關聯。沒有類別的關聯在這裡沒有 SysML v2 對應,而由關聯擁有的端點也不會被轉換。兩者都回報為 已省略;結構由區塊上的屬性承載。
此模型的報告:31 個元素,27 個已轉換、2 個已近似、2 個已省略,文字檢查沒有錯誤也沒有警告。不是單純識別碼的名稱,例如 'power budget' 或 'out'(SysML v2 關鍵字),會加上引號,以保留其 v1 的拼寫。
5. 重做被近似或被省略的部分
依原因逐一檢視報告中已近似與已省略的列。大多數原因只需要以下幾種決定之一:
| 報告內容 | 要決定的事項 |
|---|---|
| 埠的型別是不是介面區塊的區塊;它變成了沒有型別的埠 | 定義一個具有跨越邊界之特徵的埠定義,並以它指定埠的型別。 |
| 經過選擇、接合、分叉或結合節點的轉移;每條路徑變成一個轉移 | 檢查合併後的防護條件是否仍表達 v1 圖的原意;在路徑現在更容易閱讀之處加以簡化。 |
| 觸發條件保留為文件說明 | 在意義明確之處,將變更觸發與時間觸發改寫為 SysML v2 觸發,例如在一段持續時間之後 accept after。 |
| 單位不是 Holarch 會對應的 SI 單位;值型別為實數 | 決定是否適合使用標準量,或保留實數與文件中記載的單位。 |
| 呼叫、不透明或接受動作以外的動作種類變成了一般動作 | 以功能相同的 SysML v2 動作改寫傳送及其他特定動作。 |
| 活動分割區不會被轉換 | 在零件中以 perform 說明哪個零件做什麼,而不是使用泳道。 |
| 它指向一個沒有名稱的元素 | 在 v1 工具中為目標命名並重新轉換,或在 v2 模型中加入該關係。 |
| 其名稱在同一處使用了兩次;已加上後綴重新命名 | 為每個元素取一個說明它是什麼的名稱。 |
| 標記值變成了中繼資料的文字屬性 | 為中繼資料屬性指定所需的型別,並議定每個構造型現在的意義。 |
即使轉換得很順利,有兩類文字仍需要檢查。不透明主體會以其原始語言保留為文字表示,例如 language "OCL" /* … */;Holarch 只檢查以 SysML 或 KerML 撰寫的主體,因此在模型應該評估的地方,請將防護條件或約束改寫為 SysML 運算式。而逐字轉換會保留 v1 的變通做法,例如只為了設定某個值而建立的屬性專用型別:在 SysML v2 中,這些只是用法上的一般重新定義。需要重新思考的部分 列出了常見的情況。
6. 重建重要的檢視
圖及其版面配置不會被轉換。取出步驟 1 中的圖清單,為仍然需要的每張圖建立一個檢視:結構與需求用一般檢視,零件與連接用互連檢視,活動用動作流程檢視,狀態機用狀態轉換檢視。只重建大家會使用的部分;無論如何,其他所有內容都保存在模型中。請參閱 檢視參考資料。
7. 檢查並審查 v2 模型
- 文字檢查沒有問題。匯入會在任何內容變更之前顯示轉換後文字的檢查結果;在您重做之後,編輯器會在您輸入時標示任何新的問題。
- 數量相符。比較 v1 模型與 v2 模型之間的幾個數字:需求、零件、埠、連接、驗證關係。無法從報告解釋的差異值得查看。
- 由使用模型的人審查。與試行套件的負責人一起逐一檢視,從已近似的元素與重建的檢視開始。
- 記錄決定。寫下您為埠、觸發、單位與構造型所確定的建模模式,讓遷移的其餘部分都遵循它們。
8. 轉換其餘部分並正式切換
一次一個套件,將其餘套件轉換到同一個 SysML v2 專案中。每次匯入都會顯示相同的預覽:專案中已存在的套件顯示為 已變更 或 未變更,新的套件顯示為 新增,由您選擇要匯入哪些套件。每次匯入都是一個復原步驟。
在 v2 模型經過審查之前,保留 v1 模型作為參考依據,然後將其凍結,讓 SysML v2 專案成為正式的模型。從那時起,變更只進入 v2 模型。
遷移檢查清單
- 已列出套件、負責人與重要的圖。
- 關係所指向的元素都有名稱。
- 匯出的 XMI 檔案已與遷移紀錄一起保存。
- 已轉換一個試行套件、下載其報告,且每個已近似與已省略的列都有決定。
- 已寫下埠、觸發、單位與構造型的建模模式。
- 已重建需要的檢視;文字檢查沒有問題。
- 模型的使用者已審查試行成果。
- 其餘套件已以相同方式轉換,v1 模型已凍結。
下一步
- Holarch 中的 SysML v1 到 SysML v2:轉換器讀取與寫出的內容,以及 CubeSat EO-1 範例。
- 匯入 SysML v1 模型:說明文件中的每個步驟、對應、限制與訊息。
- SysML v1 與 v2:兩種語言的差異。
- SysML v2 教學:以文字表示法建立模型。
- SysML v2 語言涵蓋範圍:SysML v2 專案支援的內容與已知的缺口。
Cameo Systems Modeler、MagicDraw、Enterprise Architect、Rhapsody 與 Eclipse Papyrus 是其各自擁有者的商標。Holarch 與它們沒有關聯,也未獲得它們的背書。