Main Content

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

rmipref

获取或设置存储在 prefdir 中的 Requirements Toolbox预设项

全页折叠

语法

rmipref
currentVal = rmipref(prefName)
previousVal = rmipref(Name=Value)

说明

rmipref 返回您可以设置的预设项的 Name=Value参量列表。

示例

currentVal = rmipref(prefName) 返回由 prefName 指定的预设项的当前值。

示例

previousVal = rmipref(Name=Value) 为 Name 指定的预设项设置新值，并返回该预设项的先前值。

示例

全部折叠

ModelPathReference预设项的值决定了 Requirements Toolbox™ 如何在外部需求文档中存储对您的设计工件的引用。要查看此预设项的当前值，请输入：

currentVal = rmipref("ModelPathReference")

ModelPathReference预设项的默认值是 none。

currentVal =

none

此值指定 Requirements Toolbox 仅在引用其在外部需求文档中创建的设计工件时使用模型文件名。

指定用户关键字design和reqts适用于新的基于选择的需求链接。

previousVal = rmipref("SelectionLinkKeyword","design,reqts")

当您为首预设项指定新值时，rmipref 将返回该预设项的先前值。在这种情况下，previousVal 是一个空字符向量，因为 SelectionLinkKeyword预设项的先前值为空。

previousVal =

     ''

查看当前为 SelectionLinkKeyword预设项指定的值。

currentVal = rmipref("SelectionLinkKeyword")
currentVal =

design,reqts

这些用户关键字适用于所有新的基于选择的需求链接。

配置Requirements Toolbox以将需求链接数据嵌入模型文件中，而不是单独的 SLMX 文件中。

注意

如果您的模型有内部存储的现有需求链接，则需要先将这些链接移动到外部 SLMX 文件中，然后再更改需求可追溯性数据的存储设置。查看 将内部存储的需求链接移动到外部存储 以了解更多信息。

要在模型文件中嵌入需求可追溯性数据，请将 StoreDataExternally预设项设置为 0。

previousVal = rmipref("StoreDataExternally",0)

当您为首预设项指定新值时，rmipref 将返回该预设项的先前值。默认情况下，Requirements Toolbox 将需求链接数据外部存储在单独的 SLMX 文件中，因此此预设项的先前值为 1。

previousVal =

     1

将 StoreDataExternally预设项设置为 0。

currentVal = rmipref("StoreDataExternally")
currentVal =

     0

输入参数

全部折叠

预设项名称，指定为 名称-值参数 部分中的值之一。

名称-值参数

将可选参数对参量为 Name=Value，其中 Name 是参量名称，Value 是相应的值。

示例: previousVal = rmipref(BiDirectionalLinking=true)

在第三方应用程序中插入反向链接的预设项，指定为数字或逻辑 1 (true) 或 0 (false)。

当您启用此预设项并在 Microsoft® Word、Microsoft Excel® 和 IBM® DOORS® 中创建指向需求的直接链接时，Requirements Toolbox 会在外部需求文档中插入反向链接。有关详细信息，请参阅 管理外部需求文档中的导航反向链接

示例: previousVal = rmipref(BiDirectionalLinking=true)

数据类型: logical

用于存储自定义设置的预设项，指定为结构体数组。结构体数组的字段定义自定义设置的名称和值。默认值是一个带有字段 inUse 的结构体，其值为 0。

提示

使用struct函数创建结构体数组。

示例: previousVal = rmipref(CustomSettings=struct("MySetting",0))

数据类型: struct

预设项直接链接到第三方应用程序中的需求的路径，指定为：

  • "none" - 直接链接路径仅包含文档文件名

  • "absolute" - 直接链接路径是需求文档的绝对路径

  • "pwdRelative" - 直接链接路径是 MATLAB® 中当前文件夹的相对路径

  • "modelRelative" - 直接链接路径是相对于链接源工件的相对路径

有关更多信息，请参阅 文档路径存储。

示例: previousVal = rmipref(DocumentPathReference="absolute")

数据类型: string | char

预设项设置IBM DOORS反向链接方向，指定为数字或逻辑1（true）或0（false）。

默认情况下，Requirements Toolbox 将反向链接插入为出向链接。当您将此预设项设置为 true 时，Requirements Toolbox 会将反向链接插入为入站链接。

注意

此预设项仅适用于 IBM DOORS 中的链接，而不适用于 IBM DOORS Next。

