Main Content

このページの内容は最新ではありません。最新版の英語を参照するには、ここをクリックします。

rmi

要件管理インターフェイスをプログラムによって操作する

ページ内をすべて折りたたむ

構文

reqlinks = rmi('createEmpty')
reqlinks = rmi('get',object)
reqlinks = rmi('get',sig_builder,group_idx)
rmi('set',model,reqlinks)
rmi('set',sig_builder,reqlinks,group_idx)
rmi('cat',model,reqlinks)
cnt = rmi('count',object)
rmi('clearAll',object)
rmi('clearAll',object,'deep')
rmi('clearAll',object,'noprompt')
rmi('clearAll',object,'deep','noprompt')
cmdStr = rmi('navCmd',object)
[cmdStr,titleStr] = rmi('navCmd',object)
object = rmi('guidlookup',model,guidStr)
rmi('highlightModel',object)
rmi('unhighlightModel',object)
rmi('view',object,index)
dialog = rmi('edit',object)
guidStr = rmi('guidget',object)
rmi('report',model)
rmi('report',matlabFilePath)
rmi('report',dictionaryFile)
rmi('projectreport')
rmi('setup')
rmi('setup','doors',false)
rmi register typename
rmi unregister typename
rmi('linktypelist')
number_problems = rmi('checkdoc')
number_problems = rmi('checkdoc',docName)
rmi('check',matlabFilePath)
rmi('check',dictionaryFile)
rmi('doorssync',model)
[objHs,parentIdx,isSf,objSIDs] = rmi('getObjectsInModel',model)
[objName,objType] = rmi('getObjLabel',object)
rmi('setDoorsLabelTemplate',template)
template = rmi('getDoorsLabelTemplate')
label = rmi('doorsLabel',moduleID,objectID)
totalModifiedLinks = rmi('updateDoorsLabels',model)
rmi httpLink
status = rmi("httpLink","status")

説明

reqlinks = rmi('createEmpty') は、要件リンク データ構造の空のインスタンスを作成します。

例

reqlinks = rmi('get',object) は、object の要件リンク データ構造を返します。

例

reqlinks = rmi('get',sig_builder,group_idx) は、インデックス group_idx で指定した Signal Builder グループの要件リンク データ構造を返します。

rmi('set',model,reqlinks) は、model の要件リンクとして reqlinks を設定します。

例

rmi('set',sig_builder,reqlinks,group_idx) は、Signal Builder ブロック sig_builder 内の信号グループ group_idx の要件リンクとして reqlinks を設定します。

rmi('cat',model,reqlinks) は、reqlinks 内の要件リンクを model の既存の要件リンクに追加します。

例

cnt = rmi('count',object) は、object の要件リンクの数を返します。

rmi('clearAll',object) は、object のすべての要件リンクを削除します。

rmi('clearAll',object,'deep') は、object が含まれているモデル内のすべての要件リンクを削除します。

rmi('clearAll',object,'noprompt') は、object のすべての要件リンクを削除し、確認のプロンプトを出しません。

rmi('clearAll',object,'deep','noprompt') は、object が含まれているモデル内のすべての要件リンクを削除し、確認のプロンプトを出しません。

cmdStr = rmi('navCmd',object) は、object への移動に使用される MATLAB® コマンド cmdStr を返します。

[cmdStr,titleStr] = rmi('navCmd',object) は、MATLAB コマンド cmdStr、および object の説明テキストを示すタイトル titleStr を返します。

object = rmi('guidlookup',model,guidStr) は、グローバル一意識別子 guidStr をもつ、model 内のオブジェクト名を返します。

rmi('highlightModel',object) は、要件リンクをもつ、object の親モデル内のすべてのオブジェクトを強調表示します。

rmi('unhighlightModel',object) は、要件リンクをもつ、object の親モデル内のオブジェクトの強調表示を解除します。

rmi('view',object,index) は、object に関連付けられている要件ドキュメント内の index の番号が付けられた要件にアクセスします。

dialog = rmi('edit',object) は、object の [要件] ダイアログ ボックスを表示し、ダイアログ ボックスのハンドルを返します。

guidStr = rmi('guidget',object) は、object のグローバル一意識別子を返します。object のグローバル一意識別子がない場合は、作成されます。

rmi('report',model) は、model について HTML 形式の要件トレーサビリティ レポートを生成します。

例

rmi('report',matlabFilePath) は、matlabFilePath で指定された MATLAB コード ファイルについて HTML 形式の要件トレーサビリティ レポートを生成します。

