Holarch

ガイド · SysML v2

SysML v2 ツール:選ぶ前に確認すること

このガイドを聴く(英語音声) 16 min

SysML v2 ツールの評価ガイドです。どの候補でも確認すべきこと、本当のサポートとスライド上の主張の見分け方、採点に使うチェックリストの表、各ツールに読み込む小さなテストモデルを紹介します。

このページの内容
  1. SysML v2 ツールに独自の評価が必要な理由
  2. 確認すること
    1. 言語カバレッジと、ギャップの文書化の仕方
    2. テキスト表記:編集とチェック
    3. グラフィカルなビューと、テキストとダイアグラムの同期
    4. 標準ライブラリ
    5. Systems Modeling API
    6. JSON による交換とラウンドトリップ
    7. SysML v1 からの移行
    8. 共同作業とバージョン管理
    9. モデル上の要求と検証
    10. 単位付きの解析と評価
    11. 導入形態:クラウドかセルフホストか
    12. ライセンスとコスト
    13. トレーニング
  3. 評価チェックリスト
  4. どの候補にも読み込めるテストモデル
    1. チェッカーのための二つのプローブ
  5. 評価の進め方
  6. チェックリストに対する Holarch の回答
  7. Holarch で試す
  8. 次に読むもの

SysML v2 ツールに独自の評価が必要な理由

SysML v2 は新しい言語であり、SysML v1 の改訂版ではありません(SysML v1 と v2 の違いで詳しく比較しています)。グラフィカル表記に加えてテキスト表記を持ち、KerML による形式的なセマンティクスの基盤、量、単位、ビューの種類の標準ライブラリ、モデルを読み書きする標準 API を備えています。ツールは SysML v2 のサポートを謳いながら、その一部しかカバーしていないことがあり、カバーしていない部分こそ、あなたのプログラムが依存する部分かもしれません。

仕様は大きく、どのツールも段階的に実装します。それは普通のことです。評価で重要なのは、ツールがどの段階まで進み、どこがまだなのかを把握すること、そしてベンダーがそれをはっきり伝えているかどうかです。以下の確認項目は、価格や導入形態にかかわらず、あらゆる SysML v2 ツールに当てはまります。テストモデルは、各候補に同じ入力を与えます。

候補を探すには、OMG が管理している SysML v2 ツールの一覧と、SysML v1 からの移行を支援するために INCOSE と OMG が公開した SysML v2 ツール機能のまとめから始めます。どちらも出発点です。名前を知るために読み、そのうえで各ツールを自分でテストしてください。

確認すること

言語カバレッジと、ギャップの文書化の仕方

カバレッジの記述を求めてください。言語の各領域(パッケージ、定義と使用、特化と再定義、多重度、値と単位、制約、構造、アクション、状態、要求、ユースケース、解析ケースと検証ケース、ビュー、メタデータ、可変性、個体とタイムスライス)について、それぞれのレベルを示したものです。役に立つレベルは四つの場合を区別します。

  • ツールがその構成要素を解析し、チェックし、使用する。
  • 名前の付いた制限付きでそうする。
  • 構成要素を書かれたとおりに保持するが、意味を与えない(ラウンドトリップでは残るが、何もチェックも計算もしない)。
  • 受け付けない。

既知のギャップを公開しているベンダーのほうが、機能だけを並べるベンダーよりも計画を立てやすくなります。カバレッジの表のない「supports SysML v2」は不明として扱い、自分のモデルが使う構成要素をテストしてください。

テキスト表記:編集とチェック

テキスト表記は、SysML v2 が v1 と最も異なる部分であり、ツール間の違いが最も大きい部分でもあります。次を確認します。

  • 編集:構文の色分け、名前とキーワードの補完、定義へ移動、モデル全体での名前の変更、検索と置換。
  • 入力中のチェック:構文エラーは最低限です。役に立つチェッカーは、インポートを通じてすべての名前を解決し、重複した名前やあいまいな名前を報告し、再定義を継承したものと照合し、単位の次元を比較し、接続をまたいでポートとフローの方向を比較します。
  • テキストがモデルそのものか:編集の後、ほかのすべてのビューに変更が反映されるか、それともテキストはツールが時々インポートするファイルにすぎないか。
  • ツールが書いていないテキスト:手書きのテキストやほかのツールが書いたテキストを読み込みます。コメント、ドキュメント、テキストのレイアウトが残るべきです。

