SysML v2
SysML v2 チュートリアル
SysML v2 プロジェクト向けの 9 つのガイド付きチュートリアルです。最初のパッケージから、ポート、アクション、状態、要求、検証、制約、バリアントまでを、作業をチェックするステップパネルとともに進めます。
このページの内容
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 チュートリアルを開始する
- レールでヘルプ → チュートリアルを開くか、⌘K / Ctrl+K を押して
tutorialと入力します。プロジェクトの外では、チュートリアルページに LML のチュートリアルが先に、その後にSysML v2 プロジェクト向けチュートリアルが表示されます。SysML v2 プロジェクトの中では、SysML v2 のチュートリアルだけが表示されます。 - カードの開始をクリックします。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 があります。
- パッケージを開きます。モデル → エディターをクリックします。どの宣言も、キーワードと名前に、波かっこ内の本体またはセミコロンが続きます。
- 列挙を書きます。
part def Car {の上にenum def DriveMode { enum economy; enum normal; enum sport; }を追加します(1 行に 1 つの値)。 - 値の型を定義します。その下に
attribute def TirePressure :> ScalarValue;を追加します。:>は特殊化を意味します。 - 抽象定義を書きます。
docコメントと、属性mass : MassValue、partNumber : String、power : PowerValueを持つabstract part def Componentを追加します。//はテキスト内だけに残るメモを始めます。 - チェッカーに間違いを見つけさせます。
attribute redefines mass = 45 [kg];と、わざとattribute redefines power = 60 [kg];を持つpart def Battery :> Componentを追加します。チェッカーが単位に下線を引きます。キログラムは電力の単位ではありません。 - 単位を修正します。
60 [W]に変更します。 - 名前を補完します。バッテリーの中で
attribute capacity : Enerと入力し、補完リストからEnergyValueを Enter で確定して、;で終えます。 - 標準ライブラリで調べます。レール下部の設定 → 標準ライブラリをクリックし、検索ボックスに
EnergyValueと入力します。 - 定義を挿入します。エディターの空の行で ⌃⇧Space / Ctrl+Shift+Space を押し(または挿入 ▾をクリックし)、パート定義を選んで、
attribute redefines mass = 110 [kg];とattribute cylinders : Integer;を持つpart def Engine :> Componentを完成させます。 - 定義を使います。
Carにattribute mode : DriveMode;、part battery : Battery;、part engine : Engine;を追加します。 - すべての箇所で名前を変更します。
cylindersにカーソルを置き、F2 を押してcylinderCountに名前を変更します。
ポートとインターフェース
スタータープロジェクトには、トルクポートと電力ポートを持つパワートレインのコンポーネント、ポート定義 TorquePort と PowerPort、インターフェース定義 Shaft と HighVoltageBus があります。
- ポートを定義します。
port def TorquePortの上に、out attribute flowRate : Real;とattribute kind : FuelKind;を持つport def FuelPortを追加します。outは、値がポートを所有するパートから出ていくことを意味します。 - パートにポートを付けます。
FuelTankにport fuelOut : FuelPort;を、Engineにport fuelIn : ~FuelPort;を追加します。~はポートを共役にします。入力と出力が逆になります。 - インターフェースを定義します。
interface def FuelLine { end supply : FuelPort; end consumer : ~FuelPort; }を追加します。 - パワートレインを構築します。パッケージの末尾に、パート
tank、engine、motor、battery、transmission、ポートoutput : TorquePort、bind output = transmission.output;を持つpart def Powertrainを追加します。 - 2 つのパートを接続します。パワートレインに
interface fuel : FuelLine connect tank.fuelOut to engine.fuelIn;を追加します。 - シャフトを追加します。
interface engineShaft : Shaft connect engine.output to transmission.engineIn;とinterface motorShaft : Shaft connect motor.output to transmission.motorIn;を追加します。 - Interconnection View を作成します。アーキテクチャ → Interconnection Viewをクリックし、+ 新しいダイアグラムをクリックします。表示内容で
Powertrainを選び、作成をクリックします。 - インターフェースを描きます。バッテリーのポート
powerOutのハンドルからモーターのポートpowerInまでドラッグし、Interface : HighVoltageBus の上でドロップします。 - インターフェースに名前を付けます。新しい線を選択し、インスペクターでその名前に
hvBusと入力します。 - テキストで確認します。モデル → エディターをクリックします。インターフェースが、名前、型、端とともにパワートレインの中にあります。
アクションとフロー
スタータープロジェクトには、アイテム Fuel と Torque、機能 ProduceTorque(F.2)と DriveWheels(F.3)、3 つのパート定義を持つパッケージ VehicleBehavior があります。
- 機能を定義します。
in attribute fuelDemand : Real;とout item fuel : Fuel;を持つaction def <'F.1'> SupplyFuelを追加します。山かっこ内のショートネームが機能番号です。 - ドライブサイクルを書きます。
first start then split;、fork split;、then supply;、then produce;と、それぞれdurationを持つ手順action supply : SupplyFuelとaction produce : ProduceTorqueを持つaction def <'F'> DriveCycleを追加します。 - フローを追加します。ドライブサイクルに
flow of Fuel from supply.fuel to produce.fuel;を追加します。 - 分岐を結合します。
first supply then ready;、first produce then ready;、join ready;、then action drive : DriveWheels { … }、then done;、flow produce.torque to drive.torque;を追加します。 - Action Flow ビューを作成します。振る舞い → アクションフローをクリックし、+ 新しいダイアグラムをクリックして、表示内容で
DriveCycleを選びます。 - 各手順を誰が実行するかを指定します。
perform action trip : DriveCycle;と、パートtank、engine、transmissionを持つpart def DrivenCarを追加し、各パートにperform trip.supply;、perform trip.produce;、perform trip.drive;のいずれかを付けます。ビューにパートごとのスイムレーンができます。 - 機能分析を開きます。振る舞い → 機能分析をクリックし、選択…をクリックして
DriveCycleを選びます。 - 別のアクションを宣言します。
action def EmergencyShutdown;を追加します。 - FFBD で手順を構築します。振る舞い → FFBDをクリックし、+ 新しいダイアグラムをクリックして、
EmergencyShutdownを選びます。追加パネルでOpen Contactorsと入力して Enter を押し、続いてCut Fuelと入力します。 - 手順をテキストで確認します。モデル → エディターをクリックします。FFBD が手順とそのサクセッションを書き込んでいます。
状態と遷移
スタータープロジェクトには、空の part def Car を持つパッケージ PowertrainBehavior があります。
- シグナルを定義します。
attribute def StartRequest;を追加し、StopRequest、PlugIn、Unplugも同じように追加します。 - 状態定義を書きます。
in attribute charge : Real;、entry; then off;、状態off、electric、hybridを持つstate def PowertrainStatesを追加します。 - 遷移を追加します。
state off;の後に、accept StartRequest if charge > 20 then electric;とaccept StartRequest then hybrid;を追加します。 - 状態にアクションを付けます。
state electric;を、entry action spinUpMotor;、do action driveElectric;、exit action holdMotor;を含む本体に置き換えます。 - electric 状態から出ます。その後に
if charge < 15 then hybrid;とaccept StopRequest then off;を追加し、state hybrid;の後にもaccept StopRequest then off;を追加します。 - 名前付きの遷移を持つ状態を追加します。
state charging { do action chargeBattery; }、transition plugIn first off accept PlugIn then charging;、transition unplugged first charging accept Unplug then off;を追加します。 - 状態遷移ビューを作成します。振る舞い → ステートマシンをクリックし、+ 新しいダイアグラムをクリックして、表示内容で
PowertrainStatesを選びます。 - 時間指定の遷移を描きます。
chargingのハンドルからoffまでドラッグし、遷移の上でドロップします。遷移パネルで、名前にcharged、トリガーにafter 30 [min]と入力します。 - テキストで確認します。モデル → エディターをクリックします。遷移は名前付きの遷移として書かれています。
- 車に状態を示させます。
Carにexhibit state powertrainStates : PowertrainStates;を追加します。
要求
スタータープロジェクトには、設計の小さなコピーを持つパッケージ VehicleRequirements があります:Battery、Car、車両保有群の sedan(車両重量 1580 kg)。
- 制限値に名前を付けます。
attribute maxCurbMass : MassValue = 1650 [kg];とattribute minBatteryCapacity : EnergyValue = 1.2 [kW*h];を追加します。 - 要求定義を書きます。
docの文、subject car : Car;、attribute limit : MassValue;、require constraint { car.curbMass <= limit }を持つrequirement def <'VR-1'> CurbMassを追加します。 - 要求を挿入します。空の行で ⌃⇧Space / Ctrl+Shift+Space を押し、要求定義を選んで、主体
battery : Batteryとrequire constraint { battery.capacity >= minBatteryCapacity }を持つVR-3 BatteryCapacityを書きます。 - 要求を仕様の中に入れ子にします。
subject car : Car;とrequirement <'VR-1.1'> sedanMass : CurbMass { attribute :>> limit = maxCurbMass; }を持つrequirement carSpecを追加します。 - 何がそれらを充足するかを指定します。
satisfy carSpec by fleet.sedan;とsatisfy requirement batterySpec : BatteryCapacity by fleet.sedan.battery;を追加します。 - 要求を破ります。セダンの車両重量を
1700 [kg]に変更します。エディターが satisfy にマークを付けます。セダンはもう VR-1.1 を満たしていません。 - 再び満たします。⌘Z / Ctrl+Z を押すか、
1580 [kg]に戻します。 - 要求の表を確認します。ニーズと要求 → 要求をクリックします。
- 要求ビューを作成します。ダイアグラムページで+ 新しいダイアグラムをクリックし、要求ビューを選んで、表示内容で
carSpecを選びます。 - 文をチェックします。ニーズと要求 → 品質をクリックし、品質をチェックをクリックします。
検証とトレーサビリティ
スタータープロジェクトには、車両重量の要求と車の仕様、手順 cruise と brake を持つドライブサイクル、VR-6 batteryMassLimit、VR-7 stopFromCruise があります。
- 検証ケースを書きます。
subject car : Car;、objective massObjective { verify carSpec.sedanMass; }、return verdict : Boolean = car.curbMass <= maxCurbMass;を持つverification def <'VC-1'> CurbMassTestを追加します。 - セダンに適用します。
verification <'VC-1.1'> sedanWeighing : CurbMassTest { subject car = fleet.sedan; }を追加します。 - 検証ケースを開きます。検証 → 検証ケースをクリックします。手順、結果、ステータスは、モデルの横にある Holarch のデータです。Sedan Weighing の行で+ ステップをクリックし、続いて+ ステップを追加をクリックして、Action の下に
Weigh the carと入力し、適用をクリックします。次に、ステータスボタンの合格をクリックします。 - RVTM を読みます。検証 → RVTM をクリックします。
- 手順を要求にトレースします。検証 → トレーサビリティマトリックスをクリックし、要求を行に、アクションを列に表示して、
stopFromCruiseとbrakeのセルをクリックし、satisfied by を選びます。 - 要求を導出します。
private import RequirementDerivation::*;とconnection batteryMassDerivation : Derivation connect carSpec.sedanMass to batteryMassLimit;を追加します。 - モデルチェックを実行します。検証 → モデルチェックをクリックします。
制約と計算
スタータープロジェクトには、エンジン、バッテリー、車、セダンの値と、目標値 maxCurbMass と minPowerToWeight を持つパッケージ VehicleAnalysis があります。
- 制約定義を書きます。
in mass : MassValue;、in limit : MassValue;、式mass <= limitを持つconstraint def MassLimitを追加します。 - 計算を書きます。パラメーター
powerとmass、return ratio = power / mass;を持つcalc def PowerToWeightを追加します。 - セダンの値をバインドします。
constraint sedanMassCheck : MassLimit { in mass = fleet.sedan.curbMass; in limit = maxCurbMass; }を追加します。 - パラメトリックビューを作成します。ダイアグラムページで+ 新しいダイアグラムをクリックし、パラメトリックビューを選んで、表示内容で
VehicleAnalysisを選びます。チェックは合格です。1580 kg は 1650 kg 以内です。 - チェックを不合格にします。セダンの車両重量を
1700 [kg]に変更します。ビューにチェックの不合格が表示されます。 - 再び合格させます。元に戻すか、
1580 [kg]に戻します。すべて解くで、すべての制約を再びチェックします。 - 解析ケースを実行します。
ratio >= minPowerToWeightを求める目的を持つanalysis def PowerToWeightAnalysisと、analysis sedanPowerToWeight : PowerToWeightAnalysis { subject car = fleet.sedan; }を追加します。 - 未確定の値をマークします。
private import HolarchMetadata::*;と、要求 VR-5ChargeTimeを追加します。その時間の制限値には#TBRを、充電器の電力にはオーナー、期限、根拠を持つ@TBDを付けます。TBDとTBRは SysML v2 標準ライブラリではなく、Holarch のHolarchMetadataライブラリのものです。これらは標準のStatusInfoメタデータを特殊化しています。 - TBD/TBR 登録簿を開きます。ニーズと要求 → TBD/TBR をクリックします。充電時間が、その
@TBDメタデータのオーナーと期限とともに一覧表示されます。登録簿は読み取り専用です。オーナーや日付は、エディターでメタデータを変更してください。 - 質量を集計します。アーキテクチャ → 予算と TPM をクリックし、ルートパート
sedanを選択します。
バリアントと構成
スタータープロジェクトには、Component、Battery、Controller、Car、Powertrain があります。
- 可変性パッケージをインポートします。
private import HolarchVariability::*;を追加します。 - バリエーションを書きます。空の行で ⌃⇧Space / Ctrl+Shift+Space を押し(または挿入 ▾をクリックし)、バリエーションを選んで、バリアント
standardPack(1.4 kWh)とlargePack(12 kWh、120 kg)を持つvariation part def BatteryPack :> Batteryを完成させます。 - プロダクトラインを書きます。
part pack : BatteryPack;、バリアントnoChargerとwallboxを持つvariation part charger、assert constraint wallboxNeedsLargePack { charger == charger::wallbox implies pack == BatteryPack::largePack }を持つpart def CarLine :> Carを追加します。 - 構成を開始します。挿入 ▾ → 構成を選び、
part plugInHybrid : CarLine { @HolarchConfiguration; }を記入します。エディターに、まだ決まっていない可変点が示されます。 - バリアントを選びます。
plugInHybridの中で、可変点ごとに挿入 ▾ → バリアントの選択を選び、part :>> pack = BatteryPack::largePack;とpart :>> charger = charger::wallbox;を記入します。 - 2 つ目の構成を追加します。同じ方法で、標準パックで充電器なしの
selfChargingHybridを追加します。 - 独自のキーワードを定義します。
metadata def <safetyCritical> SafetyCriticalを追加します。 - キーワードを使います。
Powertrainの中に#safetyCritical part controller : Controller;と書きます。 - プロダクトラインを確認します。
Vehiclesの General View を作成します。バッテリーパックにバリエーションのマークが付いています。
チュートリアルプロジェクト
SysML v2 のチュートリアルプロジェクトは、他のチュートリアルプロジェクトと同じルールに従います。プランのアクティブなプロジェクトには数えられず、最大 300 項目を保持でき、チュートリアルごとに 1 つ持てます。チュートリアルを参照してください。
関連
SysML® および OMG® は、米国およびその他の国における Object Management Group, Inc. の登録商標です。