slreq.callback.ReqIFImportOptions 类

命名空间: slreq.callback

ReqIF 导入选项

自 R2022a 起

描述

使用 slreq.callback.ReqIFImportOptions 类的对象来调整导入需求时要使用的选项。当您从 ReqIF™ 文件导入需求时，slreq.getCurrentImportOptions 会生成一个 slreq.callback.ReqIFImportOptions 对象，您可以使用该对象来调整导入期间要使用的选项。您只能在 PreImportFcn 回调中访问该对象。

slreq.callback.ReqIFImportOptions 类是 handle 类。

创建对象

如果您从 ReqIF 文件导入需求，则 options = slreq.getCurrentImportOptions 返回 slreq.callback.ReqIFImportOptions 对象。

属性

全部展开

`MappingFile` — 属性映射文件
字符串标量 | 字符向量

导入期间使用的属性映射文件，指定为字符串标量或字符向量。指定文件的完整文件路径。

属性：

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

`Attr2ReqProp` — 属性映射
`containers.Map` 对象

从 ReqIF 属性到 Requirements Toolbox™ 属性的属性映射，指定为 containers.Map 对象。例如，此代码创建一个映射的 containers.Map 对象：

ReqSum 到 Summary
Desc 到 Description
ID 到 CustomId

attrMap = containers.Map(ReqSum="Summary");
attrMap("Desc") = "Description";
attrMap("ID") = "Custom ID";

示例: myImportOptions.Attr2ReqProp = attrMap;

属性：

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

`SingleSpec` — 需要导入的单一规格名称
字符串标量 | 字符向量

从 ReqIF 文件导入的单一规范的名称，指定为字符串标量或字符向量。如果 ReqIF 文件有多个规范，则只导入该规范。

属性：

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

`AsMultipleReqSets` — 导入到单独需求集的选项
`0` (默认) | `1`

将每个规范导入单独的需求集，指定为数据类型为 1 的 0 或 logical。

如果您的 ReqIF 文件具有多个规范，并且您将此属性设置为 0，则这些规范将合并为一个需求集。

属性：

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

`ImportLinks` — 导入链接的选项
`1` (默认) | `0`

选择从 ReqIF 文件导入链接，指定为数据类型为 1 的 0 或 logical。

属性：

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

`AutoDetectMapping` — 自动检测映射的选项
`1` (默认) | `0`

该选项允许 Requirements Toolbox 根据 ReqIF 文件的内容自动检测要使用的属性映射，指定为数据类型为 1 的 0 或 logical。

属性：

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

`AsReference` — 导入为参考的选项
`1` (默认) | `0`

选择导入为 slreq.Reference 对象，指定为数据类型为 logical 的 1 或 0。如果是 0，需求导入为 slreq.Requirement 对象。

属性：

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

`RichText` — 可选择使用富文本格式导入
`0` (默认) | `1`

使用富文本导入需求的选项，指定为数据类型为 logical 的 1 或 0。

属性：

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

`DocUri` — 需求文档的资源标识符
字符串标量 | 字符向量

外部需求文档的资源标识符，指定为字符串标量或字符向量。

属性：

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

`DocType` — 需求文档自定义链接类型
字符串标量 | 字符向量

需求文档自定义链接类型，以字符串标量或字符向量形式返回。

属性：

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

`ReqSet` — 需求集名称
字符向量

需求集名称，以字符向量形式返回。

属性：

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

`PreImportFcn` — `PreImportFcn` 回调的内容
字符串标量 | 字符向量

当前导入节点的 PreImportFcn 回调的内容，指定为字符串标量或字符向量。

属性：

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

`PostImportFcn` — `PostImportFcn` 回调的内容
字符串标量 | 字符向量

当前导入节点的 PostImportFcn 回调的内容，指定为字符串标量或字符向量。

属性：

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

示例

全部折叠

自定义 ReqIF 导入选项

打开实时脚本

此示例展示如何使用 PreImportFcn 回调自定义 ReqIF™ 导入选项。

使用 slreq.import 将 ReqIF™ 文件 mySpec.reqif 导入 Requirements Toolbox™。将导入的需求集 myReqSet，并将脚本 myPreImportScript 注册为导入时使用的 PreImportFcn 回调。返回需求集的句柄。

[~,~,rs] = slreq.import("mySpec.reqif",ReqSet="myReqSet",preImportFcn="myPreImportScript");

脚本 myPreImportScript 使用 slreq.getCurrentImportOptions 来获取导入选项，然后指定导入期间要使用的属性映射文件。

type myPreImportScript.m

importOptions = slreq.getCurrentImportOptions;
importOptions.MappingFile = "myMappingFile.xml";

返回 importOptions 对象。

importOptions

importOptions = 
  ReqIFImportOptions with properties:

          MappingFile: "myMappingFile.xml"
         Attr2ReqProp: []
           SingleSpec: ''
    AsMultipleReqSets: 0
          ImportLinks: 1
    AutoDetectMapping: 1
          AsReference: 1
             RichText: 0
               DocUri: 'C:\Users\jdoe\MATLAB\Examples\CustomizeReqIFImportOptionsExample\mySpec.reqif'
              DocType: 'REQIF'
               ReqSet: 'myReqSet'
         PreImportFcn: 'myPreImportScript'
        PostImportFcn: ''

版本历史记录

在 R2022a 中推出

另请参阅

slreq.getCurrentImportOptions | setPreImportFcn | getPreImportFcn

主题

使用回调自定义需求导入行为

slreq.callback.ReqIFImportOptions 类

描述

创建对象

属性

MappingFile — 属性映射文件 字符串标量 | 字符向量

属性：

Attr2ReqProp — 属性映射 containers.Map 对象

属性：

SingleSpec — 需要导入的单一规格名称 字符串标量 | 字符向量

属性：

AsMultipleReqSets — 导入到单独需求集的选项 0 (默认) | 1

属性：

ImportLinks — 导入链接的选项 1 (默认) | 0

属性：

AutoDetectMapping — 自动检测映射的选项 1 (默认) | 0

属性：

AsReference — 导入为参考的选项 1 (默认) | 0

属性：

RichText — 可选择使用富文本格式导入 0 (默认) | 1

属性：

DocUri — 需求文档的资源标识符 字符串标量 | 字符向量

属性：

DocType — 需求文档自定义链接类型 字符串标量 | 字符向量

属性：

ReqSet — 需求集名称 字符向量

属性：

PreImportFcn — PreImportFcn 回调的内容 字符串标量 | 字符向量

属性：

PostImportFcn — PostImportFcn 回调的内容 字符串标量 | 字符向量

属性：

示例