グラフィカルなビューと、テキストとダイアグラムの同期

SysML v2 では、ビューはモデル要素です。何を公開し、何を絞り込むかを記述し、描画はツールが行います。標準ライブラリは、General、Interconnection、Action Flow、State Transition、Sequence、Grid の各ビューを定義しています。ツールがこれらのどれを描画し、どれで編集でき、仕様がツールに任せているレイアウトをどう扱うかを確認します。

重要なテストは双方向の同期です。テキストでパートの名前を変更し、それを表示するすべてのダイアグラムを見ます。ダイアグラムで接続を追加し、生成されたテキストを読みます。次に、二人で同時に作業できるなら両側を同時に変更し、ツールがその競合をどう扱うかを見ます。

標準ライブラリ

SysML v2 の意味の多くは標準ライブラリにあります。スカラー値、国際量体系、SI 単位と米国慣用単位、標準のビュー定義、KerML のカーネルライブラリです。ツールはライブラリを同梱し、名前をそれに対して解決し、それを使って評価するべきです。ISQ の量の種類と SI の単位が解決されること、ライブラリが誤って変更されないこと、ツールがライブラリのどのバージョンを使っているかを確認します。

Systems Modeling API

Systems Modeling API は、モデルリポジトリへの標準の REST インターフェースです。プロジェクト、ブランチ、コミット、要素を扱います。ツールはファイルなしでモデルを交換でき、自分のスクリプトでモデルを読むこともできます。ツールが担える役割は二つあり、どちらも読み取り専用の場合があります。

  • クライアント:ツールが、API を提供するほかのリポジトリからプルし、そこへプッシュする。
  • サーバー:ツールが API を提供し、ほかのツールがそのモデルを読み、場合によっては書き込む。

どちらの役割か、どのルートか、書き込み、クエリ、差分、古いコミットが提供されるかを尋ねます。読み取り専用のサーバーでも、レポート作成や解析ツールへのデータ提供には役立ちますが、ほかのツールがモデルを変更しなければならない場合には不十分です。

JSON による交換とラウンドトリップ

テキストのほかに、モデルは SysML v2 JSON としてツール間を移動します。API の要素形式で、要素ごとに ID が付いています。ID は重要です。テキストは ID を持たないため、テキストを再インポートするツールは名前でしか要素を照合できませんが、JSON は交換をまたいで同一性を保ちます。ラウンドトリップをテストします。ツール A からエクスポートし、ツール B にインポートし、再びエクスポートして A にインポートします。そのうえで要素の数、名前、単位付きの値、関係を比較し、各ツールが何を落としたかをどう報告するかを読みます。ラウンドトリップでデータが失われるのは、ツールがサポートしていない要素の種類です。

SysML v1 からの移行

v1 から v2 への損失のない自動変換はありません。言語の構造が異なり、v1 のダイアグラムには、v2 に一対一で相当するもののないレイアウトとステレオタイプが含まれるからです。ツールが v1 モデルをどう取り込むか(通常は SysML 1.x プロファイル付きの XMI)、ブロック、パート、ポート、アクティビティ、ステートマシン、要求を何に対応付けるか、変換されなかったもののレポートを出すかを尋ねてください。ベンダーのサンプルではなく、自分の v1 モデルの一つで試してください。

共同作業とバージョン管理

システムモデルはチームの作業です。複数の人が同時に編集できるか、競合がどう表示され解決されるか、どのような役割(編集、レビュー、閲覧)があるか、履歴とベースラインがどう機能するか、二つのバージョンを要素ごとおよびテキストとして比較できるかを確認します。組織がモデルをリポジトリで管理しているなら、ブランチ、マージ、そしてツール自身のバージョン履歴とリポジトリのコミットとの関係を確認します。

モデル上の要求と検証

