要件リンクの検証

モデル内の要件リンクの検証

モデルアドバイザーによる要件リンクのチェック

Simulink^® モデル内のすべての要件リンクに対して要件ドキュメント内に有効なターゲットがあるか確認するには、モデルアドバイザーで要件の整合性チェックを実行します。

モデル例を開きます。

openExample("simulink/NavigateToExternallyStoredRequirementFromAModelExample")
open_system("slvnvdemo_fuelsys_officereq.slx")

モデルアドバイザーを開き、整合性チェックを実行します。[アプリ] タブで、[要件マネージャー] をクリックします。[要件] タブで [一貫性のチェック] をクリックします。

[要件の整合性をチェック] カテゴリでは、すべてのチェックが選択されています。このチュートリアルでは、すべてのチェックが選択されたままにします。

これらのチェックにより、モデルの要件に関する次の問題を特定できます。

整合性のチェック	特定される問題
ドキュメントが欠落している要件リンクを特定	モデルアドバイザーは、要件ドキュメントを検出できません。要件ドキュメントへのパスに関する問題が発生している可能性があります。
ドキュメンテーション内の無効な位置を指定する要件リンクを特定	モデルアドバイザーで、要件に指定された場所を検出できません。このチェックは次のドキュメントに対して実施されます。 Microsoft^® Word ドキュメント Microsoft Excel^® ドキュメント IBM^® DOORS^® ドキュメント Simulink オブジェクト
[説明] フィールドと要件ドキュメントのテキストが一致していない選択ベースのリンクを特定	リンクの [説明] フィールドが、要件ドキュメントのテキストと一致しません。選択ベースのリンクを作成すると、要件管理インターフェイス (RMI) では選択されたテキストはリンクの [説明] フィールドに保存されます。このチェックは次のドキュメントに対して実施されます。 Microsoft Word ドキュメント Microsoft Excel ドキュメント IBM DOORS ドキュメント Simulink オブジェクト
基本設定と一致しないパス形式をもつ要件リンクを特定	要件ドキュメントへのパスが、[要件の設定] ダイアログボックスの [選択内容のリンク] タブの [ドキュメントファイル参照] フィールドと一致しません。要件ドキュメントへのパスに関する問題が発生している可能性があります。 Linux^® システムでは、このチェックは [絶対パスタイプをもつ要件リンクを特定します] という名称になっています。このチェックでは、絶対パスを使用する各要件リンクに対する警告がレポートされます。メモ要件ドキュメントへのパスを RMI が解決する方法の詳細については、ドキュメントパスストレージを参照してください。

モデルアドバイザーは、リンクターゲットがあるアプリケーションが実行中かどうか確認します。

モデルに Microsoft Word または Microsoft Excel ドキュメントへのリンクがある場合、整合性のチェックの実行時にこれらのアプリケーションのインスタンスをすべて閉じる必要があります。これらのアプリケーションのいずれかが開いている場合、警告が表示され、チェックは続行されません。整合性のチェックでは、保存されている要件ドキュメントの最新のコピーを確認しなければなりません。
モデルに DOORS 要件へのリンクがある場合、DOORS ソフトウェアにログインしなければなりません。DOORS データベースには、対象の要件があるモジュールが含まれていなければなりません。

このチュートリアルでは、Microsoft Word と Microsoft Excel の両方を必ず閉じます。
[選択したチェックを実行] をクリックします。
チェックの完了後、次のようになります。
- チェックマークが付いた緑色の円は、2 件のチェックがパスであったことを表します。
- 感嘆符が付いた黄色の三角形は、2 件のチェックで警告が発生したことを表します。
右側のペインには、2 件のチェックがパスで、2 件のチェックで警告が発生したことが示されています。[レポート] ボックスには HTML レポートへのリンクがあります。

モデルアドバイザーを開いたままにします。次の節では、リンクの不整合の解釈と修正の方法を説明します。

メモ