rmi('report',dictionaryFile) は、dictionaryFile で指定された Simulink® データ ディクショナリについて HTML 形式の要件トレーサビリティ レポートを生成します。

rmi('projectreport') は、現在のプロジェクトについて HTML 形式の要件トレーサビリティ レポートを生成します。このレポートの最上位ページには、要件トレーサビリティの関連付けのある各プロジェクト項目のレポートへの HTTP リンクが含まれています。詳細については、プロジェクトの要件トレーサビリティ レポートの作成を参照してください。

rmi('setup') は、MATLAB で使用するために RMI を構成し、IBM® DOORS® で使用するためのインターフェイスをインストールします。

rmi('setup','doors',false) は、対話型の設定なしで、MATLAB で使用するために RMI を構成し、IBM DOORS で使用するためのインターフェイスをインストールします。

rmi register typename は、関数 typename で指定されたカスタム リンク タイプまたはカスタム ドキュメント ドメイン タイプの名前を登録します。詳細については、Define Custom Document Interface for Direct Linking to RequirementsおよびDefine Custom Document Interface for Importing Requirementsを参照してください。

rmi unregister typename は、関数 typename で指定されたカスタム リンク タイプまたはカスタム ドキュメント ドメイン タイプの名前を削除します。詳細については、Define Custom Document Interface for Direct Linking to RequirementsおよびDefine Custom Document Interface for Importing Requirementsを参照してください。

rmi('linktypelist') は、現在登録されているリンク タイプのリストを表示します。このリストでは、各リンク タイプが組み込みなのかカスタムなのかが示され、その登録に使用された関数のパスが表示されます。

number_problems = rmi('checkdoc') は、Microsoft® Word、Microsoft Excel®、または IBM DOORS の要件ドキュメントから Simulink へのリンクの有効性をチェックします。要件ドキュメント名の入力を求めるプロンプトが出され、検出された問題の総数が返され、MATLAB Web ブラウザーで HTML レポートが開きます。詳細については、要件ドキュメント内の要件リンクの検証を参照してください。

number_problems = rmi('checkdoc',docName) は、docName で指定された要件ドキュメントから Simulink へのリンクの有効性をチェックします。検出された問題の総数が返され、MATLAB Web ブラウザーで HTML レポートが開きます。詳細については、要件ドキュメント内の要件リンクの検証を参照してください。

rmi('check',matlabFilePath) は、.m ファイル matlabFilePath 内の MATLAB コード行に関連付けられているトレーサビリティ リンクの整合性をチェックし、MATLAB Web ブラウザーで HTML レポートを開きます。

rmi('check',dictionaryFile) は、Simulink データ ディクショナリ dictionaryFile に関連付けられているトレーサビリティ リンクの整合性をチェックし、MATLAB Web ブラウザーで HTML レポートを開きます。

rmi('doorssync',model) は、DOORS 同期設定ダイアログ ボックスを開きます。このダイアログ ボックスでは同期設定をカスタマイズし、IBM DOORS データベース内の開かれているプロジェクトにモデルを同期できます。

[objHs,parentIdx,isSf,objSIDs] = rmi('getObjectsInModel',model) は、IBM DOORS サロゲート モジュールに含めることを検討できる Simulink オブジェクトのリストを返します。

[objName,objType] = rmi('getObjLabel',object) は、サードパーティの要件管理アプリケーションを使用してリンクした Simulink オブジェクトの Simulink オブジェクト名およびタイプの情報を返します。

rmi('setDoorsLabelTemplate',template) は、IBM DOORS への要件リンクのラベルの新規カスタム テンプレートを指定します。既定のラベル テンプレートには、DOORS 要件リンク ターゲットのセクション番号およびオブジェクト見出しが含まれています。リンク ラベル テンプレートを既定値に戻すには、MATLAB コマンド プロンプトで「rmi('setDoorsLabelTemplate','')」と入力します。

例

template = rmi('getDoorsLabelTemplate') は、IBM DOORS への要件リンクのラベルの、現在指定されているカスタム テンプレートを返します。

label = rmi('doorsLabel',moduleID,objectID) は、現在のテンプレートに従って、moduleID で指定した DOORS モジュール内の objectID で指定した IBM DOORS オブジェクトへの要件リンクのラベルを生成します。

totalModifiedLinks = rmi('updateDoorsLabels',model) は、現在のテンプレートに従って、model 内のすべての IBM DOORS 要件リンク ラベルを更新します。

例