SysML v2 では、要求は主題に対する制約であり、設計と検証ケースへの satisfy 関係と verify 関係を持ちます。ツールが要求のテキストと制約を一緒に保持し、モデルの値に対して制約を評価し、verify リンクから検証マトリックスを作るかを確認します。ツールが言語の外に保持しているものも確認します。要求のステータス、承認、テスト結果、変更後の要確認リンクです。これらは SysML v2 のテキストには含まれないため、どこに保存され、エクスポートと一緒に移動するかを尋ねてください。

単位付きの解析と評価

SysML v2 モデルのすべての値は単位を持つことができ、式がそれらを組み合わせます。ツールが単位付きの式を評価すること(三つのパートの質量から合計質量をキログラムで求めるなど)、次元の誤りをエラーとして報告すること、その結果に対して要求の制約を評価することを確認します。次に、必要とする大きな解析機能を確認します。パラメトリックな求解、バジェットと集計、トレードスタディ、アクションフローやステートマシンのシミュレーションです。何がモデルから評価され、何に追加のツール固有のデータが必要かを尋ねます。

導入形態:クラウドかセルフホストか

モデルがどこにあり、誰がツールを運用するかを確認します。ホスト型サービス、デスクトップへのインストール、自社環境のサーバーのいずれかです。管理対象データや輸出規制のあるデータについては、セルフホスト、データの所在地、サインインの方法、AI 機能がある場合はその設定方法やオフにする方法を尋ねてください。

ライセンスとコスト

シートあたりの定価ではなく、チームの総コストを比較します。閲覧者とレビュー担当者、アカデミック利用や評価利用、API やサーバーのオプションのコスト、そして支払いをやめたときにモデルがどうなるかです。標準形式でのエクスポートがすべてのプランで利用できるかを確認し、モデルが自分のものであり続けるようにします。

トレーニング

SysML v2 は、v1 に精通している人も含め、ほとんどのエンジニアにとって新しいものです。ツールがサポートする範囲の表記をカバーするリファレンス、実践例、自由に見て回れるデモモデル、ツール自身の画面のためのガイド付き教材を探してください。言語のトレーニングとツールのトレーニングは別のニーズです。両方がカバーされているか確認してください。

評価チェックリスト

各候補を同じ問いと同じ入力で採点します。「確認済み」とは、スライド上ではなく、テストモデルや自分のモデルで動くのを見たことを意味します。

領域確認する問いテスト方法
言語カバレッジ既知のギャップを含むカバレッジの表が公開されているか?自分のモデルが使う構成要素をその中で探し、テストモデルを読み込む
テキスト表記エディターは入力中に名前、再定義、単位、方向をチェックするか?二つのプローブを読み込む。それぞれ一つの問題が報告されるはず
グラフィカルなビューどの標準ビューが描画され、編集できるか?テストモデルの Interconnection View と状態遷移ビューを開く
テキストとダイアグラムの同期どちらかの側の変更が、もう一方にすぐ表示されるか?テキストで controller の名前を変更する。ダイアグラムで接続を追加し、テキストを読む
標準ライブラリISQ の量、SI 単位、標準ビューが解決されるか?テストモデルは ISQ、SI、StandardViewDefinitions をインポートしている
Systems Modeling APIクライアント、サーバー、その両方か?読み取り専用か、読み書きか?ほかのツールやスクリプトでテストモデルの要素を読む
JSON のラウンドトリップ要素の ID は保持されるか?何が落ち、それは報告されるか?エクスポートし、二つ目のツールにインポートし、再びエクスポートして比較する
v1 からの移行レポート付きの SysML v1 からのインポート手段があるか?自分の v1 モデルの一つを変換する
共同作業同時編集、役割、ベースライン、比較は?二人が同じパッケージを編集し、ベースラインと比較する
要求と検証制約が評価され、検証マトリックスが作られるか?質量の上限を 20 kg に下げ、要求が不合格になるのを見る
単位付きの解析値は単位付きで評価されるか?ほかに何が計算されるか?totalMass が 23 kg と評価されることを確認する
導入形態ホスト型、デスクトップ、セルフホストか?データの所在地を含め、選択肢を書面で求める
ライセンスとコスト作成者、レビュー担当者、閲覧者の総コスト。すべてのプランでエクスポートできるか?レビュー担当者を含め、チームの価格を見積もる
トレーニング言語リファレンス、例、ツールのガイドはあるか?新しいユーザーに、ドキュメントだけを頼りにテストシステムをモデル化してもらう

