ガイド · 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 のテキストは要素を名前で参照するため、名前のない要素を指す関係は書けません。トレース先の要素には、今のうちに v1 ツールで名前を付けてください。
- サイズ。Holarch は一度に最大 64 MB、250,000 要素までのファイルを一つ変換します。それより大きなモデルは、パッケージごとにエクスポートします。
2. SysML v1 ツールからモデルをエクスポートする
コンバーターは、SysML v1 ツールが書き出す交換形式である XMI からモデルを読み込みます。エクスポートの方法はツールごとに少しずつ異なります。
| ツール | インポートするもの |
|---|---|
| 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 の要素 |
|---|---|
| 型 | 単位 W を持つ値型 Power、ブロック Charge、二つの出力フロープロパティ charge(Charge)と voltage(Real)を持つインターフェースブロック Power Interface |
| 構造 | パートプロパティ battery と computer、120 W の値プロパティ power budget、それらのポート間のコネクター power bus、その上の Charge のアイテムフロー power flow を持つカプセル化ブロック Rover。プロキシポート 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として保持します。satisfy 関係は満たすパートを所有するブロックの中に置かれ、derive 関係は導出コネクションになり、トレースはSysMLv1Library::TraceDataを持つ依存関係になります。 - ユーザーステレオタイプ。«Hardware» はパッケージ
'SysML v1 Profiles'の中のmetadata defになり、タグ付き値とともに各ブロックに適用されます。二つの適用は近似としてレポートされます。タグの値は、プロファイルでの型にかかわらずテキスト属性になったからです。 - 関連。クラスを持たない関連には、ここでは SysML v2 に対応するものがなく、関連に所有されたその端も変換されません。どちらも除外としてレポートされます。構造はブロックのプロパティが担います。
このモデルのレポート:31 要素、変換 27、近似 2、除外 2。テキストはエラーも警告もなくチェックを通過します。'power budget' や 'out'(SysML v2 のキーワード)のように単純な識別子でない名前は、v1 の綴りを保つために引用符で囲まれます。
5. 近似または除外されたものを手直しする
レポートの近似と除外の行を、理由ごとに確認します。ほとんどの理由は、いくつかの決定のどれかを求めています。
| レポートの記載 | 決めること |
|---|---|
| ポートがインターフェースブロックではないブロックで型付けされている。型のないポートになった | 境界を越えるフィーチャーを持つポート定義を定義し、ポートをそれで型付けします。 |
| 選択、ジャンクション、フォーク、ジョインを経由する遷移。経路ごとに一つの遷移になった | 結合されたガードが、v1 のダイアグラムの意図をまだ表しているか確認します。経路が読みやすくなった箇所は単純化します。 |
| トリガーはドキュメントとして保持されている | 意味が明確な場合は、変化トリガーと時間トリガーを、期間に対する accept after のような SysML v2 のトリガーに書き直します。 |
| 単位が Holarch が対応付ける SI 単位ではない。値型は実数 | 標準の量が合うかどうか、または実数と記録された単位のままにするかを決めます。 |
| 呼び出し、オペーク、受理以外の種類のアクションは単純なアクションになった | 送信やその他の特定のアクションを、同じことを行う SysML v2 のアクションで書き直します。 |
| アクティビティパーティションは変換されない | スイムレーンの代わりに、パートの中の perform で、どのパートが何を行うかを示します。 |
| 名前のない要素を参照している | v1 ツールで参照先に名前を付けて再変換するか、v2 モデルに関係を追加します。 |
| 同じ場所で名前が二度使われている。接尾辞を付けて名前を変更した | それぞれの要素に、それが何であるかを示す名前を付けます。 |
| タグ付き値はメタデータのテキスト属性になった | メタデータの属性に必要な型を与え、各ステレオタイプが今は何を意味するかを合意します。 |
きれいに変換された場合でも、二種類のテキストは確認が必要です。オペークのボディは、language "OCL" /* … */ のように元の言語のままテキスト表現として保持されます。Holarch がチェックするのは SysML または KerML で書かれたボディだけなので、モデルで評価させたいガードや制約は SysML の式に書き直してください。また、直訳では v1 の回避策が残ります。値を設定するためだけに作ったプロパティ固有の型などです。SysML v2 では、これらは使用の単純な再定義になります。よくあるものは考え直すべきことに一覧しています。
6. 重要なビューを作り直す
ダイアグラムとそのレイアウトは変換されません。ステップ 1 のダイアグラムの一覧を使い、まだ必要なものごとにビューを作成します。構造と要求にはGeneral View、パートとコネクションには Interconnection View、アクティビティには Action Flow ビュー、ステートマシンには状態遷移ビューです。作り直すのは使われているものだけにします。それ以外はいずれにせよモデルが保持しています。ビューのリファレンスを参照してください。
7. v2 モデルをチェックし、レビューする
- テキストがきれいにチェックを通過する。インポートでは、何かが変わる前に変換後のテキストのチェックが表示されます。手直しの後は、エディターが入力中に新しい問題をマークします。
- 数が一致する。v1 モデルと v2 モデルでいくつかの数を比べます。要求、パート、ポート、コネクション、検証関係です。レポートから説明できない差は確認する価値があります。
- モデルを使う人がレビューする。パイロットパッケージを担当者と一緒に確認します。近似された要素と作り直したビューから始めます。
- 決定を記録する。ポート、トリガー、単位、ステレオタイプについて決めたモデリングパターンを書き留め、移行の残りがそれに従うようにします。
8. 残りを変換して切り替える
残りのパッケージを一つずつ、同じ SysML v2 プロジェクトに変換します。どのインポートでも同じプレビューが表示されます。プロジェクトにすでにあるパッケージは変更済みまたは変更なし、新しいパッケージは新規と表示され、インポートするパッケージを選びます。各インポートは元に戻す操作 1 回分です。
v2 モデルのレビューが終わるまでは v1 モデルを基準として残し、その後 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 はこれらの所有者と提携しておらず、推奨も受けていません。