Holarch

SysML v2

SysML v2 テキスト表記

Holarch がサポートする SysML v2 言語を、Hybrid Car デモの例、実行されるチェック、読み取り専用の標準ライブラリとともに説明します。

使い方 →

このページの内容
  1. 概要
  2. 概念
    1. 要素、所有者、修飾名
    2. パッケージ
    3. インポートと可視性
    4. 定義と使用
    5. 型付け、特殊化、再定義
    6. 多重度
    7. 値と単位
    8. 構造:ポート、接続、インターフェース、バインディング、フロー
    9. 振る舞い:アクション
    10. 振る舞い:状態
    11. 要求、制約、検証
    12. ユースケース
    13. ビュー
    14. コメント、ドキュメント、メタデータ
    15. 個体、スナップショット、タイムスライス
    16. バリエーション、バリアント、構成
    17. テキスト表現
  3. 使い方
    1. 構造をモデル化する
    2. 単位付きの値を与える
    3. 振る舞いを記述する
    4. 要求を書いてトレースする
    5. 値を TBD または TBR としてマークする
    6. ライブラリの名前を探す
  4. 例:セダンの要求を読む
  5. ヒントとよくある間違い
  6. Holarch の対応範囲
    1. 書かれたまま保持され、解釈されないもの
    2. まだ利用できません
  7. チェック
  8. 標準ライブラリ
  9. 制限事項
  10. 関連ページ

概要

SysML v2 は、システムを名前付き要素のツリーとしてテキストで記述します。Holarch は、OMG SysML v2 仕様に基づく SysML v2 テキスト表記をサポートします。テキストはエディターで書き、Holarch は同じ要素をブラウザー、ビュー、表、ライフサイクルのページに表示します。

このページでは、Hybrid Car (SysML v2) デモの例を使って表記法を説明します。続いて、Holarch がサポートする範囲、テキストに対して実行するチェック、標準ライブラリを示します。

概念

要素、所有者、修飾名

最上位のパッケージを除き、すべての要素には所有者が 1 つあります。要素の修飾名は、所有者の名前を :: でつないだものです。デモでは、パワートレイン定義のバッテリーは Vehicles::Powertrain::battery です。

空白などの特殊文字を含む名前は単一引用符で囲みます:'Fuel Tank'。山かっこ内のショートネームは、要素に 2 つ目の短い識別子を与えます:requirement def <'VR-1'> CurbMass。Holarch は要求のショートネームをその番号として使います。

パッケージ

パッケージは、フォルダーのように要素をまとめます。パッケージは入れ子にできます。最上位のパッケージはそれぞれエディターの 1 つのドキュメントです。