モデルアドバイザーを使用して、IBM DOORS データベース内にある要件リンクをチェックする例をステップ実行するには、MATLAB^® コマンドプロンプトでフォールトトレラント燃料制御システムの要件の管理 (IBM DOORS)の例を実行します。

モデルアドバイザーで検出された無効な要件リンクの修正

モデルアドバイザーによる要件リンクのチェックでは、slvnvdemo_fuelsys_officereq モデル内での 3 件の要件の整合性チェックで警告が発生しています。

警告の解決: ドキュメンテーション内の無効な位置を指定する要件リンクを特定. 要件ドキュメント内の無効な場所にリンクしようとしていることを示す警告を修正するには、次の手順に従います。

モデルアドバイザーで、[ドキュメンテーション内の無効な位置を指定する要件リンクを特定します] を選択すると、警告の説明が表示されます。
このチェックにより、Microsoft Word 要件ドキュメント (slvnvdemo_FuelSys_DesignDescription.docx) に存在しない場所を指定しているリンクが特定されます。このリンク元は Terminator1 ブロックです。この例では、要件の作成後に要件ドキュメント内のターゲットの場所が削除されています。
このリンクの詳細情報を取得します。
1. Terminator1 ブロックに移動するには、[ブロック] でハイパーリンクをクリックします。
2. このリンクの外向きリンクエディターを開くには、[要件] でハイパーリンクをクリックします。
[外向きリンク] ダイアログから問題を修正するには、次のいずれかを行います。
- [場所] フィールドで、要件ドキュメント内の有効な場所を指定します。
- 要件リンクを選択して [削除] をクリックし、リンクを削除します。
モデルアドバイザーで、チェックの [要件の整合性チェック] カテゴリを選択します。
[選択したチェックを実行] を再度クリックし、警告が発生しないことを確認します。

警告の解決: [説明] フィールドと要件ドキュメントのテキストが一致していない選択ベースのリンクを特定. [説明] フィールドが要件ドキュメントのテキストと一致しないことを示す警告を解決するには、次の手順に従います。

モデルアドバイザーで、[[説明] フィールドと要件ドキュメントのテキストが一致していない選択ベースのリンクを特定] をクリックして、警告の説明を表示します。
最初のメッセージは、モデルに含まれている Simulink_requirement_item_7 というブックマークへのリンクが、要件ドキュメント内に存在しないことを示しています。
また、このチェックでは要件ブロックと要件ドキュメントの間で次のテキストが一致しないことを示しています。
- Test inputs Signal Builder ブロックリンクの [説明] フィールドのテキストは [Normal mode of operation] です。要件のテキストは [The simulation is run with a throttle input that ramps from 10 to 20 degrees over a period of two seconds, then back to 10 degrees over the next two seconds. This cycle repeats continuously while the engine is held at a constant speed.] です。
- MAP Estimate ブロックリンクの [説明] フィールドのテキストは [Manifold pressure failure] です。slvnvdemo_FuelSys_DesignDescription.docx の要件のテキストは [Manifold pressure failure mode] です。
このリンクの詳細情報を取得します。
1. ブロックに移動するには、[ブロック] でハイパーリンクをクリックします。
2. このリンクの外向きリンクエディターを開くには、[現在の説明] でハイパーリンクをクリックします。
この問題を解決する方法は 2 つあります。
- モデルアドバイザーで [更新] をクリックします。この操作により、該当するリンクの [説明] フィールドが自動的に更新され、要件と一致するようになります。
- リンクエディターで、ブロックからのリンクを手作業で編集し、[説明] フィールドを選択した要件テキストと一致させます。
モデルアドバイザーで、チェックの [要件の整合性チェック] カテゴリを選択します。
[選択したチェックを実行] を再度クリックし、警告が発生しないことを確認します。

要件ドキュメント内の要件リンクの検証

要件ドキュメント内のリンクのチェック

要件ドキュメント内のリンクをチェックするには、次の手順に従います。