rmi httpLink は、HTTP プロトコルを使用するブラウザー ベースのサードパーティ製要件ツールのバックリンクから MATLAB または Simulink のリンク項目へのナビゲートに使用できる内部 HTTP サーバーをアクティブにします。HTTPS サーバーのバックリンク ナビゲーションは既定で有効になっています。

メモ

あるいは、関数 rmipref を使用して UnsecureHttpRequests 基本設定を true に設定することで内部 HTTP サーバーをアクティブにすることもできます。UnsecureHttpRequests 基本設定が true の場合、MATLAB の起動時に内部 HTTP サーバーがアクティブになります。

例

status = rmi("httpLink","status") は、内部 HTTP サーバーのポート番号を返します。ポート番号が 0 の場合、サーバーがアクティブになっていません。

例

例

すべて折りたたむ

slvnvdemo_fuelsys_officereq モデル内のブロックに関連付けられている要件を取得し、その説明を変更し、要件をそのブロックに保存し直します。新しい要件リンクを定義して、ブロック内の既存の要件リンクに追加します。

モデル例 slvnvdemo_fuelsys_officereq 内の Airflow calculation ブロックに関連付けられている要件リンクを取得します。

openExample("slvnvdemo_fuelsys_officereq.slx")
blk_with_req = ['slvnvdemo_fuelsys_officereq/fuel rate controller/'...
'Airflow calculation']
reqts = rmi('get',blk_with_req);

要件リンクの説明を変更します。

reqts.description = 'Mass airflow estimation';

Airflow calculation ブロックの変更した要件リンクの説明を保存します。

rmi('set',blk_with_req,reqts);

例のドキュメント fuelsys_requirements2.htm への新しい要件リンクを作成します。

new_req = rmi('createempty');
new_req.doc = 'fuelsys_requirements2.htm';
new_req.description = 'New requirement';

Airflow calculation ブロックの既存の要件リンクに新しい要件リンクを追加します。

rmi('cat',blk_with_req, new_req);

モデル例の要件トレーサビリティ データの HTML レポートを作成します。

モデル例 slvnvdemo_fuelsys_officereq の HTML 要件レポートを作成します。

openExample("slvnvdemo_fuelsys_officereq.slx")
rmi('report','slvnvdemo_fuelsys_officereq');

MATLAB Web ブラウザーが開き、レポートが表示されます。

DOORS 内の要件へのリンクの新規ラベル テンプレートを指定し、新しいテンプレートに合わせてモデル内のすべての DOORS 要件リンクのラベルを更新します。

IBM DOORS への要件リンクの新規ラベル テンプレートを指定して、DOORS オブジェクトへの新規リンクが、対応するモジュール ID、オブジェクト絶対番号、および 'Backup' 属性の値でラベル付けされるようにします。 

rmi('setDoorsLabelTemplate','%m:%n [backup=%<Backup>]');

IBM DOORS への要件リンクの新規ラベル テンプレートを指定し、最大ラベル長を (たとえば) 200 文字に設定します。 

rmi('setDoorsLabelTemplate','%h %200');

モデル example_model で指定した新規テンプレートに合わせて既存の DOORS 要件リンク ラベルを更新します。ラベルを更新する際には、DOORS が実行されている必要があり、またリンクされているすべてのモジュールに対する読み取りアクセスが可能でなければなりません。

rmi('updateDoorsLabels',example_model);
ライブ スクリプトを開く

内部 HTTP サーバーのステータスを取得します。

status = rmi("httpLink","status")
status = struct with fields:
     httpPort: 0
    httpsPort: 31515

内部 HTTP サーバーをアクティブにします。

rmi httpLink

内部 HTTP サーバーのステータスを取得します。

status = rmi("httpLink","status")
status = struct with fields:
     httpPort: 31415
    httpsPort: 31515

入力引数

すべて折りたたむ

要件を関連付けることができる Simulink モデルまたは Stateflow チャート。文字ベクトルまたはハンドルとして指定します。

例: 'slvnvdemo_officereq'

データ型: char

要件を関連付けることができるモデル オブジェクト。文字ベクトルまたはハンドルとして指定します。

例: 'slvnvdemo_fuelsys_officereq/fuel rate controller/Airflow calculation'

データ型: char

要件トレーサビリティの関連付けをもつ信号グループが含まれている Signal Builder ブロック。文字ベクトルまたはハンドルとして指定します。

データ型: char

Signal Builder グループ インデックス。スカラーとして指定します。

例: 2

データ型: char