示例: previousVal = rmipref(DoorsBacklinkIncoming=true)

数据类型: logical

IBM DOORS 模块 ID，指定为字符串标量或字符向量。

使用此预设项可从您从 IBM DOORS 生成的 ReqIF™ 文件导入的 Requirements Toolbox需求通过指定 IBM DOORS 模块 ID 进行导航。

示例: previousVal = rmipref(DoorsModuleID="000001c1")

数据类型: char | string

预设项在 IBM DOORS 替代模型中包含注释和区域注释，指定为数字或逻辑 1 (true) 或 0 (false)。

当您将此预设项设置为 true 时，Requirements Toolbox 会在您创建 IBM DOORS 替代模块时包含来自 Simulink® 模型的注释和区域注释。有关更多信息，请参阅 使用替代模块同步 IBM DOORS 中的需求可追溯性。

示例: previousVal = rmipref(DoorsSyncAnnotations=true)

数据类型: logical

复制模型元素时复制链接的预设项，指定为数字或逻辑 1 (true) 或 0 (false)。

默认情况下，当您复制并粘贴包含指向其他项目的链接的 Simulink、Stateflow® 或 System Composer™模型元素时，Requirements Toolbox 会复制并粘贴链接。当您将此预设项设置为 false 时，Requirements Toolbox 仅当您在模型中突出显示链接时才会复制链接。有关模型中突出显示的需求的更多信息，请参阅 突出显示具有需求的模型对象。

示例: previousVal = rmipref(DuplicateOnCopy=0)

数据类型: logical

预设项过滤由 Model Advisor需求一致性检查检查的链接，指定为数字或逻辑 1 (true) 或 0 (false)。当您将此预设项设置为 true 时，Model Advisor需求一致性检查仅检查具有 FilterRequireKeywords预设项指定的关键字的链接，而不检查具有 FilterExcludeKeywords预设项选项指定的关键字的链接。有关需求过滤的更多信息，请参阅 使用用户关键字过滤需求。

示例: previousVal = rmipref(FilterConsistencyChecking=true)

数据类型: logical

预设项从需求突出显示和需求报告中过滤链接，指定为数字或逻辑 1 (true) 或 0 (false)。

当您将此预设项设置为 true 时，Requirements Toolbox 将仅突出显示并包含在报告中具有由 FilterRequireKeywords预设项指定的关键字的链接，而不会突出显示或包含具有由 FilterExcludeKeywords预设项选项指定的关键字的链接。有关需求过滤的更多信息，请参阅 使用用户关键字过滤需求。

示例: previousVal = rmipref(FilterEnable=true)

数据类型: logical

预设项指定关键字以从模型突出显示、报告和模型顾问一致性检查中排除链接，指定为包含逗号分隔的关键字列表的字符串标量或字符向量。FilterConsistencyChecking、FilterMenusByKeywords 和 FilterEnable预设项使用这些关键字。

有关需求过滤的更多信息，请参阅 使用用户关键字过滤需求。

示例: previousVal = rmipref(FilterExcludeKeywords="design,test")

数据类型: char | string

预设项用于禁用上下文菜单中的链接，指定为数字或逻辑 1 (true) 或 0 (false)。当您将此预设项设置为 true 并将 FilterEnable 设置为 true 时，您可以禁用右键点击可链接项目时出现的需求上下文菜单中的链接。要禁用不包含特定关键字的链接，请使用 FilterRequireKeywords预设项指定关键字。要禁用具有特定关键字的链接，请使用 FilterExcludeKeywords预设项指定关键字。有关需求过滤的更多信息，请参阅 使用用户关键字过滤需求。

注意

如果您同时使用 FilterRequireKeywords 和 FilterExcludeKeywords预设项来指定关键字，则 Requirements Toolbox 将仅启用同时符合指定准则的链接。

示例: previousVal = rmipref(FilterMenusByKeywords=true)

数据类型: logical

预设项指定关键字以包含模型突出显示、报告和模型顾问一致性检查中的链接，指定为包含逗号分隔的关键字列表的字符串标量或字符向量。FilterConsistencyChecking、FilterMenusByKeywords 和 FilterEnable预设项使用这些关键字。

有关需求过滤的更多信息，请参阅 使用用户关键字过滤需求。

示例: previousVal = rmipref(FilterRequireKeywords="design,test")

数据类型: char | string