MATLAB コマンドプロンプトで、次のように入力します。
```
rmi('checkdoc',docName)
```
docName は、次のいずれかを表す文字ベクトルです。
- DOORS 要件ドキュメントのモジュール ID
- Microsoft Word 要件ドキュメントの絶対パス名
- Microsoft Excel 要件ドキュメントの絶対パス名
関数 rmi により、ドキュメント内のすべての要件リンクが記載された HTML レポートが作成および表示されます。
このレポートでは無効なリンクが赤色で強調表示されます。それぞれの無効なリンクに関して、問題の簡単な説明と、要件ドキュメント内の無効なリンクへのハイパーリンクが表示されます。このレポートでは、同じ問題があるリンクがグループ化されます。
[ドキュメントの内容] の下のハイパーリンクをダブルクリックして、無効なリンクの要件ドキュメントを開きます。
無効なリンクのナビゲーションコントロールの外観は、有効なリンクのナビゲーションコントロールとは異なります。

要件ドキュメント内に無効なリンクがある場合、次のいずれかの手順を実行します。

実行する操作	次の手順を実行
無効なリンクを修正する	要件ドキュメント内の無効なリンクの修正の説明に従います。
無効なリンクを修正せずに、ナビゲーションコントロールに対する変更を保存する	要件ドキュメントを保存します。
無効なリンクを無視する	要件ドキュメントを保存せずに閉じます。

複数のオブジェクトに同じ要件へのリンクがある場合

複数のオブジェクトを同じ要件にリンクした場合、要件ドキュメントに挿入されるナビゲーションオブジェクトは 1 つのみです。ナビゲーションオブジェクトをダブルクリックすると、リンクされているすべてのモデルオブジェクトが強調表示されます。

関数 rmi の 'checkdoc' オプションを使用して要件ドキュメントをチェックした結果、1 つのナビゲーションオブジェクトが複数のオブジェクトを示すことが検出された場合、チェックは停止し、次のダイアログボックスが表示されます。

次のいずれかを実行します。

[はい] をクリックするか、このダイアログボックスを閉じると、その要件にリンクしているモデルオブジェクトごとに 1 つのナビゲーションオブジェクトが追加作成されます。ドキュメントのチェックは続行されますが、RMI ではナビゲーションの再チェックは行われず、レポートにはその要件のリンクが 1 つだけ表示されます。すべての要件を確認するためにチェックを再実行するには、レポートの最上部で [リフレッシュ] をクリックします。
[いいえ] をクリックすると、ドキュメントのチェックが続行され、レポートではナビゲーションオブジェクトがリンク切れであることが表示されます。

要件ドキュメント内の無効なリンクの修正

関数 rmi により作成されるレポートを使用すると、要件ドキュメント内の無効なリンクを修正できます。

次の例では、rmi は 2 つのリンクで指定されたモデルを検出できません。

無効なリンクを修正するには、次の手順に従います。

レポートの [ドキュメントの内容] で、無効な要件リンクに関連付けられたハイパーリンクをクリックします。
要件ドキュメントが開き、要件のテキストが強調表示されます。
要件ドキュメントで、ドキュメントの形式に応じて次の手順を実行します。
- DOORS の場合:
  1. 無効なリンクのナビゲーションコントロールを選択します。
  2. [MATLAB] 、 [Select item] を選択します。
- Microsoft Word の場合、ナビゲーションコントロールをダブルクリックします。
ダイアログボックスが開き、特定の問題が発生しているすべてのリンクを修正、リセットまたは無視することができます。

次のオプションのうちの 1 つをクリックします。

目的	クリックするボタン
リンク切れの新しいリンク先モデルまたは新しいリンク先オブジェクトに移動して選択します。	[すべて修正]
これらの無効なリンクのナビゲーションコントロールが元の状態 (要件ドキュメントをチェックする前の状態) にリセットされます。	[すべてリセット]
要件ドキュメントを変更しません。`rmi` によりナビゲーションコントロールに行われた変更は、要件ドキュメントに残ります。	[キャンセル]

要件ドキュメントを保存し、関数 rmi による変更を保持します。