Holarch

SysML v2

SysML v2 チュートリアル

SysML v2 プロジェクト向けの 9 つのガイド付きチュートリアルです。最初のパッケージから、ポート、アクション、状態、要求、検証、制約、バリアントまでを、作業をチェックするステップパネルとともに進めます。

使い方 →

このページの内容
  1. 使い方
    1. SysML v2 チュートリアルを開始する
    2. 手順のテキストを入力する
    3. ヒント
  2. はじめに
  3. 定義と属性
  4. ポートとインターフェース
  5. アクションとフロー
  6. 状態と遷移
  7. 要求
  8. 検証とトレーサビリティ
  9. 制約と計算
  10. バリアントと構成
  11. チュートリアルプロジェクト
  12. 関連

Holarch には、SysML v2 プロジェクト向けのガイド付きチュートリアルのトラックがあります。それぞれが小さな SysML v2 スタータープロジェクトを作成し、ページの横にステップパネルを開きます。パネルは作業中にモデルをチェックし、手順が求めるものがモデルにそろうと、その手順が緑色になります。このページではすべての手順をテキストで示しているので、ここを見ながら進めることもできます。

最初のチュートリアルでは、LML のチュートリアルと同じく WS-1 Weather Station を使います。その他のチュートリアルでは、Hybrid Car デモのモデルであるハイブリッド車の各部分を構築します:値の型とコンポーネント、パワートレインのポートとインターフェース、ドライブサイクル、パワートレインの状態、車の要求、その検証、セダンの値のチェック、プロダクトライン。各チュートリアルには独自のスタータープロジェクトがあるので、どの順序でも進められます。どのスタータープロジェクトも、完了したどのチュートリアルも、問題 0 件でチェックを通ります。

チュートリアル時間学ぶこと
はじめに15 分SysML v2 テキストを書き、ツリーとビューで表示し、ビューに描画して要求を追加する
定義と属性20 分列挙、値の型、抽象定義を書き、値と単位で特殊化し、補完、挿入、名前の変更を使う
ポートとインターフェース20 分ポートとインターフェースを定義し、ポートを共役にし、パートを接続して、Interconnection View にインターフェースを描く
アクションとフロー20 分アクション定義と、フォーク、フロー、結合を含むドライブサイクルを書き、スイムレーンを追加して、FFBD で手順を構築する
状態と遷移20 分シグナルと、トリガー、ガード、状態アクションを持つステートマシンを書き、時間指定の遷移を描く
要求20 分制限値、要求定義と要求の使用を書き、それらを充足させ、満たされていない要求を確認する
検証とトレーサビリティ15 分検証ケースを書き、トレーサビリティマトリックスで手順をトレースし、要求を導出する
制約と計算20 分制約と計算を書き、パラメトリックビューで値をバインドし、解析ケースを実行して、TBD 値と TBR 値をマークする
バリアントと構成15 分バリエーションとバリアント、ルールを持つプロダクトライン、構成、独自のキーワードを書く

使い方

SysML v2 チュートリアルを開始する

  1. レールでヘルプ → チュートリアルを開くか、⌘K / Ctrl+K を押して tutorial と入力します。プロジェクトの外では、チュートリアルページに LML のチュートリアルが先に、その後にSysML v2 プロジェクト向けチュートリアルが表示されます。SysML v2 プロジェクトの中では、SysML v2 のチュートリアルだけが表示されます。
  2. カードの開始をクリックします。Holarch がプロジェクト(たとえば Tutorial: SysML v2 Ports and Interfaces (Hybrid Car))を作成し、右側にステップパネルを表示して開きます。

ステップパネルは LML のチュートリアルと同じように動作します。表示するは手順に必要なコントロールを枠で囲み、移動はページを開き、詳細を読むはヘルプのトピックを開きます。やり直す…、完了にする、×も同じように動作します。チュートリアルを参照してください。

手順のテキストを入力する