当删除所有链接时，预设项保留到 IBM DOORS 替代模块的链接，指定为数字或逻辑 1 (true) 或 0 (false)。有关替代模块的更多信息，请参阅 使用替代模块同步 IBM DOORS 中的需求可追溯性。

当您将此预设项设置为 true 并右键点击 Simulink模型元素并选择 此级别的需求 > 删除所有出向链接 时，Requirements Toolbox 会删除 Simulink 中的出向链接，但不会删除指向 IBM DOORS 替代模块中相应项目的出向链接。当您预设项设置为 false 并删除出向链接时，Requirements Toolbox 会删除出向链接（包括替代模块的链接）。默认情况下，右键点击 Simulink模型元素并选择 此级别的需求 > 删除所有出向链接 会打开一个对话框，其中可以选择保留或删除 IBM DOORS 替代模块中相应项目的出向链接。

示例: previousVal = rmipref(KeepSurrogateLinks=0)

数据类型: logical

外部需求文档中反向链接图标使用的图像的文件路径，指定为包含图像文件绝对路径的字符串标量或字符向量。当您指定自定义图像，然后在外部文档中创建需求的直接链接时，Requirements Toolbox 会在 Microsoft Word、Microsoft Excel 或 IBM DOORS 中的外部需求文档中插入一个带有指定图像的反向链接作为反向链接图标。

注意

您必须将BiDirectionalLinking设置为true才能在外部需求文档中插入反向链接。

示例: previousVal = rmipref(LinkIconFilePath="C:\Users\jdoe\pictures\myLinkIcon.jpg")

数据类型: char | string

用于与基于 Web 的服务集成的自定义身份验证回调函数，指定为字符串标量或字符向量。

如果您的网络需要默认身份验证过程不支持的高级身份验证，请使用此参量注册自定义身份验证回调函数。当您注册自定义身份验证回调函数，然后使用slreq.dngConfigure时，该函数会调用您的自定义函数来验证与IBM DOORS Next 服务器的连接。有关更多信息，请参阅 slreq.dngConfigure 的 提示 部分。

注意

自定义身份验证回调函数应采用以下形式：

function [success,cookies] = myCustomLoginProvider(server,options)
% Provide your implementation here
end
自定义身份验证函数应返回两个参量：成功状态和作为 matlab.net.http.field.CookieField 对象从服务器接收的经过身份验证的 cookie。

示例: previousVal = rmipref(LoginProvider="myCustomLoginProvider")

数据类型: char | string

从第三方应用程序需求到链接工件的直接链接路径的预设项，指定为以下值之一：

  • "absolute" - 直接链接路径包含 Simulink、Stateflow 或 System Composer模型的绝对路径。

  • "none" - 直接链接路径仅包含模型名称。

示例: previousVal = rmipref(ModelPathReference="absolute")

数据类型: char | string

自定义 OSCL 资源链接的链接标签，指定为字符串标量或字符向量。有关更多信息，请参阅生命周期协作开放服务网站上的关系标签。

默认情况下，链接标签包含需求标题或主要文本的前 40 个字符、ID 和链接项的工程名称。

数据类型: char | string

预设项更新MATLAB中的配置上下文，指定为数字或逻辑1（true）或0（false）。当您将此预设项设置为 true 时，Requirements Toolbox 会更新 MATLAB 中的配置上下文，以匹配 Web 浏览器中所选 OSLC 资源项的配置上下文。

示例: previousVal = rmipref(OslcMatchBrowserContext=true)

数据类型: logical

开放生命周期协作服务 (OSLC) 服务器地址，指定为字符串标量或字符向量。

示例: previousVal = rmipref(OslcServerAddress="https://your.jazzserver.com:9443")

数据类型: char | string

开放生命周期协作服务 (OSLC) 服务器需求管理根，指定为字符串标量或字符向量。默认值为 rm。

示例: previousVal = rmipref(OslcServerRMRoot="rm")

数据类型: char | string

开放生命周期协作服务 (OSLC) 用户名，指定为字符串标量或字符向量。

示例: previousVal = rmipref(OslcServerUser="jdoe")

数据类型: char | string

在配置 MATLAB 会话以与 IBM DOORS 集成时，预设项允许全局配置，接下来，指定为数字或逻辑 1 (true) 或 0 (false)。

示例: previousVal = rmipref(OslcUseGlobalConfig=true)

数据类型: logical

