slreq.Reference 类

命名空间: slreq

使用外部需求代理对象

描述

slreq.Reference 类的对象代表您从第三方需求管理工具导入的引用需求。引用需求是您使用第三方工具管理的外部需求的代理需求。当您对外部需求进行更改时，您可以更新所引用需求。

创建对象

ref = find(rs, 'Type', 'Reference', 'PropertyName', PropertyValue) 在与 PropertyName 和 PropertyValue 匹配的属性指定的需求集 ref 中查找并返回一个引用需求或一组引用需求 rs。

ref = add(rs, 'Artifact', FileName, 'PropertyName', PropertyValue) 将引用的需求 ref 添加到需求集 rs，该需求集引用了 FileName 指定的外部文档中的需求，并具有 PropertyName 和 PropertyValue 指定的属性和自定义属性。

输入参量

全部展开

`rs` — 需求集对象
`slreq.ReqSet` 对象

需求集，指定为 slreq.ReqSet 对象。

`FileName` — 容器标识符
字符向量

顶级容器标识符的文件名，例如 Microsoft^® Office 文档名称或 IBM^® 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 DOORS 模块唯一 ID。

属性：

`GetAccess`	`public`
`SetAccess`	`private`

`ArtifactId` — 需求标识符
字符向量

源需求文档中的唯一需求标识符。对于从 IBM DOORS 导入的需求，ArtifactId 是数字对象 ID。对于从 Microsoft Word 导入的需求，书签名称用作 ArtifactId。

属性：

`GetAccess`	`public`
`SetAccess`	`private`

`Domain` — 外部需求文档接口名称
字符向量

外部需求文档的接口名称，以字符向量形式返回。该名称可以是内置名称之一，也可以是自定义注册接口的名称。有关详细信息，请参阅定义自定义文档接口以导入需求。

示例: 'linktype_rmi_word','custom_jira'

属性：

`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'` | 字符串标量 | 字符向量

引用的需求类型枚举，指定为 'Functional'、'Informational'、'Container'，或者指定自定义需求类型的字符串标量或字符向量。有关详细信息，请参阅需求类型。

属性：

`GetAccess`	`public`
`SetAccess`	`public`

`IndexEnabled` — 引用需求索引启用指示器
`1` (默认) | `0`

指示引用的需求索引是否启用(1)或禁用(0)，作为数据类型为 1 的 0 或 logical 返回。禁用索引会从编号层次结构列表中省略所引用的需求。

属性：

`GetAccess`	`public`
`SetAccess`	`public`

`IndexNumber` — 用户指定的参考需求索引值
空 `double` 数组 (默认) | `int32` 数组

用户指定的引用需求索引值，以空的 double 数组或 int32 数组返回。如果为空，Requirements Toolbox™ 将计算 Index 值。否则，Requirements Toolbox 将 Index 属性设置为指定的整数值。

属性：

`GetAccess`	`public`
`SetAccess`	`public`

`SID` — 引用需求会话独立标识符
字符向量

与引用的需求相对应的会话独立标识符。

属性：