どの候補にも読み込めるテストモデル

このモデルは入力できるほど小さく、それでいて評価に必要なことのほとんどに触れます。標準ライブラリからのインポート、値と単位を再定義したパート定義と使用、共役ポート、コネクションとバインディング、ステートマシン、サクセッションを持つアクション、制約を持つ二つの要求、satisfy、検証ケース、二つのビューです。pump-station.sysml として保存し、各ツールに読み込んでください。

システムは太陽光発電の揚水ポンプです。パネルがコントローラーに給電し、コントローラーがポンプを駆動します。ユニットの重量は 25 kg 以下でなければならず、パネルのピーク電力はポンプの定格電力を少なくとも 20 % 上回らなければなりません。表記が初めての場合は、SysML v2 チュートリアルで、このモデルが使う構成要素を一つずつ紹介しています。

package PumpStation {
  doc /* A solar-powered water pump: a small probe model for evaluating SysML v2 tools. */

  private import ScalarValues::*;
  private import ISQ::*;
  private import SI::*;

  port def PowerPort {
    out attribute voltage : ElectricPotentialValue;
  }

  port def WaterPort {
    out attribute pressure : PressureValue;
  }

  part def SolarPanel {
    attribute mass : MassValue;
    attribute peakPower : PowerValue;
    port powerOut : PowerPort;
  }

  part def Controller {
    attribute mass : MassValue;
    port powerIn : ~PowerPort;
    port motorOut : PowerPort;
  }

  part def Pump {
    attribute mass : MassValue;
    attribute ratedPower : PowerValue;
    port powerIn : ~PowerPort;
    port outlet : WaterPort;
  }

  item def StartSignal;
  item def StopSignal;

  state def PumpModes {
    entry; then idle;
    state idle;
    state pumping;
    transition first idle accept StartSignal then pumping;
    transition first pumping accept StopSignal then idle;
  }

  action def DeliverWater {
    action convertSunlight;
    action regulatePower;
    action driveImpeller;
    first start then convertSunlight;
    first convertSunlight then regulatePower;
    first regulatePower then driveImpeller;
    first driveImpeller then done;
  }

  part def PumpUnit {
    part panel : SolarPanel {
      attribute redefines mass = 12 [kg];
      attribute redefines peakPower = 400 [W];
    }
    part controller : Controller {
      attribute redefines mass = 2 [kg];
    }
    part pump : Pump {
      attribute redefines mass = 9 [kg];
      attribute redefines ratedPower = 300 [W];
    }
    port outlet : WaterPort;

    connect panel.powerOut to controller.powerIn;
    connect controller.motorOut to pump.powerIn;
    bind outlet = pump.outlet;

    attribute totalMass : MassValue = panel.mass + controller.mass + pump.mass;
    exhibit state modes : PumpModes;
  }

  part pumpUnit : PumpUnit {
    perform action delivery : DeliverWater;
  }
}

package PumpRequirements {
  private import PumpStation::*;
  private import ScalarValues::*;
  private import ISQ::*;
  private import SI::*;

  requirement def <'PS-1'> MassLimit {
    doc /* The pump unit shall weigh no more than the mass limit, so that one person can carry it. */
    subject unit : PumpUnit;
    attribute limit : MassValue;
    require constraint { unit.totalMass <= limit }
  }

  requirement def <'PS-2'> PowerMargin {
    doc /* The panel's peak power shall exceed the pump's rated power by at least 20 %. */
    subject unit : PumpUnit;
    require constraint { unit.panel.peakPower >= 1.2 * unit.pump.ratedPower }
  }

  requirement pumpSpec {
    subject unit : PumpUnit;
    requirement mass : MassLimit {
      attribute redefines limit = 25 [kg];
    }
    requirement power : PowerMargin;
  }

  satisfy pumpSpec by pumpUnit;

  verification def <'VC-1'> WeighUnit {
    doc /* Weigh the assembled pump unit on a calibrated scale. */
    subject unit : PumpUnit;
    objective {
      verify pumpSpec.mass;
    }
    return verdict : Boolean = unit.totalMass <= pumpSpec.mass.limit;
  }
}