Polarion 工程 ID，指定为字符串标量或字符向量。

当您将需求从 Polarion 工程导出到 ReqIF 文件以及将 ReqIF 导入到 Requirements Toolbox 时，必须指定 Polarion 工程 ID，以便能够从 Requirements Toolbox 中导入的需求导航到 Polarion 工程中的需求。

示例: previousVal = rmipref(PolarionProjectId="EmbeddedControllerSpec")

数据类型: char | string

Polarion 服务器地址，指定为字符串标量或字符向量。包括协议前缀和端口号。

当您将需求从 Polarion 工程导出到 ReqIF 文件以及将 ReqIF 导入到 Requirements Toolbox 时，必须指定 Polarion 服务器地址，以便能够从 Requirements Toolbox 中导入的需求导航到 Polarion 工程中的需求。

示例: previousVal = rmipref(PolarionServerAddress="https://your.polarionserver.com:9443")

数据类型: char | string

预设项在模型可追溯性报告中包含来自外部需求文档的附加信息，指定为数字或逻辑 1 (true) 或 0 (false)。当此预设项为 true 时，Requirements Toolbox 会包含来自以下第三方应用程序的附加信息：

  • Microsoft Word

  • Microsoft Excel

  • IBM DOORS

示例: previousVal = rmipref(ReportDocDetails=true)

数据类型: logical

预设项在模型可追溯性报告中包含来自引用库和数据字典的链接，指定为数字或逻辑 1 (true) 或 0 (false)。当您将此预设项设置为 true 时，需求报告将包括引用库中的需求链接以及 Simulink 模型中使用的数据字典条目的链接。

示例: previousVal = rmipref(ReportFollowLibraryLinks=true)

数据类型: logical

预设项突出显示模型可追溯性报告中的模型屏幕截图中具有链接的模型元素，指定为数字或逻辑 1 (true) 或 0 (false)。当您将此预设项设置为 true 时，Requirements Toolbox 会在模型可追溯性报告中突出显示 Simulink 模型屏幕截图中具有链接的模型对象。

示例: previousVal = rmipref(ReportHighlightSnapshots=0)

数据类型: logical

预设项在模型可追溯性报告中包含链接关键字，指定为数字或逻辑 1 (true) 或 0 (false)。当您将此预设项设置为true时，模型可追溯性报告将包含每个链接的关键字。有关关键字的更多信息，请参阅 使用用户关键字过滤需求。

示例: previousVal = rmipref(ReportIncludeKeywords=true)

数据类型: logical

预设项启用从模型可追溯性报告中导航到 MATLAB 和 Simulink 中的链接项，指定为数字或逻辑 1 (true) 或 0 (false)。当您将此预设项设置为 true 时，模型可追溯性报告包含超链接，可导航到 MATLAB 和 Simulink 中的每个链接源和目标。仅当 MATLAB 内部 HTTP 服务器处于活动时，这些链接才有效。

注意

默认情况下，模型可追溯性报告包含超链接，可导航至第三方文档中的链接需求。

数据类型: logical

预设项使用内部 HTTP 服务器作为模型可追溯性报告中的导航超链接，指定为数字或逻辑 1 (true) 或 0 (false)。当您将此预设项设置为 true 时，Requirements Toolbox 会在您使用报告超链接导航到链接源或目标时使用内部 HTTP 服务器。

注意

如果内部 HTTP 服务器处于活动，Requirements Toolbox 才能在报告中包含超链接。要激活服务器，请使用rmi函数：

rmi httpLink

示例: previousVal = rmipref(ReportNavUseMatlab=true)

数据类型: logical

预设项列出模型可追溯性报告中没有需求链接的模型对象，指定为数字或逻辑 1 (true) 或 0 (false)。当您将此预设项设置为 true 时，模型可追溯性报告将包含一个没有需求链接的模型元素表。

示例: previousVal = rmipref(ReportNoLinkItems=true)

数据类型: logical

在模型可追溯性报告中的需求链接表中，预设项使用文档 ID 而不是文档名称，指定为数字或逻辑 1 (true) 或 0 (false)。当您将此预设项设置为 true 时，模型可追溯性报告将使用可追溯性摘要表中定义的文档 ID 而不是需求集或文档名称来识别需求链接表中的链接工件。

提示

如果您的需求集或文档具有长名称，则可以使用此预设项来最小化名称在模型可追溯性报告中的表格中占用的空间。