`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	添加子引用需求
addComment	向引用需求添加注释
children	查找子引用
find	查找父级引用需求的子级
getAttribute	获取引用的需求自定义属性
getExternalTypeName	从外部工件获取需求类型名称
getImplementationStatus	查询引用需求实现状况摘要
getPostImportFcn	获取 `PostImportFcn` 回调的内容
getPreImportFcn	获取已注册的 `PreImportFcn` 回调脚本
getVerificationStatus	查询引用需求验证状态摘要
hasNewUpdate	检查导入节点是否有可用更新
inLinks	获取引用需求的入站链接
isFilteredIn	检查已过滤的引用需求
isJustifiedFor	检查引用的需求是否已申述
justifyImplementation	申述用于实现的引用需求
justifyVerification	申述以验证的引用需求
moveDown	将引用的需求在层次结构中向下移动
moveUp	将引用的需求向上移动一层
navigateToExternalArtifact	从导入的参考需求导航至原始需求
outLinks	获取引用需求的出向链接
parent	查找引用需求的父项
remove	删除引用需求
reqSet	返回父级需求集
setAttribute	设置引用的需求自定义属性
setParent	在 `PostImportFcn` 回调中设置引用需求的父级
setPostImportFcn	分配 `PostImportFcn` 回调脚本
setPreImportFcn	分配 `PreImportFcn` 回调脚本
unlock	解锁引用需求
unlockAll	解锁所有子引用需求以供编辑
updateFromDocument	从外部需求文档更新引用需求

示例

全部折叠

查找引用需求

此示例显示如何在需求集查找引用的需求。

加载名为 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 文档导入和编辑需求

slreq.Reference 类

描述

创建对象

输入参量

rs — 需求集对象 slreq.ReqSet 对象

FileName — 容器标识符 字符向量

输出参量

ref — 引用需求 slreq.Reference 对象

属性

Id — 引用的需求 ID 字符向量

属性：

CustomId — 引用需求自定义 ID 字符向量

属性：

Artifact — 容器标识符 字符向量

属性：

ArtifactId — 需求标识符 字符向量

属性：

Domain — 外部需求文档接口名称 字符向量

属性：

UpdatedOn — 引用需求的最后更新日期和时间 datetime

属性：

CreatedOn — 参考需求创建日期 datetime

属性：

CreatedBy — 参考需求创建者 字符向量

属性：

ModifiedBy — 引用需求修饰符 字符向量

属性：

IsLocked — 参考需求锁定指示器 1 (默认) | 0

属性：

Summary — 引用的需求摘要 字符向量

属性：

Description — 引用的需求描述 字符向量

属性：

Rationale — 引用的需求理由 字符向量

属性：

Keywords — 引用需求关键字 字符数组

属性：

Type — 引用需求类型枚举 'Functional' | 'Informational' | 'Container' | 字符串标量 | 字符向量

属性：

IndexEnabled — 引用需求索引启用指示器 1 (默认) | 0

属性：

IndexNumber — 用户指定的参考需求索引值 空 double 数组 (默认) | int32 数组

属性：

SID — 引用需求会话独立标识符 字符向量

属性：

FileRevision — 参考需求修订号 标量

属性：

ModifiedOn — 引用需求的修改日期 datetime

属性：

Dirty — 未保存的更改指示符 0 | 1

属性：

Comments — 引用的需求注释 结构体数组

属性：

Index — 引用的需求索引 字符数组

属性：

方法

示例

查找引用需求

版本历史记录

另请参阅

主题

`rs` — 需求集对象
`slreq.ReqSet` 对象

`FileName` — 容器标识符
字符向量

`ref` — 引用需求
`slreq.Reference` 对象

`Id` — 引用的需求 ID
字符向量

`CustomId` — 引用需求自定义 ID
字符向量

`Artifact` — 容器标识符
字符向量

`ArtifactId` — 需求标识符
字符向量

`Domain` — 外部需求文档接口名称
字符向量

`UpdatedOn` — 引用需求的最后更新日期和时间
`datetime`

`CreatedOn` — 参考需求创建日期
`datetime`

`CreatedBy` — 参考需求创建者
字符向量

`ModifiedBy` — 引用需求修饰符
字符向量

`IsLocked` — 参考需求锁定指示器
`1` (默认) | 0

`Summary` — 引用的需求摘要
字符向量

`Description` — 引用的需求描述
字符向量

`Rationale` — 引用的需求理由
字符向量

`Keywords` — 引用需求关键字
字符数组

`Type` — 引用需求类型枚举
`'Functional'` | `'Informational'` | `'Container'` | 字符串标量 | 字符向量

`IndexEnabled` — 引用需求索引启用指示器
`1` (默认) | `0`

`IndexNumber` — 用户指定的参考需求索引值
空 `double` 数组 (默认) | `int32` 数组

`SID` — 引用需求会话独立标识符
字符向量

`FileRevision` — 参考需求修订号
标量

`ModifiedOn` — 引用需求的修改日期
`datetime`

`Dirty` — 未保存的更改指示符
`0` | `1`

`Comments` — 引用的需求注释
结构体数组

`Index` — 引用的需求索引
字符数组