ほとんどの手順では、モデル → エディターに入力する SysML テキストが示されます。手順には行を入れる場所が書かれています(たとえば「パッケージの最後の閉じ波かっこの前」)。入力を止めるとテキストがモデルに適用されます。エディターの下のステータスにそのことが表示され、手順が緑色になります。

  • 行は示されたとおりに入力します。インデントはモデルに影響しません。エディターは入力したインデントをそのまま保ちます。
  • 赤い下線はエラーを示します。ポインターを合わせるとメッセージが表示されます。構文エラーのあるテキストは下書きのままで、修正するまで適用されません。
  • ⌘Z / Ctrl+Z で、最後に適用した変更を元に戻します。

ヒント

  • 初回はチュートリアルを順番に進めてください。各チュートリアルは使うテキストを説明し、後のチュートリアルは前の考え方(定義と使用、:> と :>>)を前提とします。
  • 手順が完了しないままの場合、たいていは名前の入力ミスです。自分のテキストを手順の行と比べてください。SysML v2 では名前の大文字と小文字が区別されます。
  • チュートリアルは SysML v2 の基本と同じ言語を教えます。詳細はテキスト表記のページにあります。

はじめに

Weather Station の最初のモデルを書きます。テキストを開き、値と単位を持つパート定義を追加し、それを別の定義で使い、ブラウザーと General View でモデルを確認し、ビューにパートを描いてテキストに現れるのを確認し、satisfy で要求を追加し、モデルを .sysml ファイルとしてエクスポートします。手順はSysML v2 プロジェクトを始めるで説明しています。

定義と属性