示例: previousVal = rmipref(ReportUseDocIndex=true)

数据类型: logical

预设项使用相对路径从模型可追溯性报告导航到外部需求文档，指定为数字或逻辑 1 (true) 或 0 (false)。当您将此预设项设置为false时，Requirements Toolbox将使用绝对路径从模型可追溯性报告导航到外部需求文档。

示例: previousVal = rmipref(ReportUseRelativePath=0)

数据类型: logical

从 ReqIF 文件导入需求时预设项使用原型，指定为数字或逻辑 1 (true) 或 0 (false)。有关更多信息，请参阅 从 ReqIF 文件导入时使用原型。

示例: previousVal = rmipref(ReqIFImportUseProfile=true)

数据类型: logical

自定义导入映射文件的目录，指定为字符串标量或字符向量。使用完整文件路径指定目录。您可以通过输入以分号分隔的列表来指定多个目录。

示例: previousVal = rmipref(ReqIFMappingFilePath="C:/users/jdoe/MATLAB/mappings")

示例: previousVal = rmipref(ReqIFMappingFilePath="C:/users/jdoe/MATLAB/mappings;C/users/jdoe/downloads")

数据类型: char | string

预设项在需求上下文菜单中包含IBM DOORS 选择链接选项，指定为数字或逻辑1 (true) 或0 (false)。当您将此预设项设置为 false 时，Requirements Toolbox 会从您右键点击可链接项目并选择需求时出现的上下文菜单中隐藏链接到 DOORS 中的所选内容项。

示例: previousVal = rmipref(SelectionLinkDoors=0)

数据类型: logical

预设项在需求上下文菜单中包含 Microsoft Excel 选择链接选项，指定为数字或逻辑 1 (true) 或 0 (false)。当您将此预设项设置为 false 时，Requirements Toolbox 会从您右键点击可链接项目并选择需求时出现的上下文菜单中隐藏链接到 Excel 中的所选内容项。

示例: previousVal = rmipref(SelectionLinkExcel=0)

数据类型: logical

预设项将关键字添加到您创建的基于选择的链接中，指定为包含以逗号分隔的关键字列表的字符串标量或字符向量。有关需求过滤的更多信息，请参阅 使用用户关键字过滤需求。

示例: previousVal = rmipref(SelectionLinkKeyword="design")

数据类型: string | char

预设项在需求上下文菜单中包含Microsoft Word选择链接选项，指定为数字或逻辑1 (true)或0 (false)。当您将此预设项设置为 false 时，Requirements Toolbox 会从您右键点击可链接项目并选择需求时出现的上下文菜单中隐藏链接到 Word 中的所选内容项。

示例: previousVal = rmipref(SelectionLinkWord=0)

数据类型: logical

预设项将链接存储在外部链接集中，指定为数字或逻辑 1 (true) 或 0 (false)。默认情况下，Requirements Toolbox 将模型的出向链接存储在与模型文件位于同一文件夹中的链接集文件中。当您将此预设项设置为 false 时，Requirements Toolbox 会将模型的出向链接存储在模型文件中。有关更多信息，请参阅 需求链接存储 和 创建和存储链接。

示例: previousVal = rmipref(StoreDataExternally=true)

数据类型: logical

预设项启用 HTTP 服务器以便从第三方应用程序进行反向链接导航，指定为数字或逻辑 1 (true) 或 0 (false)。启用此预设项可以从使用 HTTP 协议的第三方需求应用程序中的反向链接导航到 MATLAB 或 Simulink 中的反向链接项目。

注意

HTTPS 服务器上的反向链接导航默认处于启用状态。

示例: previousVal = rmipref(UnsecureHttpRequests=true)

数据类型: logical

预设项在 Microsoft Office需求文档中使用 ActiveX 控件来控制反向链接，指定为数字或逻辑 1 (true) 或 0 (false)。有关更多信息，请参阅 为 Microsoft Office 配置 Requirements Toolbox。

示例: previousVal = rmipref(UseActiveXButtons=true)

数据类型: logical

输出参量

全部折叠

prefName 指定的预设项的当前值。预设项名称及其相关的可能值在 名称-值参数 中列出。

prefName 指定的预设项的先前值。预设项名称及其相关的可能值在 名称-值参数 中列出。

版本历史记录

在 R2013a 中推出

全部展开

另请参阅

主题