package PumpViews {
  private import PumpStation::*;
  private import StandardViewDefinitions::*;

  view unitConnections : InterconnectionView {
    expose PumpStation::PumpUnit;
  }

  view pumpStates : StateTransitionView {
    expose PumpStation::PumpModes;
  }
}

これらの構成要素をサポートするツールが示すべきこと:

  • エラーも警告もないこと。ここで問題を報告するツールは、構成要素が欠けているか、標準ライブラリの読み方が異なります。どちらなのかを尋ねてください。
  • totalMass が 23 kg と評価されること:12 kg + 2 kg + 9 kg。
  • 両方の要求が成り立つこと:23 kg は 25 kg 以内であり、400 W は 1.2 × 300 W = 360 W より大きい。
  • unitConnections が、パネル、コントローラー、ポンプとそのポート、二つの接続、ユニットの境界にバインドされた出口を描くこと。
  • pumpStates が、初期遷移と二つのトリガー付き遷移を持つ二つの状態を描くこと。
  • 検証マトリックスに、VC-1 で検証される PS-1 と、検証ケースのない PS-2 が一覧されること。

チェッカーのための二つのプローブ

チェッカーの価値は誤りに対して発揮されます。各プローブを単独で読み込みます。それぞれにちょうど一つの問題があります。

一つ目は、電力にキログラムの値を与えています。次元をチェックするツールは、その値にエラーを報告します。

package UnitProbe {
  private import ISQ::*;
  private import SI::*;

  part def Pump {
    attribute ratedPower : PowerValue;
  }

  part pump : Pump {
    attribute redefines ratedPower = 300 [kg];
  }
}

二つ目は問題なく解析され名前も解決されますが、その要求は成り立ちません。ユニットの重量は 10 kg の上限に対して 11 kg です。要求の制約を評価するツールはこれを報告し、解析しかしないツールは黙って受け付けます。

package RequirementProbe {
  private import ISQ::*;
  private import SI::*;

  part def Pump {
    attribute mass : MassValue;
  }

  part def Unit {
    part pump : Pump {
      attribute redefines mass = 9 [kg];
    }
    attribute totalMass : MassValue = pump.mass + 2 [kg];
  }

  requirement def Light {
    subject unit : Unit;
    require constraint { unit.totalMass <= 10 [kg] }
  }

  part unit : Unit;
  requirement light : Light;
  satisfy light by unit;
}

テストモデルと同じく、両方のプローブを言語エンジンでチェックしました。モデルには問題がなく、各プローブには説明したとおりちょうど一つの問題があります。

評価の進め方

  1. まず自分のニーズを書き出す。自分のモデルが使う構成要素、レビュー担当者が読むビュー、モデルを交換しなければならないツール、データを置いてよい場所です。それらに応じてチェックリストの行に重みを付けます。
  2. 各ベンダーのカバレッジの記述と既知のギャップを読む。チェックリストの各行に、主張あり、主張なし、記載なしのいずれかを記入します。
  3. テストモデルとプローブをすべての候補に読み込む。各ツールが報告したことを一字一句記録します。
  4. 自分のモデルを一つ読み込む。実際のモデルは、どのサンプルでも見つからない問題を見つけます。サイズ、命名、変わった構成要素です。
  5. 最もよくモデルを交換するツールとラウンドトリップを一度行う。
  6. 新しいユーザーに、ツールのドキュメントだけを頼りにテストモデルを作ってもらい、時間を計ります。

エビデンス(スクリーンショット、エクスポートしたファイル、各ツールが出したメッセージ)を採点と一緒に保管します。何をテストしたかを示す決定記録は、ベンダーの資料から写した機能マトリックスよりも、審査委員会にとって価値があります。

チェックリストに対する Holarch の回答

このページのスクリーンショットに使ったツールは Holarch なので、ここに Holarch 自身の回答を、それを裏付けるページとともに示します。「Partial(部分的)」と「Not yet(未対応)」は文字どおりの意味です。

