slreq.Reference クラス

パッケージ: slreq

外部要件プロキシ オブジェクトの操作

説明

slreq.Reference のインスタンスは、サードパーティの外部アプリケーションが管理および維持している外部要件オブジェクトのプロキシです。参照要件オブジェクトは読み取り専用ですが、外部アプリケーションから同期することができ、要件セット内にのみ存在できます。

作成

ref = find(rs, 'Type', 'Reference', 'PropertyName', PropertyValue) は、PropertyName と PropertyValue で指定されたプロパティと一致する要件セット rs の参照要件または参照要件セット ref を検索して返します。

ref = add(rs, 'Artifact', FileName, 'PropertyName', PropertyValue) は、PropertyName と PropertyValue で指定されたプロパティおよびカスタム属性をもつ、FileName で指定された外部ドキュメントからの要件を参照する要件セット rs に参照要件 ref を追加します。

入力引数

rs — 要件セット オブジェクト

slreq.ReqSet オブジェクト

要件セット。slreq.ReqSet オブジェクトとして指定します。

FileName — コンテナー識別子

文字ベクトル

Microsoft^® Office ドキュメント名や IBM^® Rational^® DOORS^® モジュールの一意の ID など、最上位のコンテナー識別子のファイル名。

出力引数

ref — 参照要件

slreq.Reference オブジェクト

参照要件。slreq.Reference オブジェクトとして指定します。

プロパティ

Id — 参照要件 ID

文字ベクトル

参照要件 ID。文字ベクトルとして返されます。

属性:

GetAccess	public
SetAccess	private

CustomId — 参照要件のカスタム ID

文字ベクトル

参照要件のカスタム ID。文字ベクトルとして返されます。

属性:

GetAccess	public
SetAccess	private

Artifact — コンテナー識別子

文字ベクトル

Microsoft Office ドキュメント名や IBM Rational DOORS モジュールの一意の ID など、最上位のコンテナー識別子。

属性:

GetAccess	public
SetAccess	private

ArtifactId — 要件識別子

文字ベクトル

ソース要件ドキュメント内の一意の要件識別子。IBM Rational DOORS からインポートされた要件の場合、"ArtifactId" は数値オブジェクト ID です。Microsoft Word からインポートされた要件の場合、"ArtifactId" にはブックマーク名が使用されます。

属性:

GetAccess	public
SetAccess	private

Domain — 要件ドキュメントのカスタム リンク タイプ

文字ベクトル

要件ドキュメントのカスタム リンク タイプ。詳細については、カスタム リンク タイプを参照してください。

例: 'linktype_rmi_doors', 'linktype_rmi_excel'

属性:

GetAccess	public
SetAccess	private

UpdatedOn — 参照要件が最後に更新された日時

datetime

参照要件が最後に外部ドキュメントと同期された日時。datetime 値として指定します。ソフトウェアが自動的にこのプロパティを入力します。

属性:

GetAccess	public
SetAccess	private

CreatedOn — 参照要件の作成日

datetime

参照要件が作成された日付。datetime 値として指定します。ソフトウェアが自動的にこのプロパティを入力します。

属性:

GetAccess	public
SetAccess	private

CreatedBy — 参照要件の作成者

文字ベクトル

参照要件を作成した個人または組織の名前。

属性:

GetAccess	public
SetAccess	private

ModifiedBy — 参照要件の変更者

文字ベクトル

参照要件を最後に変更した個人または組織の名前。

属性:

GetAccess	public
SetAccess	private

IsLocked — 参照要件のロック インジケーター

1 (既定値) | 0

参照要件がロックされているかどうかを示します。ロックされている場合は 1、ロック解除されている場合は 0 です。

属性:

GetAccess	public
SetAccess	private

Summary — 参照要件の概要

文字ベクトル

参照要件の概要テキスト。文字ベクトルとして返されます。

属性:

GetAccess	public
SetAccess	public

Description — 参照要件の説明

文字ベクトル

参照要件の説明テキスト。複数行の文字ベクトルとして返されます。

属性:

GetAccess	public
SetAccess	public

Rationale — 参照要件の根拠

文字ベクトル

参照要件の根拠テキスト。複数行の文字ベクトルとして返されます。

属性:

GetAccess	public
SetAccess	public

Keywords — 参照要件キーワード

文字配列

参照要件キーワード。文字配列として指定します。

属性:

GetAccess	public
SetAccess	public

Type — 参照要件タイプの列挙