要件トレーサビリティの関連付けをもつ MATLAB コード ファイル。ファイルのパスとして指定します。

データ型: char

要件トレーサビリティの関連付けをもつ Simulink データ ディクショナリ。ファイル名と、オプションでディクショナリのパスを含む文字ベクトルとして指定します。

データ型: char

モデル オブジェクト object のグローバル一意識別子。文字ベクトルとして指定します。

例: GIDa_59e165f5_19fe_41f7_abc1_39c010e46167

データ型: char

モデル オブジェクトにリンクされている要件のインデックス番号。整数として指定します。

外部アプリケーション内の要件ドキュメント。次のいずれかを表す文字ベクトルとして指定します。

  • IBM DOORS モジュール ID。

  • Microsoft Word 要件ドキュメントのパス。

  • Microsoft Excel 要件ドキュメントのパス。

詳細については、要件ドキュメント内の要件リンクの検証を参照してください。

IBM DOORS 内の要件へのリンクのラベル。文字ベクトルとして指定します。

データ型: char

IBM DOORS 内の要件へのリンクのテンプレート ラベル。文字ベクトルとして指定します。

次の書式指定子を使用して、関連付けられている DOORS 情報を要件リンク ラベルに含めることができます。

%hオブジェクト見出し
%tオブジェクト テキスト
%pモジュール接頭辞
%nオブジェクト絶対番号
%mモジュール ID
%Pプロジェクト名
%Mモデル名
%UDOORS URL
%<ATTRIBUTE_NAME>指定したその他の DOORS 属性

例: '%m:%n [backup=%<Backup>]'

データ型: char

IBM DOORS モジュール。一意の DOORS モジュール ID として指定します。

データ型: char

DOORS モジュール moduleID 内の IBM DOORS オブジェクト。ローカルで一意の DOORS ID として指定します。

データ型: char

出力引数

すべて折りたたむ

要件リンク データ。以下のフィールドをもつ構造体配列として返されます。

doc

要件ドキュメントを識別する文字ベクトル

id

要件ドキュメント内の場所を定義する文字ベクトル。最初の文字は、次のように識別子タイプを表しています。

最初の
文字		識別子例

?

検索テキスト。その最初の出現箇所が要件ドキュメントにある

'?Requirement 1'

@

Microsoft Word ファイル内のブックマークや HTML ファイル内のアンカーなどの名前付き項目

'@my_req'

#

ページまたは項目番号

'#21'

>

行番号

'>3156'

$

スプレッドシート内のワークシート範囲

'$A2:C5'

linked

レポート生成および強調表示のために要件リンクにアクセスできるかどうかを指定するブール値:

1 (既定)。モデル オブジェクトを強調表示し、要件リンクをレポートに含めます。
0
description

要件を記述する文字ベクトル

keywords

description を補足するオプションの文字ベクトル

reqsys

リンク タイプ登録名を識別する文字ベクトル。組み込みリンク タイプの場合は 'other'

モデル オブジェクト object への移動に使用するコマンド。文字ベクトルとして返されます。

例: rmiobjnavigate('slvnvdemo_fuelsys_officereq.slx', 'GIDa_59e165f5_19fe_41f7_abc1_39c010e46167');

要件リンクをもつモデル オブジェクトのテキストでの説明。文字ベクトルとして返されます。

例: slvnvdemo_fuelsys_officereq/.../Airflow calculation/Pumping Constant (Lookup2D)

モデル オブジェクト object のグローバル一意識別子。文字ベクトルとして返されます。

例: GIDa_59e165f5_19fe_41f7_abc1_39c010e46167

モデル オブジェクト object の [要件] ダイアログ ボックス。ダイアログ ボックスへのハンドルとして返されます。

外部ドキュメント docName で検出された無効なリンクの総数。

詳細については、要件ドキュメント内の要件リンクの検証を参照してください。

新しいラベル テンプレートで更新された DOORS 要件リンクの総数。

数値ハンドルのリスト。配列として返されます。

モデルの階層構造のインデックス。配列として返されます。

どのリストの位置がどの Stateflow オブジェクトに対応するかを示す logical 配列。

セッション独立の Simulink ID。配列として返されます。

内部 HTTP サーバーおよび HTTPS サーバーのステータス。次のフィールドをもつ構造体として返されます。

HTTP ポート番号。double として返されます。HTTP ポート番号が 0 の場合、サービスがアクティブになっていません。

HTTPS ポート番号。double として返されます。

バージョン履歴

R2006b で導入

すべて展開する

参考

| | | | |