領域レベル現在の Holarch
言語カバレッジ一部対応すべての領域について、レベル、制限、既知のギャップを示した表を公開しています。可変性、個体とタイムスライス、ユーザー定義キーワード、セマンティックメタデータはチェックされ評価されます。.kerml ファイルはまだインポートできません。SysML と KerML のテキスト表現はチェックされ、それ以外の言語はテキストとして保持されます。SysML v2 の言語カバレッジ
テキスト表記対応入力中にチェックするエディター(構文、名前、型付け、多重度、単位、方向、評価)。補完、定義へ移動、名前の変更、検索と置換を備えています。エディター、チェック
グラフィカルなビュー一部対応General、Interconnection、Action Flow、State Transition、Sequence、Grid の各ビュー。すべて編集できます。シーケンスビューは、ライフライン間のメッセージと複合フラグメント(alt、opt、loop、par)を描きます。SysML v2 のビュー
テキストとダイアグラムの同期対応テキストとすべてのビューの背後に一つのモデル。どちらの側の編集ももう一方に表示されます。テキストとビューは同期し続けます
標準ライブラリ対応読み込み済みで読み取り専用。ISQ、SI 単位と米国慣用単位、標準のビュー定義を含みます。標準ライブラリ
Systems Modeling API一部対応クライアントとして:API を提供するリポジトリの一つのブランチからプルし、そこへプッシュします。サーバーとして:ほかのツールが現在のモデルを読み、変更要求ブランチにコミットし、承認者がそれを Holarch で適用します。プルとプッシュ、Systems Modeling API
JSON のラウンドトリップ一部対応要素の ID を保持した SysML v2 JSON のインポートとエクスポート。Holarch が解釈しない要素の種類は、インポートしたとおりに保持され、エクスポート時に変更されずに書き戻されます。SysML v2 モデルの交換
v1 からの移行一部対応SysML 1.x モデル(Cameo または MagicDraw の .mdzip、または Cameo、Enterprise Architect、Rhapsody、Papyrus の XMI)を SysML v2 プロジェクトに直接インポートし、SysML v2 テキストに変換してチェックし、何が変換、近似、除外されたかとその理由をレポートします。ダイアグラムとそのレイアウトは変換されません。SysML v1 モデルのインポート
共同作業対応エディターでのメンバー単位のマージを伴うライブ編集、役割、モデルを保持するベースライン、要素ごとおよびパッケージのテキストによる比較。共同作業、ベースライン
要求と検証対応モデルに対して評価される要求の制約、verify リンクから作られる RVTM とテストセンター、承認、TBD/TBR、確認が必要なリンク。要求と検証
単位付きの解析一部対応単位付きの評価、制約ごとに一つの未知数を解くパラメトリックビュー、バジェット、トレードスタディ、アクションフローとステートマシンのシミュレーション。解析ケースは、すべての入力に値があるときにだけ評価されます。評価、単位、解析
導入形態対応ホスト型のウェブアプリと、ご要望に応じた自社環境でのセルフホスト導入。セキュリティ、お問い合わせ
ライセンスとコスト対応学生、教員、個人のプロジェクト、個人での評価向けの Free プラン。企業は Individual プランを 1 か月無料で試せます。商用利用には有料プラン。すべてのプランでレビュー担当者と閲覧者は無料です。料金
トレーニング一部対応すべての SysML v2 ページのドキュメントリファレンス、ステップバイステップのチュートリアル、Hybrid Car デモ、アプリ内の九つのガイド付き SysML v2 チュートリアル、Hybrid Car モデルを作る SysML v2 のビデオチュートリアルシリーズ。ビデオのトレーニングトラックは LML プロジェクトを扱っています。はじめに、SysML v2 チュートリアル、SysML v2 チュートリアル

Holarch で試す

  1. テストモデルを pump-station.sysml として保存します。
  2. モデル → インポートとエクスポートを開き、新しい SysML v2 プロジェクトへを選んでファイルをドロップします。新しいプロジェクトへのファイルのインポートを参照してください。
  3. モデル → エディターを開きます。ステータス行には「問題なし」と表示され、各パッケージが一つのドキュメントになっています。
  4. ダイアグラムの一覧を開き、unitConnections または pumpStates をクリックします。
  5. 検証 → RVTMを開くと、要求とそれを検証するケースが表示されます。
エディターでのテストモデル。問題はありません。
unitConnections ビュー:共役ポート、二つの接続、一つのバインディング。
モデルの verify リンクから作られた RVTM。

次に読むもの