スタータープロジェクトには、パート定義 Car を 1 つ持つパッケージ Vehicles があります。

  1. パッケージを開きます。モデル → エディターをクリックします。どの宣言も、キーワードと名前に、波かっこ内の本体またはセミコロンが続きます。
  2. 列挙を書きます。part def Car { の上に enum def DriveMode { enum economy; enum normal; enum sport; } を追加します(1 行に 1 つの値)。
  3. 値の型を定義します。その下に attribute def TirePressure :> ScalarValue; を追加します。:> は特殊化を意味します。
  4. 抽象定義を書きます。doc コメントと、属性 mass : MassValue、partNumber : String、power : PowerValue を持つ abstract part def Component を追加します。// はテキスト内だけに残るメモを始めます。
  5. チェッカーに間違いを見つけさせます。attribute redefines mass = 45 [kg]; と、わざと attribute redefines power = 60 [kg]; を持つ part def Battery :> Component を追加します。チェッカーが単位に下線を引きます。キログラムは電力の単位ではありません。
  6. 単位を修正します。60 [W] に変更します。
  7. 名前を補完します。バッテリーの中で attribute capacity : Ener と入力し、補完リストから EnergyValue を Enter で確定して、; で終えます。
  8. 標準ライブラリで調べます。レール下部の設定 → 標準ライブラリをクリックし、検索ボックスに EnergyValue と入力します。
  9. 定義を挿入します。エディターの空の行で ⌃⇧Space / Ctrl+Shift+Space を押し(または挿入 ▾をクリックし)、パート定義を選んで、attribute redefines mass = 110 [kg]; と attribute cylinders : Integer; を持つ part def Engine :> Component を完成させます。
  10. 定義を使います。Car に attribute mode : DriveMode;、part battery : Battery;、part engine : Engine; を追加します。
  11. すべての箇所で名前を変更します。cylinders にカーソルを置き、F2 を押して cylinderCount に名前を変更します。

ポートとインターフェース

スタータープロジェクトには、トルクポートと電力ポートを持つパワートレインのコンポーネント、ポート定義 TorquePort と PowerPort、インターフェース定義 Shaft と HighVoltageBus があります。

  1. ポートを定義します。port def TorquePort の上に、out attribute flowRate : Real; と attribute kind : FuelKind; を持つ port def FuelPort を追加します。out は、値がポートを所有するパートから出ていくことを意味します。
  2. パートにポートを付けます。FuelTank に port fuelOut : FuelPort; を、Engine に port fuelIn : ~FuelPort; を追加します。~ はポートを共役にします。入力と出力が逆になります。
  3. インターフェースを定義します。interface def FuelLine { end supply : FuelPort; end consumer : ~FuelPort; } を追加します。
  4. パワートレインを構築します。パッケージの末尾に、パート tank、engine、motor、battery、transmission、ポート output : TorquePort、bind output = transmission.output; を持つ part def Powertrain を追加します。
  5. 2 つのパートを接続します。パワートレインに interface fuel : FuelLine connect tank.fuelOut to engine.fuelIn; を追加します。
  6. シャフトを追加します。interface engineShaft : Shaft connect engine.output to transmission.engineIn; と interface motorShaft : Shaft connect motor.output to transmission.motorIn; を追加します。
  7. Interconnection View を作成します。アーキテクチャ → Interconnection Viewをクリックし、+ 新しいダイアグラムをクリックします。表示内容で Powertrain を選び、作成をクリックします。
  8. インターフェースを描きます。バッテリーのポート powerOut のハンドルからモーターのポート powerIn までドラッグし、Interface : HighVoltageBus の上でドロップします。
  9. インターフェースに名前を付けます。新しい線を選択し、インスペクターでその名前に hvBus と入力します。
  10. テキストで確認します。モデル → エディターをクリックします。インターフェースが、名前、型、端とともにパワートレインの中にあります。

アクションとフロー

スタータープロジェクトには、アイテム Fuel と Torque、機能 ProduceTorque(F.2)と DriveWheels(F.3)、3 つのパート定義を持つパッケージ VehicleBehavior があります。

  1. 機能を定義します。in attribute fuelDemand : Real; と out item fuel : Fuel; を持つ action def <'F.1'> SupplyFuel を追加します。山かっこ内のショートネームが機能番号です。
  2. ドライブサイクルを書きます。first start then split;、fork split;、then supply;、then produce; と、それぞれ duration を持つ手順 action supply : SupplyFuel と action produce : ProduceTorque を持つ action def <'F'> DriveCycle を追加します。
  3. フローを追加します。ドライブサイクルに flow of Fuel from supply.fuel to produce.fuel; を追加します。
  4. 分岐を結合します。first supply then ready;、first produce then ready;、join ready;、then action drive : DriveWheels { … }、then done;、flow produce.torque to drive.torque; を追加します。
  5. Action Flow ビューを作成します。振る舞い → アクションフローをクリックし、+ 新しいダイアグラムをクリックして、表示内容で DriveCycle を選びます。
  6. 各手順を誰が実行するかを指定します。perform action trip : DriveCycle; と、パート tank、engine、transmission を持つ part def DrivenCar を追加し、各パートに perform trip.supply;、perform trip.produce;、perform trip.drive; のいずれかを付けます。ビューにパートごとのスイムレーンができます。
  7. 機能分析を開きます。振る舞い → 機能分析をクリックし、選択…をクリックして DriveCycle を選びます。
  8. 別のアクションを宣言します。action def EmergencyShutdown; を追加します。
  9. FFBD で手順を構築します。振る舞い → FFBDをクリックし、+ 新しいダイアグラムをクリックして、EmergencyShutdown を選びます。追加パネルで Open Contactors と入力して Enter を押し、続いて Cut Fuel と入力します。
  10. 手順をテキストで確認します。モデル → エディターをクリックします。FFBD が手順とそのサクセッションを書き込んでいます。

状態と遷移

スタータープロジェクトには、空の part def Car を持つパッケージ PowertrainBehavior があります。

  1. シグナルを定義します。attribute def StartRequest; を追加し、StopRequest、PlugIn、Unplug も同じように追加します。
  2. 状態定義を書きます。in attribute charge : Real;、entry; then off;、状態 off、electric、hybrid を持つ state def PowertrainStates を追加します。
  3. 遷移を追加します。state off; の後に、accept StartRequest if charge > 20 then electric; と accept StartRequest then hybrid; を追加します。
  4. 状態にアクションを付けます。state electric; を、entry action spinUpMotor;、do action driveElectric;、exit action holdMotor; を含む本体に置き換えます。
  5. electric 状態から出ます。その後に if charge < 15 then hybrid; と accept StopRequest then off; を追加し、state hybrid; の後にも accept StopRequest then off; を追加します。
  6. 名前付きの遷移を持つ状態を追加します。state charging { do action chargeBattery; }、transition plugIn first off accept PlugIn then charging;、transition unplugged first charging accept Unplug then off; を追加します。
  7. 状態遷移ビューを作成します。振る舞い → ステートマシンをクリックし、+ 新しいダイアグラムをクリックして、表示内容で PowertrainStates を選びます。
  8. 時間指定の遷移を描きます。charging のハンドルから off までドラッグし、遷移の上でドロップします。遷移パネルで、名前に charged、トリガーに after 30 [min] と入力します。
  9. テキストで確認します。モデル → エディターをクリックします。遷移は名前付きの遷移として書かれています。
  10. 車に状態を示させます。Car に exhibit state powertrainStates : PowertrainStates; を追加します。

要求

スタータープロジェクトには、設計の小さなコピーを持つパッケージ VehicleRequirements があります:Battery、Car、車両保有群の sedan(車両重量 1580 kg)。

  1. 制限値に名前を付けます。attribute maxCurbMass : MassValue = 1650 [kg]; と attribute minBatteryCapacity : EnergyValue = 1.2 [kW*h]; を追加します。
  2. 要求定義を書きます。doc の文、subject car : Car;、attribute limit : MassValue;、require constraint { car.curbMass <= limit } を持つ requirement def <'VR-1'> CurbMass を追加します。
  3. 要求を挿入します。空の行で ⌃⇧Space / Ctrl+Shift+Space を押し、要求定義を選んで、主体 battery : Battery と require constraint { battery.capacity >= minBatteryCapacity } を持つ VR-3 BatteryCapacity を書きます。
  4. 要求を仕様の中に入れ子にします。subject car : Car; と requirement <'VR-1.1'> sedanMass : CurbMass { attribute :>> limit = maxCurbMass; } を持つ requirement carSpec を追加します。
  5. 何がそれらを充足するかを指定します。satisfy carSpec by fleet.sedan; と satisfy requirement batterySpec : BatteryCapacity by fleet.sedan.battery; を追加します。
  6. 要求を破ります。セダンの車両重量を 1700 [kg] に変更します。エディターが satisfy にマークを付けます。セダンはもう VR-1.1 を満たしていません。
  7. 再び満たします。⌘Z / Ctrl+Z を押すか、1580 [kg] に戻します。
  8. 要求の表を確認します。ニーズと要求 → 要求をクリックします。
  9. 要求ビューを作成します。ダイアグラムページで+ 新しいダイアグラムをクリックし、要求ビューを選んで、表示内容で carSpec を選びます。
  10. 文をチェックします。ニーズと要求 → 品質をクリックし、品質をチェックをクリックします。

検証とトレーサビリティ

スタータープロジェクトには、車両重量の要求と車の仕様、手順 cruise と brake を持つドライブサイクル、VR-6 batteryMassLimit、VR-7 stopFromCruise があります。

  1. 検証ケースを書きます。subject car : Car;、objective massObjective { verify carSpec.sedanMass; }、return verdict : Boolean = car.curbMass <= maxCurbMass; を持つ verification def <'VC-1'> CurbMassTest を追加します。
  2. セダンに適用します。verification <'VC-1.1'> sedanWeighing : CurbMassTest { subject car = fleet.sedan; } を追加します。
  3. 検証ケースを開きます。検証 → 検証ケースをクリックします。手順、結果、ステータスは、モデルの横にある Holarch のデータです。Sedan Weighing の行で+ ステップをクリックし、続いて+ ステップを追加をクリックして、Action の下に Weigh the car と入力し、適用をクリックします。次に、ステータスボタンの合格をクリックします。
  4. RVTM を読みます。検証 → RVTM をクリックします。
  5. 手順を要求にトレースします。検証 → トレーサビリティマトリックスをクリックし、要求を行に、アクションを列に表示して、stopFromCruise と brake のセルをクリックし、satisfied by を選びます。
  6. 要求を導出します。private import RequirementDerivation::*; と connection batteryMassDerivation : Derivation connect carSpec.sedanMass to batteryMassLimit; を追加します。
  7. モデルチェックを実行します。検証 → モデルチェックをクリックします。

制約と計算

スタータープロジェクトには、エンジン、バッテリー、車、セダンの値と、目標値 maxCurbMass と minPowerToWeight を持つパッケージ VehicleAnalysis があります。

  1. 制約定義を書きます。in mass : MassValue;、in limit : MassValue;、式 mass <= limit を持つ constraint def MassLimit を追加します。
  2. 計算を書きます。パラメーター power と mass、return ratio = power / mass; を持つ calc def PowerToWeight を追加します。
  3. セダンの値をバインドします。constraint sedanMassCheck : MassLimit { in mass = fleet.sedan.curbMass; in limit = maxCurbMass; } を追加します。
  4. パラメトリックビューを作成します。ダイアグラムページで+ 新しいダイアグラムをクリックし、パラメトリックビューを選んで、表示内容で VehicleAnalysis を選びます。チェックは合格です。1580 kg は 1650 kg 以内です。
  5. チェックを不合格にします。セダンの車両重量を 1700 [kg] に変更します。ビューにチェックの不合格が表示されます。
  6. 再び合格させます。元に戻すか、1580 [kg] に戻します。すべて解くで、すべての制約を再びチェックします。
  7. 解析ケースを実行します。ratio >= minPowerToWeight を求める目的を持つ analysis def PowerToWeightAnalysis と、analysis sedanPowerToWeight : PowerToWeightAnalysis { subject car = fleet.sedan; } を追加します。
  8. 未確定の値をマークします。private import HolarchMetadata::*; と、要求 VR-5 ChargeTime を追加します。その時間の制限値には #TBR を、充電器の電力にはオーナー、期限、根拠を持つ @TBD を付けます。TBD と TBR は SysML v2 標準ライブラリではなく、Holarch の HolarchMetadata ライブラリのものです。これらは標準の StatusInfo メタデータを特殊化しています。
  9. TBD/TBR 登録簿を開きます。ニーズと要求 → TBD/TBR をクリックします。充電時間が、その @TBD メタデータのオーナーと期限とともに一覧表示されます。登録簿は読み取り専用です。オーナーや日付は、エディターでメタデータを変更してください。
  10. 質量を集計します。アーキテクチャ → 予算と TPM をクリックし、ルートパート sedan を選択します。

バリアントと構成

スタータープロジェクトには、Component、Battery、Controller、Car、Powertrain があります。

  1. 可変性パッケージをインポートします。private import HolarchVariability::*; を追加します。
  2. バリエーションを書きます。空の行で ⌃⇧Space / Ctrl+Shift+Space を押し(または挿入 ▾をクリックし)、バリエーションを選んで、バリアント standardPack(1.4 kWh)と largePack(12 kWh、120 kg)を持つ variation part def BatteryPack :> Battery を完成させます。
  3. プロダクトラインを書きます。part pack : BatteryPack;、バリアント noCharger と wallbox を持つ variation part charger、assert constraint wallboxNeedsLargePack { charger == charger::wallbox implies pack == BatteryPack::largePack } を持つ part def CarLine :> Car を追加します。
  4. 構成を開始します。挿入 ▾ → 構成を選び、part plugInHybrid : CarLine { @HolarchConfiguration; } を記入します。エディターに、まだ決まっていない可変点が示されます。
  5. バリアントを選びます。plugInHybrid の中で、可変点ごとに挿入 ▾ → バリアントの選択を選び、part :>> pack = BatteryPack::largePack; と part :>> charger = charger::wallbox; を記入します。
  6. 2 つ目の構成を追加します。同じ方法で、標準パックで充電器なしの selfChargingHybrid を追加します。
  7. 独自のキーワードを定義します。metadata def <safetyCritical> SafetyCritical を追加します。
  8. キーワードを使います。Powertrain の中に #safetyCritical part controller : Controller; と書きます。
  9. プロダクトラインを確認します。Vehicles の General View を作成します。バッテリーパックにバリエーションのマークが付いています。

チュートリアルプロジェクト

SysML v2 のチュートリアルプロジェクトは、他のチュートリアルプロジェクトと同じルールに従います。プランのアクティブなプロジェクトには数えられず、最大 300 項目を保持でき、チュートリアルごとに 1 つ持てます。チュートリアルを参照してください。

SysML® および OMG® は、米国およびその他の国における Object Management Group, Inc. の登録商標です。