本页采用了机器翻译。点击此处可查看最新英文版本。

ExportOptions

将需求导出到 ReqIF 文件的选项

自 R2023a 起

全页展开

说明

使用 ExportOptions 对象在导出需求和 ReqIF™ 文件链接时配置选项。

创建对象

语法

myExportOptions = slreq.export.ExportOptions
myExportOptions = slreq.export.ExportOptions(Name=Value)

描述

myExportOptions = slreq.export.ExportOptions 创建一个 ExportOptions 对象。

myExportOptions = slreq.export.ExportOptions(Name=Value) 创建一个 ExportOptions 对象并使用一个或多个名称值参量设置可写的属性。例如，slreq.export.ExportOptions(Template="Generic") 将导出设置为映射到通用模板。

示例

属性

全部展开

要导出的必需属性和特性，指定为字符串数组或字符元胞数组。您可以通过指定属性或特性的名称来导出内置属性、原型属性或自定义属性。对于原型属性，请输入完全限定名称，包括配置文件名称。

示例: Attributes=["Summary","Description"]

示例: Attributes=["My Custom Attribute 1", "My Custom Attribute 2"]

示例: Attributes=["myProfile.myStereotype.myProperty1", "myProfile.myStereotype.myProperty2"]

数据类型: cell | string

导出的文件是否包含与需求集相关的链接，指定为数字或逻辑 0 (false) 或 1 (true)。

示例: IncludeLinks=true

数据类型: logical

此 属性 为只读。

导出期间使用的映射文件的文件路径，以字符向量形式返回。当您将 ExportOptions 对象作为输入传递给 slreq.export 函数时，Requirements Toolbox™ 会设置此属性的值。

数据类型: char

导出的 ReqIF 文件名和目录，指定为字符串标量或字符向量。文件名必须具有 .reqif 或 .reqifz 扩展名。如果需求包含图像并且您使用 .reqif 扩展名，该函数会自动更新文件的扩展名。

示例: OutputFile="myExportedReqIF.reqif"

数据类型: char | string

导出映射，指定为以下选项之一：

值描述
空字符串标量或字符向量导出使用导入的需求集的映射。否则，导出将映射到通用模板。
"Generic"导出模板映射到通用模板。
"IBM DOORS"

导出模板映射到 IBM® DOORS®。

"IBM DOORS Next"

导出模板映射到 IBM DOORSNext。

"Jama Software"导出模板映射到 Jama 软件。
"Polarion"导出模板映射到 Polarion™。
"PREEvision"导出模板映射到 PREEvision。

数据类型: enum

此 属性 为只读。

导出期间使用的模板文件的文件路径，以字符向量形式返回。当您将 ExportOptions 对象作为输入传递给 slreq.export 函数时，Requirements Toolbox 会设置此属性的值。

数据类型: char

导出期间使用的需求编辑器视图，指定为字符串标量或字符向量。该视图根据元数据过滤导出的需求和链接。

示例: View="myView"

数据类型: char | string

对象函数

getFilterableAttributes可导出到 ReqIF 的属性和特性
verify验证需求集的 ReqIF 导出选项

示例

全部折叠

此示例显示如何创建一个空的导出选项对象。

myExportOptions = slreq.export.ExportOptions
myExportOptions = 

  ExportOptions with properties:

      OutputFile: ''
        Template: ''
    IncludeLinks: 0
            View: ''
      Attributes: {}

通过设置 OutputFile 属性值来指定导出的 ReqIF 文件的名称。

myExportOptions.OutputFile = "myReqIF.reqif"
myExportOptions = 

  ExportOptions with properties:

      OutputFile: "myReqIF.reqif"
        Template: ''
    IncludeLinks: 0
            View: ''
      Attributes: {}
打开实时脚本

此示例展示如何创建 ReqIF 导出选项、获取可用属性和自定义属性、指定要导出的属性和属性，以及验证生成的导出选项。

打开 ShortestPath 工程。

openProject("ShortestPath");

加载 shortest_path_func_reqs 需求集。

rs = slreq.open("shortest_path_func_reqs");

创建导出选项

创建一个导出选项对象，将输出文件指定为 shortest_path_func_reqif.reqif，导出链接，并使用通用导出映射。

myExportOptions = slreq.export.ExportOptions( ...
    OutputFile="shortest_path_func_reqif.reqif",IncludeLinks=true,Template="Generic")
myExportOptions = 
  ExportOptions with properties:

      OutputFile: "shortest_path_func_reqif.reqif"
        Template: "Generic"
    IncludeLinks: 1
            View: ''
      Attributes: {}
     MappingFile: ''
    TemplateFile: ''

指定要导出的属性

使用 getFilterableAttributes 函数获取要导出的可用属性。

attributes = getFilterableAttributes(myExportOptions,rs)
attributes = 1x11 cell
    {'Summary'}    {'Type'}    {'Keywords'}    {'CreatedOn'}    {'CreatedBy'}    {'ModifiedOn'}    {'ModifiedBy'}    {'Revision'}    {'Description'}    {'Rationale'}    {'Priority'}

通过设置 Summary 导出选项属性的值，仅导出 Description 和 Priority 属性以及 Attributes 自定义属性。

myExportOptions.Attributes = ["Summary","Description","Priority"]
myExportOptions = 
  ExportOptions with properties:

      OutputFile: "shortest_path_func_reqif.reqif"
        Template: "Generic"
    IncludeLinks: 1
            View: ''
      Attributes: ["Summary"    "Description"    "Priority"]
     MappingFile: ''
    TemplateFile: ''

验证导出选项和导出需求

验证 shortest_path_func_reqs 需求集的导出选项对象。

status = verify(myExportOptions,rs)
status = logical
   1

将需求集集导出至 ReqIF 文件。

dir = slreq.export(rs,myExportOptions)
dir = 
'shortest_path_func_reqif.reqif'

版本历史记录

在 R2023a 中推出

全部展开

另请参阅

类

函数

主题