package Vehicles {
    doc /* A hybrid passenger car: structure, interfaces and variants. */

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

インポートと可視性

インポートは、別のパッケージのメンバーを短い名前で参照できるようにします。

  • import ISQ::*; は ISQ のメンバーをインポートします。
  • import VehicleRequirements::**; は、入れ子になった要素のメンバーもインポートします(再帰的)。
  • import Vehicles::Car; は 1 つの要素をインポートします。
  • import Vehicles::*[@SysML::PartDefinition]; は、1 つの種類のメンバーだけをインポートします(フィルター付きインポート)。

private、protected、public は、メンバーやインポートを他の誰が参照できるかを設定します。デモでは private import と書き、インポートが、そのパッケージをさらにインポートするパッケージへ引き継がれないようにしています。

インポートしない場合は修飾名を書きます。ISQ::MassValue はどこでも解決されますが、MassValue は ISQ をインポートした場所でだけ解決されます。

alias は要素に 2 つ目の名前を与えます:alias Hybrid for Car;。

定義と使用

定義は、ものの種類を記述します。使用は、別の要素の中での定義の 1 回の使用です。ほとんどのキーワードには両方の形があります:

定義使用内容
part def Battery;part battery : Battery;システム、サブシステム、コンポーネント
attribute def TirePressure;attribute mass : MassValue = 45 [kg];値(多くは単位付き)
item def Fuel;item fuel : Fuel;流れるもの、または扱われるもの
port def FuelPort { … }port fuelOut : FuelPort;パート上の接続点
connection def … / interface def FuelLine { … }interface fuel : FuelLine connect …;パートやポートの間のリンク
action def ProduceTorque { … }action produce : ProduceTorque;振る舞い:入力を受け取り出力を出す手順
state def PowertrainStates { … }state off;振る舞い:状態とその遷移
constraint def MassLimit { … }constraint …;値に対するブール条件
calc def PowerToWeight { … }calc …;return 値を持つ計算
requirement def <'VR-1'> CurbMass { … }requirement <'VR-1.1'> sedanMass : CurbMass;要求
use case def DriveToWork { … }use case commute : DriveToWork;ユースケース
analysis def PowerToWeightAnalysis { … }analysis sedanPowerToWeight : …;解析ケース
verification def CurbMassTest { … }verification sedanWeighing : CurbMassTest;検証ケース
view def RequirementsView { … }view driveCycleFlow : ActionFlowView { … }モデルのビュー
enum def DriveMode { … }attribute mode : DriveMode;固定された値の集合

定義の中に入れ子になったメンバーは、その定義のすべての使用に属します。part frontAxle : Axle; は、Axle の differential、leftWheel、rightWheel を繰り返し書かなくても持ちます。

型付け、特殊化、再定義

4 つの演算子が定義と使用を関係付けます。それぞれにキーワードの形もあります。

演算子キーワード意味例
:defined by使用を定義で型付けするpart engine : Engine;
定義での :>specializesその定義はもう一方の定義の一種で、そのメンバーを継承するpart def FuelTank :> Component
使用での :>subsetsその使用は別の使用のサブセットであるpart spareWheel :> wheels;
:>>redefines継承した使用を置き換える(たとえば値を与えるため)attribute redefines mass = 18 [kg];
~ポートを共役にする:その in と out のフィーチャーが入れ替わるport fuelIn : ~FuelPort;

再定義は、バリアントや構成されたパートが継承したものを変える方法です。デモでは、SportCar がスペアタイヤを再定義して取り除いています:

part def SportCar :> Car {
    attribute topSpeed : SpeedValue = 210 [km/h];
    part redefines spare [0];
}

abstract は、直接のインスタンスを持たない定義を示します(abstract part def Component)。ref は、所有されない参照を示します。in、out、inout は、フィーチャーやパラメーターの方向を設定します。end は、接続定義やインターフェース定義の端を示します。

多重度

角かっこ内の多重度は、いくつあるかを示します。

  • [2]:ちょうど 2 つ。part runabout : CityCar [2];
  • [0..1]:省略可能。part spare : Wheel [0..1];
  • [1..*] と [*]:1 つ以上、任意の数。
  • [0]:なし。継承したパートを取り除くために使います。
  • 境界には式を使えます。ordered と nonunique は角かっこの後に続けます。

値と単位

= は値をバインドします。:= は変更可能な初期値を与えます。default は、再定義で置き換えられる既定値を与えます。

attribute maxCurbMass : MassValue = 1650 [kg];
attribute minBatteryCapacity : EnergyValue = 1.2 [kW*h];
attribute minPowerToWeight = 40 [W/kg];
attribute topSpeed : SpeedValue = 210 [km/h];

量は、数値と角かっこ内の単位です。単位は *、/、^ で組み合わせます([m/s^2])。MassValue などの量の種類は ISQ から、kg などの単位は SI(または USCustomaryUnits)から得られます。Holarch は次元をチェックします。5 [s] を MassValue に代入するとエラーになります。

式では、算術、比較(<=、==)、論理演算子(and、or、not、implies)、条件式 if c ? a else b、フィーチャーチェーン(car.powertrain.battery.capacity)、計算の呼び出し(PowerToWeight(power, mass))、->sum、->size、->select、->collect などのシーケンス操作を使います。Holarch は、値、制約、ビュー、分析ページのために、単位付きでこれらを評価します。

構造:ポート、接続、インターフェース、バインディング、フロー

パートはポートを通じて接続します。

part def Powertrain {
    part tank : FuelTank;
    part engine : Engine;
    interface fuel : FuelLine connect tank.fuelOut to engine.fuelIn;
    connect controller.engineCtl to engine.ecu;
    port output : TorquePort;
    bind output = transmission.output;
}
  • connect a to b; は 2 つのパートまたはポートをつなぎます。
  • インターフェースは、ポート間の型付きの接続です。その定義で端に名前を付けます:interface def FuelLine { end supply : FuelPort; end consumer : ~FuelPort; }。
  • 接続やインターフェースの各端には、名前と多重度を付けられます:interface motorShaft : Shaft connect [1] driver ::> motor.output to [1] driven ::> transmission.motorIn;。名前付きの端は接続のフィーチャーなので、motorShaft.driver でそれを参照できます。
  • bind a = b; は、2 つのフィーチャーが同じであることを示します(バインディングコネクター)。
  • flow of Fuel from supply.fuel to produce.fuel; は、アイテムをあるフィーチャーから別のフィーチャーへ運びます。message は、アイテムをイベントとしてパート間で送ります。

振る舞い:アクション

アクション定義は、その手順(アクションの使用)、パラメーター、手順の順序を保持します。

action def DriveCycle {
    in attribute targetSpeed : Real;
    first start then switchOn;
    action switchOn { attribute duration : DurationValue = 2 [s]; }
    then fork split;
    then supply;
    then produce;
    action supply : SupplyFuel;
    action produce : ProduceTorque;
    flow of Fuel from supply.fuel to produce.fuel;
    first supply then ready;
    first produce then ready;
    join ready;
}
  • サクセッションは手順の順序を決めます:first a then b;、または a の直後の then b;。start と done は始まりと終わりです。
  • 制御ノード:並行パスには fork と join、選択肢には decide と merge を使います。判断の後のガード付きサクセッションは if speed > 30 then cruise; と書き、else brake; が既定の分岐です。
  • 終了:terminate; は、囲んでいるアクションを、まだ実行中の手順も含めて直ちに終了します。then terminate; は、それを前の手順の後に置きます。terminate x; はオカレンス x を終了します。
  • その他のアクション:accept はシグナルを待ち、send はシグナルを送り、assign x := expr; は値を変更し、if はブロックを実行するかスキップし、while … { … } until …; と for v in seq { … } はブロックを繰り返します。
  • 振る舞いの割り当て:パートはアクションを perform します(perform action trip : DriveCycle;、perform trip.supply;)。allocate a to b; は、ある要素を別の要素に割り当てます。

振る舞い:状態

状態定義は、状態とその間の遷移を保持します。

state def PowertrainStates {
    entry; then off;
    state off;
    accept StartRequest then hybrid;
    state hybrid {
        entry action startEngine;
        do action driveHybrid;
        exit action stopEngine;
    }
    transition recharged first hybrid if charge > 60 then electric;
}
  • entry; then off; は開始状態を設定します。
  • 遷移には、トリガー(accept StartRequest)、省略可能なガード(if charge > 20)、省略可能な効果(do …)があります。短い形は遷移元の状態の後に書きます。長い形は transition name first a … then b; です。
  • モデルでは、遷移のトリガーと効果はそれ自体が要素です:受理アクションと、アクション(send、assign、perform、terminate、または名前付きのアクション)。ブラウザーでは、遷移の下に trigger と effect として表示されます。これらは遷移自身の accepter と effect なので、モデルの他の部分から名前で参照できます。chargerStates.plugIn.effect.sentMessage は、シーケンスモデルがバインドするとおり、効果が送るメッセージです。
  • ポートを経由するトリガーは、そのポートが運ぶものを受理する必要があります。デモの ChargeManager では、accept connectCharger : ChargerConnected via chargePort がポートの in connected : ChargerConnected に一致します。効果 send new ChargeRequest() to controller はパートに送ります。属性などの値はメッセージを受け取れません。
  • entry、do、exit アクションは、状態に入るとき、状態にある間、状態を出るときに実行されます。parallel 状態には、すべてが同時にアクティブになる領域があります。
  • パートは状態を exhibit します:exhibit state powertrainStates : PowertrainStates;。

要求、制約、検証

要求は、その文を doc に、適用対象の要素を subject に、チェック可能な条件を require constraint に保持します。

requirement def <'VR-1'> CurbMass {
    doc /* The car's curb mass shall not exceed the mass limit. */
    subject car : Car;
    attribute limit : MassValue;
    require constraint { car.curbMass <= limit }
}

satisfy carSpec by fleet.sedan;
  • assume constraint は、要求が前提とする条件を述べます。それが成り立たない場合、その要求と、その中に入れ子になった要求は満たされたものとして数えられます。それを囲む要求と、他の入れ子の要求は引き続きチェックされます。actor、stakeholder、frame concern は、要求が誰のため、何のためのものかを示します。
  • satisfy R by part; は、パートが要求を満たすことを示します。
  • 検証ケースは、その目的の中で要求を検証します:objective { verify carSpec.sedanMass; }。return verdict : Boolean = …; を返すこともできます。
  • 解析ケースには、主体、目的、そして return の結果があり、Holarch はすべての入力に値があるときにその結果を評価します。値のないケースの属性は、目的の == 方程式から解かれます(未知数を含む解析ケース)。
  • connection : Derivation connect original to derived; は導出された要求を記録します。#refinement dependency x to R; は詳細化を記録します。
  • dependency from a to b; は一般的なトレースを記録します。

ユースケース

use case def DriveToWork { subject car : Car; actor driver : Driver; objective { … } include use case startCar : StartCar; }。ユースケースの使用は、その定義の主体とアクターを引き継ぎます。

ビュー

ビューはモデルの一部を表示します。ビューは標準のビュー定義で型付けされ、表示するものを expose します:

view driveCycleFlow : StandardViewDefinitions::ActionFlowView {
    expose DriveCycle;
}

filter は要素を絞り込みます(filter @SysML::RequirementUsage;)。render はレンダリングを選びます。viewpoint は、ビューが扱うべき関心事を定めます。各ビューの種類は SysML v2 のビューで説明しています。

コメント、ドキュメント、メタデータ

  • doc /* text */ はその所有者を文書化します。これはモデルの一部で、要求では要求文になります。
  • comment about x /* text */ は、別の要素についてのモデル内のメモです。
  • // text と //* text */ はテキスト内だけのメモです。Holarch はテキストにそれらを保持しますが、モデル要素ではありません。
  • メタデータは要素に注釈を付けます。本体の中では @TBD { owner = "Powertrain lead"; }、接頭辞としては #TBR attribute limit …、外部からは metadata Capability about Vehicles::Car; と書きます。
  • ユーザー定義のキーワード:どのメタデータ定義もキーワードとして使えます。#safetyCritical part controller : Controller; は、コントローラーにメタデータ SafetyCritical(ショートネーム <safetyCritical>)を付けます。メタデータ定義は、付ける対象を制限できます。:>> annotatedElement : SysML::PartDefinition; はパート定義だけを許可します。
  • セマンティックメタデータ:SemanticMetadata を特殊化するメタデータ定義は、基底型を設定します(:>> baseType = faults meta SysML::Usage;)。そのメタデータが付いたすべての要素は基底を特殊化します。使用は基底の使用をサブセット化し、定義は基底の定義または基底の使用の定義を特殊化します。そのため、#fault def BatteryOverheat; と #fault overheat : BatteryOverheat; はフォールトになり、Fault のフィーチャーを持ちます。セマンティックメタデータでは、この 2 行のように言語のキーワードを省略できます。ブラウザーはそれらをキーワード付き(#fault def)で表示します。外部から metadata Fault about x; と書いても x はフォールトになりません。チェックが警告し、x 自体に #fault を付けるよう提案します。
  • 独自の意味を持つメタデータ:メタデータ定義のフィーチャーは、それを使うたびに指定しなければならないもので、その制約はそれらに対して成り立つ必要があります。metadata def SafetyRating { attribute level : Natural; assert constraint { level >= 1 and level <= 4 } } の場合、チェックは @SafetyRating;(level なし)と @SafetyRating { level = 7; }(範囲外)を報告します。@SafetyRating { level = 4; } は問題ありません。定義で値や default を持つフィーチャー、または [0..1] と宣言されたフィーチャーは省略できます。各値はそのフィーチャーの型に合う必要があります:Boolean には true または false、String には引用符で囲んだテキスト、Integer には整数(Natural は 0 以上、Positive は 0 より大きい値)、列挙には HazardAnalysis::fmea のようなその値の 1 つ。チェックは、それ以外の値や、合わない定義の既定値を報告します。メタデータの本体は定義のフィーチャーに値を与えるだけで(level = 4;)、abstract metadata def は適用できません。Hybrid Car デモでは、コントローラーを @SafetyRating { level = 4; } と評価し、バッテリーのレビューを @SafetyReview { method = HazardAnalysis::fmea; closed = true; } として記録しています。エディターでは、挿入 ▾ → メタデータ定義でフィーチャーとルールを持つ定義を始め、メタデータを適用で本体の中に適用します。テキストを書かずに行うには、定義または使用を選択し、インスペクターのメタデータセクションを使います。メタデータを追加はプロジェクトのメタデータ定義の 1 つを適用します。すると各フィーチャーにフィールドができます(列挙や Boolean には値の一覧、String にはプレーンテキストで、Holarch が引用符で囲んで書きます。定義の既定値はヒントとして表示され、既定値のないフィーチャーには「必須」のマークが付きます)。そのメタデータに対するチェックの指摘事項はその下に表示されます。除去で外します。変更はそれぞれ 1 回の元に戻すで取り消せます。標準ライブラリのメタデータと Holarch 独自のメタデータ(シミュレーション、目的、可変性)は、それぞれ専用のコントロールを持ち、ここには一覧表示されません。

個体、スナップショット、タイムスライス

個体(individual)は、ものの種類ではなく、その一生全体にわたる特定の 1 つのもの(たとえばシリアル番号を持つ 1 台の車)です。スナップショットはある瞬間のそのものであり、タイムスライスはその一生のある期間です。どちらもそれを所有するオカレンスに属し、そのフィーチャーを持つので、それらのフィーチャーに独自の値を与えられます。

individual part def Car_VIN1234 :> Car {
    snapshot atDelivery { attribute :>> mileage = 0 [km]; }
    timeslice firstOwner { attribute ownerName : String = "Dana Reyes"; }
    snapshot atService { attribute :>> mileage = 15000 [km]; }
    first atDelivery then atService;
    assert constraint mileageGrows { atDelivery.mileage <= atService.mileage }
}
  • individual は種類のキーワードの前に置くか(individual part def、individual item def)、単独で使います(individual def Plate_77;)。individual と書かれた使用は、ちょうど 1 つの個体定義で型付けされます:individual car1 : Car_VIN1234;。
  • snapshot と timeslice は、パート、アイテム、アクション、その他のオカレンスの中で、種類のキーワードの前に置くか単独で使います。then timeslice secondOwner; は、タイムスライスをその前のメンバーの後に順序付けます。
  • スナップショットやタイムスライスの中の値は、まずそこで読まれ、次に個体から、次にその定義から読まれます。この例では、atService.mileage は 15,000 km で、制約は成り立ちます。
  • 個体、スナップショット、タイムスライスになれるのはオカレンスだけです。属性と列挙は値です。
  • アーキテクチャ → パートのデータベースビューとグリッドビューでは、インスタンス列に各パートの定義の個体が一覧表示されます(part sedan : Car の場合は Car_VIN1234)。それを特殊化する個体定義と、それが型付けする個体の使用です。Individual(Yes)とポーション(portion)(Snapshot または Time slice)も列として使えます(列 ▾ → SysML v2)。モデルに個体が 1 つでもあると、パートには既定でインスタンスが表示され、表(CSV)のエクスポートにはこの 3 つの列が含まれます。定義のエクスポートでは、それらを持つ要素ごとに一覧表示されます。
  • インスペクターでは、フィーチャーの下のオカレンスでIndividualを設定し、使用の場合はWhole life、Time slice、スナップショットのいずれかを設定します。ブラウザーの種類フィルターにはIndividualsがあり、行の⋯メニューには新しいスナップショット…と新しいタイムスライス…があります。General View は、ボックスのヘッダーに «individual part def»、«snapshot»、«timeslice» を表示し、ボックスのスナップショットとタイムスライスを専用の区画に一覧表示し、ボックス間のサクセッションを破線の矢印で描きます。整列 ▾ → タイムラインとして配置で、それらを左から右に並べます。Hybrid Car デモでは、General View carLifeline に Car_VIN1234 のスナップショットとタイムスライスが表示されます。

バリエーション、バリアント、構成

バリエーションは、設計のある 1 点で許される選択肢を一覧にしたもので、各選択肢がバリアントです。バリエーション定義(variation part def)は再利用できる選択肢の集合で、バリエーションの使用(variation part charger)は 1 つの設計の中の 1 点です。構成は、各点に対してバリアントを 1 つ選びます。

variation part def BatteryPack :> Battery {
  variant part standardPack { attribute :>> capacity = 1.4 [kW*h]; }
  variant part largePack { attribute :>> capacity = 12 [kW*h]; }
}
part def CarLine :> Car {
  part pack : BatteryPack;
  variation part charger : Component {
    variant part noCharger;
    variant part wallbox;
  }
  assert constraint wallboxNeedsLargePack { charger == charger::wallbox implies pack == BatteryPack::largePack }
}
part plugInHybrid : CarLine {
  @HolarchConfiguration;
  part :>> pack = BatteryPack::largePack;
  part :>> charger = charger::wallbox;
}
  • バリアントはそのバリエーションのフィーチャーを持ち、それらを再定義できます。BatteryPack は Battery なので、largePack には capacity があります。
  • 種類のキーワードのない variant x; は、既存の使用 x を選択肢の 1 つにします。その名前は x に由来します。
  • バリエーションが所有するのはバリアント(と定義、コメント、メタデータ、インポート)だけです。バリエーションはもともと抽象なので、それに付けた abstract は冗長として注記されます。
  • バリアントは値で選びます:part :>> pack = BatteryPack::largePack;。その点のバリアントではない選択はエラーになります。
  • ある点に選択がない間、その値は不明なので、それに対するアサーションは満たされも違反もされません。構成では、選ばれたバリアントの値が使われます。
  • 構成には @HolarchConfiguration(パッケージ HolarchVariability、標準ライブラリの Holarch の下)を付けます。するとエディターが、まだ選んでいない各点を注記します。
  • エディターでは、挿入 ▾でこれらをそれぞれ書けます:バリエーション(パッケージレベルでは定義、パートの中では点)、バリアント(バリエーションの中)、構成とバリアントの選択(構成の中)。
  • Hybrid Car デモでは、CarLine に 2 つの点(pack と charger)があり、selfChargingHybrid と plugInHybrid がその構成です。アサーションにより、標準パックとウォールボックスの組み合わせは除外されます。

テキスト表現

テキスト表現は、要素を別の言語で書いたものです。要素の本体の中に rep language "Python" /* … */ と書きます。本体はテキストとして保持されます。モデルはそれを囲む SysML が宣言する内容であり、Holarch が本体を実行することはありません。

  • Hybrid Car デモでは、DriveWheels がその計算を Python で持っています:rep language "Python" /* wheel_speed = torque.value * GEAR_RATIOS[gear] / WHEEL_RADIUS */。
  • "sysml" または "kerml" の本体はチェックされます。SpeedLimit は rep language "sysml" /* speed <= limit */ と書かれており、Holarch は直接書かれた制約と同じようにそれを評価します。
  • エディターは、SysML と KerML の本体を色付きの背景上でコードとして強調表示します。他の言語はコメントのテキストとして表示されます。
  • インスペクターの表現セクションには、各表現がその言語と本体とともに一覧表示されます。定義または使用で表現を追加をクリックすると追加でき、除去で削除できます。
  • Action Flow ビューでは、定義が表現を持つアクションに、その言語が波かっこ付きで表示されます(たとえば {Python})。
  • 既知の言語:SysML、KerML、OCL、Alf、Python、JavaScript、MATLAB、Modelica、C、自然言語(naturalLanguage、English、text)。名前の後のバージョンは無視されます(OCL2.0、Python 3)。
  • 本体には */ を含められません。コメントが終わってしまうためです。

Holarch 独自のディスカッションコメント、ラベル、担当者、期限はモデルの横に保持されます。テキストには書き込まれません。

使い方

構造をモデル化する

  1. エディターでパッケージを開きます(または+ 新しいパッケージをクリックします)。
  2. 接続点の種類ごとに、方向付きのフィーチャー(out attribute torque : TorqueValue;)を持つ port def を書きます。
  3. コンポーネントの種類ごとに、その属性とポートを持つ part def を書きます。
  4. アセンブリの part def を書き、コンポーネントごとに part を置きます。
  5. パートを接続します:connect a.p to b.q;、または interface name : Def connect a.p to b.q;。
  6. 入力を止めます。ステータス行に適用済みと表示され、ブラウザーに新しい要素が表示されます。

挿入 ▾(または ⌃⇧Space / Ctrl+Shift+Space)で、これらの構文を記入用のフィールド付きで書けます。構文を挿入するを参照してください。

単位付きの値を与える

  1. パッケージの先頭で量の種類と単位をインポートします:private import ISQ::*; と private import SI::*;。
  2. 属性を量の種類で型付けし、値を与えます:attribute mass : MassValue = 45 [kg];。
  3. 属性を継承する定義では、独自の値で再定義します:attribute redefines mass = 18 [kg];。
  4. 値にポインターを合わせます。単位が量の種類に合わない場合は、エラーカードが表示されます。

振る舞いを記述する

  1. in と out のパラメーターを持つ action def を書きます。
  2. action の使用ごとに手順を追加し、first … then …; または then で順序を決めます。
  3. 並行する手順には fork と join を、選択肢には decide と merge を使います。
  4. アイテムを受け渡す手順の間に flow of Item from a.out to b.in; を追加します。
  5. 振る舞いを実行するパートに perform action name : Def; を書き、そのパートの中のパートに perform name.step; を書きます。
  6. アクションを Action Flow ビューで開くと、描画された状態で確認できます(SysML v2 のビューを参照)。

要求を書いてトレースする

  1. requirement <'ID'> name { doc /* The system shall … */ subject s : Def; } と書きます。
  2. 要求を値に対してチェックできる場合は、require constraint { … } を追加します。
  3. 設計がそれを満たす場所に satisfy name by somePart; を書きます。
  4. 目的でそれを verify する verification を書きます。
  5. ニーズと要求 → 要求を開きます。要求がその番号とともに一覧表示され、検証 → RVTM にその検証方法が表示されます。SysML v2 プロジェクトの要求と検証を参照してください。

値を TBD または TBR としてマークする

値の代わりに TBD と書くのは有効な SysML ではありません。代わりに Holarch のメタデータを使います。

  1. インポートします:private import HolarchMetadata::*;。
  2. 属性に接頭辞を付けます:#TBD attribute chargerPower : PowerValue;(まだ値がない)または #TBR attribute limit : TimeValue = 0.5 [h];(レビューが必要な値)。
  3. オーナーと理由を記録するには、属性の本体に長い形を書きます:@TBD { owner = "Powertrain lead"; rationale = "The charging standard is not chosen yet."; due = "2026-12-01"; }。

TBD/TBR 登録簿にはこれらの値が一覧表示されます。TBD と TBR は ModelingMetadata::StatusInfo を特殊化しているので、他の SysML v2 ツールはそれらをステータスの注釈として読みます。挿入 ▾ → TBD 値とTBR 値でこれらを書けます。

ライブラリの名前を探す

  1. レールツールから標準ライブラリを開きます。
  2. パッケージまたは定義を検索…に名前の一部(たとえば MassValue)を入力します。
  3. 行の名前をコピーをクリックします。修飾名(ここでは ISQBase::MassValue)がコピーされます。
  4. それをエディターに貼り付けるか、そのパッケージをインポートして短い名前を使います。

例:セダンの要求を読む

この例では、Hybrid Car デモのテキストで 1 つの要求をたどります。

  1. デモを開き、エディターのパッケージ一覧で VehicleRequirements を選びます。
  2. requirement def <'VR-1'> CurbMass を探します。その require constraint { car.curbMass <= limit } は、主体の車両重量を limit と比較します。
  3. requirement carSpec を探します。これは requirement <'VR-1.1'> sedanMass : CurbMass { attribute :>> limit = maxCurbMass; } を保持しています。この使用は、limit をパッケージレベルの目標値 maxCurbMass = 1650 [kg] で再定義しています。
  4. satisfy carSpec by fleet.sedan; を探します。sedan を ⌘ / Ctrl を押しながらクリックすると、エディターが Vehicles の part sedan : Car の位置を開きます。そこでは attribute redefines curbMass = 1580 [kg]; が値を与えています。
  5. VehicleRequirements に戻り、verification def CurbMassTest を探します。その目的 verify carSpec.sedanMass; により、これは VR-1.1 の検証ケースになり、verification sedanWeighing : CurbMassTest { subject car = fleet.sedan; } がそれをセダンに適用します。
  6. Vehicles で 1580 [kg] を 1700 [kg] に変更し、入力を止めます。セダンは 1650 kg の制限を超え、エディターは VehicleRequirements に、要求が sedan によって満たされていないという警告を、偽となった制約とその値とともに表示します。⌘Z / Ctrl+Z で元に戻します。

ヒントとよくある間違い

  • 「…」はここでは定義されていません。名前のつづりが間違っているか、そのパッケージがインポートされていません。private import Package::*; を追加するか、修飾名を書きます。
  • ; がない。各宣言は ; または { … } の本体で終わります。The declaration does not end. Add ; or a { … } body.(宣言が終わっていません。; または { … } の本体を追加してください)
  • :> と :>> の違い。特殊化やサブセット化には :> を、継承したフィーチャーの置き換えには :>> を使います。継承していないフィーチャーを再定義すると、「x」は「y」に継承されていません。と表示されます。
  • 単位にはインポートが必要です。5 [kg] は SI が見える場所でだけ解決されます。
  • 同じ名前の 2 つのメンバー。「x」はこの名前空間ですでに使われています。どちらかの名前を変更します。バリアントの場合は代わりに再定義します。
  • 目的の外の verify。検証ケースの objective { verify R; } の中に入れます。
  • 名前としてのキーワード。part、state、action などの語は予約されています。引用符で囲む('state')か、別の名前を選びます。

Holarch の対応範囲

Holarch は SysML v2 テキスト表記の次の部分をサポートします。エディターはそのすべてをチェックし、モデルはそれらを保持します。

領域対応
パッケージと名前空間package、入れ子のパッケージ、library package(読み取り専用)、doc、comment … about、メモ // と //* */、alias … for …、public/private/protected、ショートネーム <'1.2'>、引用符付きの名前
インポートメンバーシップインポートと名前空間インポート、::*、再帰的な ::**、フィルター付きインポート [@Kind]
定義と使用part, attribute, item, port, connection, interface, flow, action, state, requirement, constraint, calc, use case, analysis, verification, view, viewpoint, concern, enum, occurrence, allocation, metadata; ref, abstract, in/out/inout, end
特殊化:>/specializes、:/defined by、:>/subsets、:>>/redefines、共役 ~、disjoint、フィーチャーチェーン a.b.c
多重度[n]、[n..m]、[*]、[0..*]、ordered、nonunique、境界としての式
値と単位=、:=、default、量 5 [kg]、単位式 [m/s^2]、標準ライブラリの ISQ の量の種類と SI 単位およびヤード・ポンド法単位、次元のチェック
構造ポートと共役ポート、connect、端を持つインターフェース、多重度付きの名前付きコネクター端、bind、flow of T from … to …、message
アクションパラメーター、perform、サクセッション(first … then …、then)、fork、join、decide、merge、ガード、accept、send、assign、if、while、for、loop、start、done、terminate
状態entry/do/exit、トリガー、ガード、効果を持つ遷移、parallel 状態、入れ子の状態、exhibit
要求subject、actor、stakeholder、require constraint、assume constraint、frame concern、satisfy … by …、verify、ID としてのショートネーム、要求文としての doc
制約と計算制約と計算の定義と使用、return、assert constraint、呼び出し、算術・比較・論理・if ? else・シーケンス操作を含む KerML 式、単位付きの評価
ユースケース、分析、検証subject、actor、objective、include use case、return の結果を持つ解析ケース、verify と判定を持つ検証ケース
ビューview、view def、expose(::*、::**、フィルター付き)、filter、viewpoint、frame、render、標準のビュー定義
割り当てとトレースallocate a to b、割り当て定義、dependency from … to …
個体individual の定義と使用、snapshot と timeslice(then の後も可)、それらの値とサクセッション
可変性variation の定義と使用、variant メンバーとバリアント参照(variant x;)、値による選択、@HolarchConfiguration(HolarchVariability)を付けた構成
メタデータ@Name { … }、#Name 接頭辞、metadata Name about …、Holarch の HolarchMetadata(TBD、TBR)と HolarchFrameworks パッケージ、ユーザー定義の metadata def、ユーザー定義のキーワードとセマンティックメタデータ(#fault def …)

書かれたまま保持され、解釈されないもの

Holarch は次の構文を書かれたとおりに読み取って保持しますが、独自の意味は与えません:

  • SysML と KerML 以外の言語によるテキスト表現(テキストとして保持。テキスト表現を参照)。

まだ利用できません

  • KerML ファイル(.kerml)のインポート。
  • Systems Modeling API を通じた main へのコミット、タグ、マージ:他のツールは変更要求のブランチにコミットし、承認者がそれを Holarch で適用します(SysML v2 プロジェクトの API と MCPを参照)。
  • ユーザー定義のキーワードとセマンティックメタデータを超える言語拡張。

チェック

Holarch は入力中にテキストをチェックします。各問題はエディターの余白にマークされ、下線が引かれます。メッセージは問題を述べ、続いて修正方法を示します。エラーがあるとメンバーは適用されませんが、警告では適用されます。

領域チェック内容メッセージの例
構文文字、コメント、文字列、波かっこ、;、期待される名前とトークンこの波かっこには対応するものがありません。対応する { または } を追加するか、これを削除してください。
名前未解決、曖昧、無効、重複(警告)、private の名前「Batery」はここでは定義されていません。つづりを確認するか、そのパッケージをインポートしてください。
型付けと特殊化循環。正しい種類の定義による型付けと特殊化。フィーチャーのサブセット化と再定義。継承したフィーチャーだけの再定義「capacity」は「Car」に継承されていません。その型を特殊化するか、代わりに :> でサブセット化してください。
多重度有効な整数の境界。再定義するものより広くない再定義多重度 [3..1] は無効です。下限には 0 から上限までの値を使ってください。
単位と値次元の一致、単位の欠落、単位名、数値の型単位が一致しません:kg と s。一方を互換性のある単位に変換してください。
式構文、オペランドの型、計算の引数、ブール条件条件は true または false である必要がありますが、数値になっています。x > 0 のような比較を書いてください。
構造接続の端はフィーチャーであること、インターフェースはポートを接続すること、ポート・フロー・メッセージの方向、フローのアイテムの型、バインディングの型これらのポートの方向は合いません。一方のポートを共役にする(~)か、方向を変更してください。
アクション同じ本体のアクション間のサクセッション、制御ノードの入出力の数、判断のガードと else、start と done、代入、perform の対象、for ループが反復する値とループ変数の型の整合then にはその前のアクションが必要です。アクションまたは first … then … を追加してください。
状態同じ本体の状態間の遷移、entry/do/exit がそれぞれ 1 つ、開始遷移、並行領域、exhibit の対象、遷移の do 効果(受信できるものへの send、assign、accept、action、または名前付きのアクション)、トリガーのペイロードとポートのアイテムの整合、Real のようなライブラリの値そのものに対するトリガー(警告)、時刻を指定する at トリガー「electric」にはサブ状態がありますが開始遷移がないため、どのサブ状態にも入りません。entry; then <first state>; を追加してください。
要求、ケース、ビュー正しい場所にあるメンバー、主体が 1 つ、satisfy/verify/require の対象、主体の型、expose と import の対象、frame の対象verify は検証ケースの目的の中に置きます。objective { … } の中に移動してください。
テキスト表現SysML と KerML の本体が解析でき、表現する要素を宣言していること。未知の言語は注記されます「SpeedLimit」の表現は、制約定義ではなくパート定義を宣言しています。本体で「SpeedLimit」自体を宣言してください。
個体、スナップショット、タイムスライスindividual はオカレンスにだけ、ちょうど 1 つの個体定義とともに使う。snapshot/timeslice はオカレンスの中のオカレンスの使用にだけ使う。スナップショットの中のタイムスライス(警告)「parked」は individual ですが、その定義はどれも individual ではありません。個体定義で型付けするか、individual を除去してください。
可変性バリエーションが所有するのはバリアントだけ。バリアントはバリエーションの中にあり、その種類である。選択はその点のバリアントである。バリエーションに付けた abstract は冗長(注記)。構成の未決定の点(注記)「compact」は「pack」のバリアントではありません。standardPack、largePack のいずれかを選んでください。
ユーザー定義のキーワード#Name はメタデータ定義を指す。言語のキーワードのない宣言はセマンティックメタデータを使う(警告)。メタデータは、その annotatedElement が許す種類にだけ付く。セマンティックな基底型は定義または使用であり、付ける要素に合い(警告)、循環を作らない「safetyCritical」は PartDefinition に適用されるもので、「invert」(ActionUsage)には適用されません。移動するか、除去してください。
メタデータの値ユーザー定義のメタデータ定義の必須フィーチャーすべてに値がある(警告)。各値と既定値がフィーチャーの型(Boolean、String、整数、列挙)に合う。定義の制約が与えられた値で成り立つ。メタデータの本体は定義のフィーチャーだけを再定義する。抽象メタデータ定義は適用されない。about で書かれたセマンティックメタデータ(警告)「SafetyRating」の値がその制約 levelRange:level >= 1 and level <= 4 に違反しています。値を変更してください。
評価現在の値で成り立たない制約、要求、目的「sedanMass」は「sedan」によって満たされていません:… は偽です(…)。設計値または要求を変更してください。

標準ライブラリ

標準ライブラリのページには、すべての SysML v2 プロジェクトで使えるパッケージと定義が一覧表示されます:値と単位、量、パート、ポート、アクション、状態、要求、分析など。読み取り専用です。

  • レールツールの設定 → 標準ライブラリから開きます。LML プロジェクトにはありません。
  • フォルダー。左側にライブラリファイルがフォルダー別に一覧表示されます:Kernel Libraries、Systems Library、Domain Libraries(Analysis、Cause and Effect、Geometry、Metadata、Quantities and Units、Requirement Derivation)、Holarch(TBD と TBR を含む HolarchMetadata パッケージ、HolarchConfiguration を含む HolarchVariability、Objective を含む HolarchRequirements)。
  • ファイル。ファイルを選択すると、そのパッケージが、それぞれのドキュメントと定義の表(名前、種類、ドキュメント)とともに表示されます。
  • 検索。パッケージまたは定義を検索…に入力すると、すべてのファイルの名前とドキュメントを検索します。結果にはファイルが表示され、クリックするとそのファイルが開きます。Esc を押すとクリアされます。
  • 名前をコピーは、要素の修飾名(たとえば ISQ::MassValue)をエディターで使えるようにコピーします。
  • テキストを表示はライブラリファイルを書かれたとおりに表示し、定義を表示で表に戻ります。

このライブラリは SysML v2 のリリースライブラリで、1 か所だけ修正しています:tonne(エイリアス 'metric ton')は 1000 kg に換算されます。リリースファイルでは 0.001 kg になっています。モデルは名前でライブラリを参照します。ライブラリはプロジェクトにコピーされず、.sysml エクスポートにも含まれません。

制限事項

  • 8 MB を超えるテキストドキュメントはチェックされません:This text is larger than 8 MB and is not checked. Split it into several packages.(このテキストは 8 MB を超えるため、チェックされません。複数のパッケージに分割してください)
  • 64 KB を超える行はチェックされません。
  • 256 階層を超える入れ子はチェックされません。
  • 標準ライブラリは編集できません。

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