ガイド · SysML v2
SysML v1 と v2:二つの言語の違い
このガイドを聴く(英語音声) 20 min
SysML v1 と SysML v2 は目的と多くの名前を共有していますが、SysML v2 は改訂版ではなく新しい言語です。このガイドでは二つを並べて比較します。基盤、定義と使用、テキスト表記、単位、ポート、振る舞い、要求、ビュー、API、そして v1 から v2 への移行に何が伴うかです。
このページの内容
概要
SysML v1 を知っている読者は、SysML v2 のほとんどの概念に見覚えがあるはずです。変わったのは、それらの構成のされ方と定義の厳密さです。表は比較の要約で、各行には下に専用のセクションがあります。
| トピック | SysML v1 | SysML v2 |
|---|---|---|
| 基盤 | UML 2 のプロファイル:UML メタクラスのサブセットにステレオタイプを付ける | Kernel Modeling Language(KerML)上の独自のメタモデル。セマンティクスは形式的なライブラリで定義される |
| 構造 | パートプロパティ、参照プロパティ、値プロパティを持つブロック | あらゆる種類の要素に定義と使用:part def と part、port def と port など |
| 表記 | グラフィカル(九種類のダイアグラム)。モデル全体の標準テキストはない | 同じモデルに対する標準のテキスト表記と標準のグラフィカル表記 |
| 量と単位 | 単位付きの値型(単位モデルとモデルライブラリによる) | 標準ライブラリの ISQ の量と SI 単位を、6.5 [kg] のように値で直接使う |
| インターフェース | フルポートとプロキシポート、インターフェースブロック、フロープロパティ、コネクター上のアイテムフロー | 方向付きフィーチャーを持つポート定義、共役 ~、型付きの端を持つインターフェース定義、フローとバインディング |
| 振る舞い | UML 由来のアクティビティ、ステートマシン、インタラクション。割り当てで構造にリンクされる | オカレンスとしてのアクション、状態、メッセージ。perform と exhibit で構造にリンクされる |
| 要求 | ID とテキストを持つステレオタイプ付きクラス。制約は別に制約ブロックに置かれる | 要求は主題を持つ制約。テキストと確認可能な条件が一つの要素にある |
| 検証 | verify でリンクされたテストケース | 目的と判定を持つ検証ケース |
| ダイアグラム | ツールが保持する図面。レイアウトがツール間で移ることはまれ | ビューは何を表示するかを記述するモデル要素。描画はツールが行う |
| 交換 | XMI ファイル(ツールごとに差異がある) | テキストファイル、JSON、標準の Systems Modeling API |
基盤:UML プロファイルと KerML
SysML v1 は UML 2 のプロファイルとして定義されています。UML のサブセットを取り、ステレオタイプを加えます。ブロックは «block» ステレオタイプの付いた UML クラス、要求は «requirement» の付いたクラス、フロープロパティは «flowProperty» の付いたプロパティです。UML ツールがホストできたため SysML v1 はすぐに採用されましたが、システムの概念がソフトウェアの概念に合わせて曲げられ、多くの構成要素の意味が、ソフトウェア向けに書かれた UML のセマンティクスから来ることにもなりました。
SysML v2 は UML の基盤を捨てました。Kernel Modeling Language(KerML)の上に構築されています。KerML はより小さな言語で、その中核は KerML モデルのライブラリによって厳密な意味を与えられています。SysML v2 はその上にシステムズエンジニアリングの概念を加えます。パート、ポート、アクション、状態、要求、ケース、ビューです。SysML v2 のすべての構成要素は、そのライブラリの何かの特化として定義されています。実際には次のことを意味します。
- 構造と振る舞いが一つの基盤を共有します。パートとアクションはどちらも時間とともに存在するオカレンスなので、パートは別の割り当て層なしにアクションを実行したり状態を示したりできます。
- 意味が各ツールの解釈ではなく仕様とそのライブラリにあるため、モデルの意味についてツール間の一致度が高まります。
- ステレオタイプはもう拡張の仕組みではありません。SysML v2 では、ツール固有やドメイン固有の注釈にメタデータ定義を使います。
ブロックとプロパティに代わる定義と使用
SysML v1 ではブロックが中心的な要素です。ブロック定義図がブロックを定義し、内部ブロック図が一つのブロックのパートを示します。パートプロパティはブロックで型付けされ、値プロパティは値型で型付けされます。一つのパートにブロックの既定値と異なる値を与える(たとえば、ある製品バリアントでより重いポンプを使う)には回避策が必要です。プロパティを再定義する特化ブロック、プロパティ固有の型、インスタンス仕様のいずれかです。
SysML v2 はこれを、すべての要素に共通する一つのパターンに一般化します。定義はある種類のものが何であるかを述べ、使用はある文脈の中のそのようなものです。使用は入れ子になり、入れ子の使用は継承したものを独自の値で再定義できます。同じパターンが、属性、ポート、アクション、状態、要求、ビューにも当てはまります。
package CoolingLoop {
doc /* The engine cooling loop of a small generator set. */
private import ScalarValues::*;
private import ISQ::*;
private import SI::*;
part def Pump {
attribute mass : MassValue;
attribute shaftPower : PowerValue;
}
part def ElectricPump :> Pump {
attribute supplyVoltage : ElectricPotentialValue;
}
part def Radiator {
attribute mass : MassValue;
attribute heatRejection : PowerValue;
}
part def CoolingSystem {
part pump : ElectricPump {
attribute redefines mass = 2.4 [kg];
attribute redefines shaftPower = 150 [W];
attribute redefines supplyVoltage = 24 [V];
}
part radiator : Radiator {
:>> mass = 6.5 [kg];
:>> heatRejection = 18 [kW];
}
attribute totalMass : MassValue = pump.mass + radiator.mass;
}
}
| SysML v1 | このリストの SysML v2 |
|---|---|
値プロパティを持つブロック Pump | 属性を持つ part def Pump |
ElectricPump から Pump への汎化 | 特化 part def ElectricPump :> Pump |
CoolingSystem のパートプロパティ pump(ブロックで型付け) | パート使用 part pump : ElectricPump |
| 特化ブロックやインスタンスによる文脈固有の値 | 使用に直接書く attribute redefines mass = 2.4 [kg] |
| 制約ブロックとパラメトリック図による導出値 | 属性上の式としての totalMass |
:>> は redefines の短縮形です。v1 の参照プロパティ(ほかの場所で所有されているパートを指すもの)は、v2 では ref 使用になります。
標準のテキスト表記
SysML v1 には、モデル全体の標準のテキスト形式がありません。モデルはツールのリポジトリにあり、人はダイアグラムで作業し、ファイルは XMI としてツール間を移動します。XMI は機械向けであり、読むためのものではありません。テキストが現れるのは一部の場所だけです。制約式、オペークビヘイビア、一部のツールのアクション言語です。
SysML v2 には、グラフィカル表記と並んで、言語全体をカバーするテキスト表記があります。どちらも同じモデルを表します。このページのすべてのリストはそのテキスト表記です。SysML v2 チュートリアルでは、それを使って完全なモデルを一歩ずつ作ります。テキストはチームの作業方法を変えます。
- モデルを一行ずつレビューし、diff で比較し、ほかのエンジニアリングデータとともにバージョン管理できます。
- エンジニアはモデルを素早く入力し、モデル間でパターンをコピーし、モデルの一部をスクリプトで生成できます。
- モデルをソースコードのようにチェックできます。解決できない名前、誤った単位、合わないポートが、発生した場所で報告されます。
テキスト表記はダイアグラムを置き換えるものではありません。モデルを主要な成果物にし、ダイアグラムは後述のとおりそのビューになります。
標準ライブラリ、量、単位
SysML v1 は値プロパティを値型で型付けし、値型は単位と量の種類を持つことができます。仕様には量と単位のモデルと、一般的な単位のモデルライブラリが含まれていますが、どのライブラリを同梱し、式の中の単位をどこまでチェックするかはツールによって異なります。
SysML v2 は言語の一部として標準ライブラリを同梱しています。国際量体系(ISQ)、SI 単位(SI)、米国慣用単位、スカラー型、コレクション、標準のビュー定義が含まれます。上のリストでは次のとおりです。
attribute mass : MassValueは、属性が数値ではなく質量であることを述べています。6.5 [kg]は量の値です。単位付きの数値をインラインで書いたものです。pump.mass + radiator.massは二つの質量を足しています。単位を評価するツールは、質量と電力を足す式や、ボルトで与えられた質量を拒否できます。
ポート、インターフェース、コネクション
SysML v1 のポートは何度か設計が変わりました。初期のバージョンには標準ポートとフローポートがあり、後のバージョンではそれらがフルポート、プロキシポート、フロープロパティを持つインターフェースブロックに置き換えられました。フロープロパティには方向(in、out、inout)があり、ポートを共役にすると方向が反転し、コネクター上のアイテムフローが何が移動するかを述べます。既存の v1 モデルの多くは、今も古いポートと新しいポートを混在させています。
SysML v2 は考え方を引き継ぎ、それを統一しています。ポート定義は方向付きフィーチャーを一覧し、受信側は同じ定義の共役 ~ を使い、インターフェース定義は型付きの端を持つ接続の種類を記述します。
package CoolantInterfaces {
private import ISQ::*;
item def Coolant {
attribute temperature : ThermodynamicTemperatureValue;
}
port def CoolantPort {
out item coolant : Coolant;
}
interface def Hose {
end supply : CoolantPort;
end ret : ~CoolantPort;
}
part def Pump {
port outlet : CoolantPort;
}
part def Radiator {
port inlet : ~CoolantPort;
}
part def Loop {
part pump : Pump;
part radiator : Radiator;
interface hose : Hose connect pump.outlet to radiator.inlet;
}
}
| SysML v1 | SysML v2 |
|---|---|
| フロープロパティを持つインターフェースブロック | in、out、inout のフィーチャーを持つ port def |
| インターフェースブロックで型付けされたプロキシポートまたはフルポート | ポート定義で型付けされた port 使用 |
| 共役ポートの型 | ~CoolantPort |
| コネクター(関連ブロックで型付けすることもできる) | connect … to …、または interface def で型付けされた interface 使用 |
| バインディングコネクター | bind a = b |
| コネクター上のアイテムフロー | flow 使用、またはポートのアイテムフィーチャー |
方向が定義の一部なので、接続の両端が同じフィーチャーを送信し、どちらも受信しない場合に、チェッカーが警告できます。
Loop を、内部ブロック図に相当する SysML v2 の Interconnection View で表示したもの。振る舞い:アクションと状態
SysML v1 は振る舞いを UML から借りています。トークンフローのセマンティクスを持つアクティビティ、ステートマシン、シーケンス図のためのインタラクションです。振る舞いは、それを実行する構造に割り当てによってリンクされ、アクティビティパーティション(スイムレーン)や «allocate» 関係がよく使われます。
SysML v2 では、アクションと状態はパートと同じくオカレンスです。アクション定義には入力パラメーターと出力パラメーターがあり、サクセッション(first … then …)が順序を、フローがステップ間で何が渡されるかを示します。状態定義には、状態と、トリガー、ガード、エフェクトを持つ遷移があります。パートはアクションを perform し、状態を exhibit するので、構造へのリンクは追加の関係ではなく言語の一部です。
package PumpBehavior {
private import ISQ::*;
item def StartCommand;
item def StopCommand;
item def Coolant;
action def Circulate {
in item cold : Coolant;
out item warm : Coolant;
}
action def CoolEngine {
action pumpCoolant : Circulate;
action rejectHeat : Circulate;
flow pumpCoolant.warm to rejectHeat.cold;
first start then pumpCoolant;
first pumpCoolant then rejectHeat;
first rejectHeat then done;
}
state def PumpModes {
entry; then off;
state off;
state running;
transition first off accept StartCommand then running;
transition first running accept StopCommand then off;
}
part def Pump {
exhibit state modes : PumpModes;
}
}
| SysML v1 | SysML v2 |
|---|---|
| アクション、制御フロー、オブジェクトフローを持つアクティビティ | アクション使用、サクセッション、flow を持つ action def |
| フォーク、ジョイン、デシジョン、マージの各ノード | fork、join、decide、merge |
| 呼び出しビヘイビアアクション | 別のアクション定義で型付けされたアクション使用 |
| アクティビティからブロックへのパーティションまたは «allocate» | パートの中の perform |
| ブロックが所有するステートマシン | state def と、パートの中の exhibit state |
| トリガー、ガード、エフェクトを持つ遷移 | transition … accept … if … do … then … |
| インタラクション(シーケンス図) | message を持つオカレンス(シーケンスビューで表示) |
PumpModes。要求と検証ケース
SysML v1 の要求は、ID とテキストという二つの文字列を持つステレオタイプ付きクラスです。関係がそれをモデルの残りにつなぎます。satisfy、verify、derive、refine、trace、copy です。テストケースは «testCase» が付いた振る舞いです。数値で要求を確認するには、パラメトリック図の中に別の制約ブロックが必要で、言語の中にその制約を要求のテキストと結びつけるものはありません。
SysML v2 では、要求定義は制約定義の一種です。主題(要求が何についてのものか)を持ち、上限値などの属性を持つことができ、成り立たなければならない条件を含みます。doc のテキストと条件は一つの要素にあります。検証ケースは、検証する要求を目的の中で述べ、判定を返します。
package CoolingRequirements {
private import ScalarValues::*;
private import ISQ::*;
private import SI::*;
part def CoolingSystem {
attribute heatRejection : PowerValue;
}
part cooling : CoolingSystem {
attribute redefines heatRejection = 18 [kW];
}
requirement def <'CR-1'> HeatRejection {
doc /* The cooling system shall reject at least the engine's waste heat at full load. */
subject system : CoolingSystem;
attribute wasteHeat : PowerValue;
require constraint { system.heatRejection >= wasteHeat }
}
requirement coolingSpec : HeatRejection {
subject system : CoolingSystem;
attribute redefines wasteHeat = 15 [kW];
}
satisfy coolingSpec by cooling;
verification def <'VC-1'> HeatRunTest {
doc /* Run the engine at full load on a test stand and measure the heat the radiator rejects. */
subject system : CoolingSystem;
objective {
verify coolingSpec;
}
return verdict : Boolean = system.heatRejection >= coolingSpec.wasteHeat;
}
verification heatRun : HeatRunTest {
subject system = cooling;
}
}
<'CR-1'>は短縮名で、v1 の要求 ID の v2 での置き場所です。require constraintはテキストの確認可能な形式です。15 kW に対して 18 kW なので、制約を評価するツールはこの要求を満たしているとレポートします。satisfyとverifyは v1 の意味を保ちます。derive、refine、trace は、依存関係や、ほかの要求の中に入れ子になった要求使用に対応します。どうモデル化するかはチームが決めます。- SysML v2 は、要求に前提(
assume constraint)、ステークホルダー、関心事を加え、検証ケースと並んでユースケースと解析ケースを加えています。
描かれたダイアグラムに代わるビュー
SysML v1 のダイアグラムはツールが所有する図面です。どの要素をどこに表示するかは人が選びます。同じブロックの二つのダイアグラムが、その中身について食い違うこともあり、ダイアグラムのレイアウトがツール間の交換で失われずに残ることはまれです。後の v1 のバージョンでビューとビューポイントが追加されましたが、主に文書に使われ、エンジニアが日々描くダイアグラムには使われていません。
SysML v2 では、ビューはモデルの要素です。expose で何を表示するかを、filter でどの種類の要素を含めるかを、そしてどの標準ビュー定義で描画するかを指定します。レイアウトはツールに任されます。ビューが何を含むかはモデルの中にあり、テキストで読めます。
package CoolingViews {
private import StandardViewDefinitions::*;
part def Pump;
part def Radiator;
part def Loop {
part pump : Pump;
part radiator : Radiator;
connect pump to radiator;
}
view loopConnections : InterconnectionView {
expose Loop;
}
view structure : GeneralView {
filter @SysML::PartDefinition;
expose CoolingViews::*;
}
}
| SysML v1 のダイアグラム | SysML v2 のビュー |
|---|---|
| ブロック定義図、パッケージ図、要求図 | General View(フィルター付き) |
| 内部ブロック図 | Interconnection View |
| アクティビティ図 | Action Flow ビュー |
| ステートマシン図 | 状態遷移ビュー |
| シーケンス図 | シーケンスビュー |
| パラメトリック図 | 制約とそのバインディングの General View または Interconnection View |
| ユースケース図 | ユースケースとアクターの General View |
| 表とマトリックス(v1 ではツール固有) | Grid View |
Systems Modeling API と JSON による交換
SysML v1 のモデルは XMI としてツール間を移動します。XMI は標準ですが、各ツールが独自の変種、ステレオタイプ、ダイアグラムデータを書き出すため、交換には通常ツールの組み合わせごとのテストが必要であり、別のツールにあるモデルをプログラムから問い合わせる標準の方法はありません。
SysML v2 には Systems Modeling API and Services の仕様が付属しています。プロジェクト、ブランチ、コミット、要素、クエリのサービスと、各要素を @id と @type を持つ JSON オブジェクトとする REST/HTTP バインディングを定義しています。その結果、次のことが可能になります。
- スクリプト、ダッシュボード、ほかのツールが、ベンダー固有のインターフェースではなく、文書化された一つのインターフェースを通じてモデルを読み、問い合わせることができます。
- 要素の ID がモデルとともに移動するので、ツール間のリンクが交換後も残ります。
- モデルは、ソースコードと同じようにブランチ上のコミットとしてバージョン管理されます。
テキストファイルと JSON は互いを補います。テキストは人が読み、レビューし、diff を取るためのもので、JSON はツールが頼りにする ID を保持します。
SysML v1 から v2 へのモデルの移行
v1 のモデルを v2 に移すことは、ファイルのアップグレードではなく言語間の翻訳であり、どこまで自動化されるかは移行先のツールで決まります。SysML v2 ツールで確認することでは、ほかの確認項目と並んで v1 のインポートを扱っています。典型的なモデルの多くはそのまま対応し、一部は直訳するより v2 のやり方で作り直したほうが良くなります。
そのまま対応するもの
- パッケージとその入れ子。
- ブロックはパート定義に、パートプロパティはパート使用に、参照プロパティは
ref使用に、汎化は特化に。 - 値プロパティは属性に(v1 の値型に単位があった場合は量と単位付きで)。
- フロープロパティを持つインターフェースブロックはポート定義に、プロキシポートとフルポートはポート使用に、コネクターはコネクションまたはインターフェースに。
- 要求の ID とテキストは短縮名と
docに。satisfy と verify の関係。 - ステートマシンは状態定義に、よく構造化されたアクティビティはサクセッションとフローを持つアクション定義に。
考え直すべきこと
- 文脈固有の値。値を設定するためだけに作ったプロパティ固有の型、インスタンス仕様、再定義は、使用での単純な再定義になります。直訳すると回避策が残ります。
- テキストだけの要求。v2 でも使えますが、利点は条件を加えることから生まれます。どの要求に
require constraintを付けるかを決めてください。 - 制約ブロックとパラメトリック図。制約定義と計算定義になり、上の
totalMassのように、属性に直接書く式になることがよくあります。 - 割り当て。アクティビティパーティションや、振る舞いから構造への «allocate» 関係は、意味が「このパートがこれを行う」である場合、
performとexhibitになります。 - 古い種類のポート。初期の v1 モデルの標準ポートとフローポートは、v2 にはポートの概念が一つしかないため、最も手間がかかります。
- プロファイルとステレオタイプ。独自のステレオタイプとタグ付き値はメタデータ定義になります。その意味は改めて設計する必要があります。
- ダイアグラム。レイアウトは引き継がれません。重要なダイアグラムはそれぞれビューになり、その内容は
exposeとfilterで改めて記述します。 - オペークビヘイビアとツールのスクリプト。アクション言語やツールのスクリプトで書かれたコードは翻訳されません。書き直すか、モデルの外に置く必要があります。
移行は、ほかのモデル変更と同じように計画します。まず代表的なパッケージを変換し、モデルを使う人と一緒にレビューし、上の点についてモデリングパターンを決め、それから残りを変換します。v2 モデルのレビューが終わるまで v1 モデルを基準として残します。SysML v1 モデルを SysML v2 へ移行するで、これらのステップを順に説明しています。
リストの確認方法
このページのすべてのリストは、Holarch の SysML v2 エディターを支えるエンジンである Holarch Language Engine で、SysML v2 標準ライブラリを読み込んだ状態で解析・チェックされ、エラーも警告も出ません。エンジンがどの SysML v2 の構成要素をサポートし、既知のギャップが何かは、SysML v2 の言語カバレッジを参照してください。より長い実践モデルはSysML v2 チュートリアルにあります。
Holarch で試す
Holarch には、テキスト表記とビューが一つのモデルを編集する SysML v2 プロジェクトと、LML プロジェクトがあります。上のリストをモデルとして読むには、次のようにします。
- SysML v2 プロジェクトを作成します。SysML v2 プロジェクトの始め方を参照してください。
- モデル → エディターで+ 新しいパッケージをクリックし、リストを貼り付けます。解析できたテキストは少し間をおいて適用され、問題はその場でマークされます。エディターを参照してください。
- ダイアグラムの一覧を開くとビューが表示されます。ビューのリファレンスを参照してください。
SysML v1 モデル。SysML v2 プロジェクトは SysML 1.x モデルを直接インポートします。モデル → インポートとエクスポートで、XMI ファイル(Cameo Systems Modeler または MagicDraw、Enterprise Architect、Rhapsody、Papyrus から)か、Cameo または MagicDraw の .mdzip プロジェクトをドロップします。Holarch はそれを SysML v2 テキストに変換し、テキストをチェックし、何かが変わる前に、各要素を変換、近似、除外のいずれかとして理由とともに示す変換レポートを表示します。ダイアグラムのレイアウトは変換されないため、結果は完成した移行ではなく、上で説明した見直しの出発点として扱ってください。SysML v1 モデルのインポートを参照してください。
LML プロジェクトも SysML 1.x の XMI をインポートでき、モデルを SysML 1.6 XMI または Papyrus の .uml ファイルとして再びエクスポートできます。Papyrus で編集したファイルは同じプロジェクトにインポートし直すと、XMI ID によって項目がその場で更新されます。UML/SysML モデルのインポートとPapyrus とのラウンドトリップを参照してください。
次に読むもの
- SysML v2 チュートリアル:テキスト表記で小さなシステムを一歩ずつ作る。
- SysML v2 ツール:選ぶ前に確認すること:どの候補ツールにも使えるチェックリストとテストモデル。
- Holarch の SysML v2 プロジェクト:テキスト、ビュー、エンジニアリングのページを一つのモデルで。
- SysML v2 の言語カバレッジ:エンジンがサポートするものと既知のギャップ。
- SysML v2 モデルの交換:テキスト、JSON、Systems Modeling API のリポジトリ。