'Functional' | 'Informational' | 'Container' | string スカラー | 文字ベクトル

参照要件タイプの列挙。'Functional'、'Informational'、'Container'、あるいは、カスタム要件タイプを指定する string スカラーまたは文字ベクトルとして指定します。詳細については、要件タイプを参照してください。

属性:

GetAccess	public
SetAccess	public

IndexEnabled — 参照要件インデックスの有効化インジケーター

1 (既定値) | 0

参照要件インデックスが有効 (1) か無効 (0) かを示します。データ型 logical の 1 または 0 として返されます。インデックスを無効にすると、番号付きの階層リストから参照要件が除外されます。

属性:

GetAccess	public
SetAccess	public

IndexNumber — ユーザー指定の参照要件インデックス値

空の double 配列 (既定値) | int32 配列

ユーザー指定の参照要件インデックス値。空の double 配列または int32 配列として返されます。空の場合、Requirements Toolbox™ は Index 値を計算します。それ以外の場合、Requirements Toolbox は Index プロパティを指定された整数値に設定します。

属性:

GetAccess	public
SetAccess	public

SID — 参照要件のセッション ID

文字ベクトル

参照要件に対応するセッション ID。

属性:

GetAccess	public
SetAccess	private

FileRevision — 参照要件のリビジョン番号

スカラー

参照要件のリビジョン番号。スカラーとして指定します。

属性:

GetAccess	public
SetAccess	private

ModifiedOn — 参照要件の変更日

datetime

参照要件が最後に変更された日付。datetime 値として指定します。ソフトウェアが自動的にこのプロパティを入力します。

属性:

GetAccess	public
SetAccess	private

Dirty — 未保存の変更のインジケーター

0 | 1

要件に未保存の変更があるか (1)、未保存の変更がないか (0) を示します。

属性:

GetAccess	public
SetAccess	private

Comments — 参照要件のコメント

構造体配列

参照要件に付されるコメント。構造体として返されます。

属性:

GetAccess	public
SetAccess	private

Index — 参照要件のインデックス

文字配列

参照要件のインデックス。文字配列として指定します。

属性:

GetAccess	public
SetAccess	private

メソッド

add	Add child referenced requirement
addComment	コメントを参照要件に追加
children	子参照の検索
find	Find children of parent referenced requirements
getAttribute	参照要件のカスタム属性の取得
getImplementationStatus	Query referenced requirement implementation status summary
getPostImportFcn	Get contents of PostImportFcn callback
getPreImportFcn	Get registered PreImportFcn callback script
getVerificationStatus	Query referenced requirement verification status summary
hasNewUpdate	Check if import node has available update
inLinks	Get incoming links for referenced requirements
isFilteredIn	Check filtered referenced requirements
isJustifiedFor	Check if referenced requirement is justified
justifyImplementation	Justify referenced requirements for implementation
justifyVerification	Justify referenced requirements for verification
moveDown	Move referenced requirement down in hierarchy
moveUp	Move referenced requirement up in hierarchy
navigateToExternalArtifact	Navigate from imported referenced requirement to original requirement
outLinks	Get outgoing links for referenced requirements
parent	参照要件の親項目の検索
remove	Remove referenced requirements
reqSet	Return parent requirement set
setAttribute	参照要件のカスタム属性を設定
setParent	Set parent of referenced requirement in PostImportFcn callback
setPostImportFcn	Assign PostImportFcn callback script
setPreImportFcn	Assign PreImportFcn callback script
unlock	参照要件のロック解除
unlockAll	すべての子参照要件のロックを編集用に解除
updateFromDocument	Update referenced requirements from external requirements document

例

参照要件の検索

この例では、要件セット内の参照要件を検索する方法を説明します。

myReqSet という要件セットを読み込みます。

rs = slreq.load("myReqSet");

要件セット内で ID が 9 である要件を検索します。

req = find(rs,"Type","Reference","ID","9");

ref = 

  Reference with properties:

          Keywords: [0×0 char]
          Artifact: 'Req_doc.docx'
                Id: 'R9'
           Summary: 'System overview'
       Description: ''
               SID: 3
            Domain: 'linktype_rmi_word'
    SynchronizedOn: 25-Jul-2017 11:34:02

バージョン履歴

R2018a で導入

参考

slreq.ReqSet | slreq.Requirement | slreq.import | slreq.Link | slreq.LinkSet

トピック

• Microsoft Word ドキュメントからの要件のインポートおよび編集