rmi

通过编程与需求管理界面进行交互

全页折叠

语法

reqlinks = rmi('createEmpty')

reqlinks = rmi('get',object)

reqlinks = rmi('get',sig_builder,group_idx)

rmi('set',model,reqlinks)

rmi('set',sig_builder,reqlinks,group_idx)

rmi('cat',model,reqlinks)

cnt = rmi('count',object)

rmi('clearAll',object)

rmi('clearAll',object,'deep')

rmi('clearAll',object,'noprompt')

rmi('clearAll',object,'deep','noprompt')

cmdStr = rmi('navCmd',object)

[cmdStr,titleStr] = rmi('navCmd',object)

object = rmi('guidlookup',model,guidStr)

rmi('highlightModel',object)

rmi('unhighlightModel',object)

rmi('view',object,index)

dialog = rmi('edit',object)

guidStr = rmi('guidget',object)

rmi('report',model)

rmi('report',matlabFilePath)

rmi('report',dictionaryFile)

rmi('projectreport')

rmi('setup')

rmi('setup','doors',false)

rmi register typename

rmi unregister typename

rmi('linktypelist')

number_problems = rmi('checkdoc')

number_problems = rmi('checkdoc',docName)

rmi('check',matlabFilePath)

rmi('check',dictionaryFile)

rmi('doorssync',model)

[objHs,parentIdx,isSf,objSIDs] = rmi('getObjectsInModel',model)

[objName,objType] = rmi('getObjLabel',object)

rmi('setDoorsLabelTemplate',template)

template = rmi('getDoorsLabelTemplate')

label = rmi('doorsLabel',moduleID,objectID)

totalModifiedLinks = rmi('updateDoorsLabels',model)

rmi httpLink

status = rmi("httpLink","status")

说明

示例

reqlinks = rmi('createEmpty') 创建需求链接数据结构体的空实例。

示例

reqlinks = rmi('get',object) 返回 object 的需求链接数据结构体。

reqlinks = rmi('get',sig_builder,group_idx) 返回索引 group_idx 指定的信号生成器组的需求链接数据结构体。

示例

rmi('set',model,reqlinks) 将 reqlinks 设置为 model 的需求链接。

rmi('set',sig_builder,reqlinks,group_idx) 将 reqlinks 设置为 Signal Builder模块sig_builder 中信号组 group_idx 的需求链接。

示例

rmi('cat',model,reqlinks) 将 reqlinks 中的需求链接添加到 model 现有的需求链接中。

cnt = rmi('count',object) 返回 object 的需求链接数量。

rmi('clearAll',object) 删除 object 的所有需求链接。

rmi('clearAll',object,'deep') 删除模型中包含 object 的所有需求链接。

rmi('clearAll',object,'noprompt') 删除 object 的所有需求链接并且不提示确认。

rmi('clearAll',object,'deep','noprompt') 删除模型中包含 object 的所有需求链接，并且不提示确认。

cmdStr = rmi('navCmd',object) 返回 cmdStr 用于导航到 object 的 MATLAB^® 命令。

[cmdStr,titleStr] = rmi('navCmd',object) 返回 MATLAB 命令 cmdStr 和为 object 提供描述性文本的标题 titleStr。

object = rmi('guidlookup',model,guidStr) 返回 model 中具有全局唯一标识符 guidStr 的对象名称。

rmi('highlightModel',object) 突出显示 object 父模型中所有具有需求链接的对象。

rmi('unhighlightModel',object) 删除了 object 父模型中具有需求链接的对象的突出显示。

rmi('view',object,index) 访问与 object 关联的需求文档中编号为 index 的需求。

dialog = rmi('edit',object) 显示 object 的需求对话框并返回该对话框的句柄。

guidStr = rmi('guidget',object) 返回 object 的全局唯一标识符。如果缺少全局唯一标识符，则为 object 创建一个。

示例

rmi('report',model) 为 model 生成 HTML 格式的需求可追溯性报告。

rmi('report',matlabFilePath) 为 matlabFilePath 指定的 MATLAB 代码文件生成 HTML 格式的需求可追溯性报告。

rmi('report',dictionaryFile) 为 dictionaryFile 指定的 Simulink^® 数据字典生成 HTML 格式的需求可追溯性报告。

rmi('projectreport') 为当前工程生成 HTML 格式的需求可追溯性报告。此报告的顶层页面具有指向具有需求可追溯性关联的每个工程项报告的 HTTP 链接。有关更多信息，请参阅为工程创建需求可追溯性报告。

rmi('setup') 配置 RMI 以供 MATLAB 使用，并安装接口以供 IBM^® DOORS^® 使用。

rmi('setup','doors',false) 配置 RMI 以供 MATLAB 使用，并安装接口以供 IBM DOORS 使用，而无需使用交互式设置。

rmi register typename 注册函数 typename 指定的自定义链接类型或自定义文档域类型名称。有关更多信息，请参阅定义自定义文档界面以直接链接到需求和定义自定义文档接口以导入需求。

rmi unregister typename 删除函数 typename 指定的自定义链接类型或自定义文档域类型名称。有关更多信息，请参阅定义自定义文档界面以直接链接到需求和定义自定义文档接口以导入需求。

rmi('linktypelist') 显示当前已注册的链接类型的列表。该列表指示每种链接类型是内置的还是自定义的，并提供用于其注册的函数的路径。

number_problems = rmi('checkdoc') 检查从 Microsoft^® Word、Microsoft Excel^® 或 IBM DOORS 中的需求文档到 Simulink 的链接的有效性。它提示需求文档名称，返回检测到的问题总数，并在 MATLAB Web 浏览器中打开 HTML 报告。有关更多信息，请参阅验证需求文档中的需求链接。

number_problems = rmi('checkdoc',docName) 检查 docName 指定的需求文档中指向 Simulink 的链接的有效性。它返回检测到的问题总数并在 MATLAB Web 浏览器中打开 HTML 报告。有关更多信息，请参阅验证需求文档中的需求链接。

rmi('check',matlabFilePath) 检查与 .m 文件 matlabFilePath 中的 MATLAB 代码行相关的可追溯性链接的一致性，并在 MATLAB Web 浏览器中打开 HTML 报告。

rmi('check',dictionaryFile) 检查与 Simulink 数据字典 dictionaryFile 相关的可追溯性链接的一致性，并在 MATLAB Web 浏览器中打开 HTML 报告。

rmi('doorssync',model) 打开 DOORS 同步设置对话框，您可以在其中自定义同步设置并将您的模型与 IBM DOORS 数据库中打开的工程同步。

[objHs,parentIdx,isSf,objSIDs] = rmi('getObjectsInModel',model) 返回可能考虑纳入 IBM DOORS 替代模块的 Simulink 对象列表。

[objName,objType] = rmi('getObjLabel',object) 返回您使用第三方需求管理应用程序链接到的 Simulink 对象的 Simulink 对象名称和类型信息。

示例

rmi('setDoorsLabelTemplate',template) 为指向 IBM DOORS 的需求链接标签指定了一个新的自定义模板。默认标签模板包含DOORS需求链接目标的章节编号和对象标题。要将链接标签模板恢复为默认值，请在 MATLAB 命令提示符下输入 rmi('setDoorsLabelTemplate','')。

template = rmi('getDoorsLabelTemplate') 返回当前指定的需求链接标签的自定义模板到 IBM DOORS。

label = rmi('doorsLabel',moduleID,objectID)根据当前模板，生成一个标签，用于将需求链接到moduleID指定的DOORS模块中objectID指定的IBM DOORS对象。

示例

totalModifiedLinks = rmi('updateDoorsLabels',model) 根据当前模板更新 model 中的所有 IBM DOORS需求链接标签。

示例

rmi httpLink 激活内部 HTTP 服务器，您可以使用它从使用 HTTP 协议的基于浏览器的第三方需求工具中的反向链接导航至 MATLAB 或 Simulink 中的链接项。HTTPS 服务器上的反向链接导航默认处于启用状态。

注意

或者，您可以使用 rmipref 函数将 UnsecureHttpRequests预设项设置为 true 来活动内部 HTTP 服务器。当 UnsecureHttpRequests预设项为 true 时，MATLAB 在启动时激活内部 HTTP 服务器。

示例

status = rmi("httpLink","status") 返回内部 HTTP 服务器的端口号。如果端口号是0，则服务器未处于活动。

示例

全部折叠

示例模型中的需求链接管理

获取与 slvnvdemo_fuelsys_officereq模型中的模块关联的需求，更改其描述，然后将需求保存回该模块。定义一个新的需求链接并将其添加到模块中现有的需求链接中。

获取与 slvnvdemo_fuelsys_officereq 示例模型中的气流计算模块相关的需求链接。

openExample("slvnvdemo_fuelsys_officereq.slx")
blk_with_req = ['slvnvdemo_fuelsys_officereq/fuel rate controller/'...
'Airflow calculation']
reqts = rmi('get',blk_with_req);

更改需求链接的描述。

reqts.description = 'Mass airflow estimation';

保存改变后的气流计算模块的需求链接描述。

rmi('set',blk_with_req,reqts);

创建指向示例文档 fuelsys_requirements2.htm 的新需求链接。

new_req = rmi('createempty');
new_req.doc = 'fuelsys_requirements2.htm';
new_req.description = 'New requirement';

将新的需求链接添加到气流计算模块的现有需求链接中。

rmi('cat',blk_with_req, new_req);

示例模型的需求可追溯性报告

在示例模型中创建需求可追溯性数据的 HTML 报告。

为slvnvdemo_fuelsys_officereq示例模型创建 HTML 需求报告。

openExample("slvnvdemo_fuelsys_officereq.slx")
rmi('report','slvnvdemo_fuelsys_officereq');

MATLAB Web 浏览器打开并显示报告。

需求标签链接至 IBM DOORS

为DOORS中的需求链接指定一个新的标签模板，并更新模型中所有DOORS需求链接的标签以适合新模板。

为指向 IBM DOORS 的需求链接指定一个新的标签模板，以便指向 DOORS 对象的新链接用相应的模块 ID、对象绝对编号和“备份”属性的值进行标记。

rmi('setDoorsLabelTemplate','%m:%n [backup=%<Backup>]');

为指向 IBM DOORS 的需求链接指定一个新的标签模板，并将最大标签长度设置为（例如） 200 个字符。

rmi('setDoorsLabelTemplate','%h %200');

更新现有的 DOORS需求链接标签以匹配模型example_model 中新指定的模板。更新标签时，DOORS 必须正在运行，并且所有链接模块必须可供读取。

rmi('updateDoorsLabels',example_model);

获取内部 HTTP 服务器状态并激活服务器

打开实时脚本

获取内部 HTTP 服务器状态。

status = rmi("httpLink","status")

status = struct with fields:
     httpPort: 0
    httpsPort: 31515

激活内部 HTTP 服务器。

rmi httpLink

获取内部 HTTP 服务器状态。

status = rmi("httpLink","status")

status = struct with fields:
     httpPort: 31415
    httpsPort: 31515

输入参数

全部折叠

`model` — Simulink 模型或 Stateflow^® 图，可与需求关联
名称 | 句柄

可与需求关联的 Simulink 模型或 Stateflow 图，指定为字符向量或句柄。

示例: 'slvnvdemo_officereq'

数据类型: char

`object` — 与需求关联的模型对象
名称 | 句柄

可与需求关联的模型对象，指定为字符向量或句柄。

示例: 'slvnvdemo_fuelsys_officereq/fuel rate controller/Airflow calculation'

数据类型: char

`sig_builder` — 包含具有需求可追溯性关联的信号组的 Signal Builder模块
名称 | 句柄

Signal Builder模块包含具有需求可追溯性关联的信号组，指定为字符向量或句柄。

数据类型: char

`group_idx` — Signal Builder 组索引
整数

信号生成器组索引，指定为标量。

示例: 2

数据类型: char

`matlabFilePath` — 具有需求可追溯性关联的 MATLAB 代码文件
路径

具有需求可追溯性关联的MATLAB代码文件，指定为文件路径。

数据类型: char

`dictionaryFile` — Simulink 具有需求可追溯性关联的数据字典
字符向量

Simulink 具有需求可追溯性关联的数据字典，指定为包含文件名和（可选）字典路径的字符向量。

数据类型: char

`guidStr` — 模型对象的全局唯一标识符
字符向量

模型对象 object 的全局唯一标识符，指定为字符向量。

示例: GIDa_59e165f5_19fe_41f7_abc1_39c010e46167

数据类型: char

`index` — 与模型对象关联的需求索引号
整数

与模型对象链接的需求的索引号，指定为整数。

`docName` — 外部应用程序中的需求文档
文件名 | 路径

外部应用程序中的需求文档，指定为表示下列之一的字符向量：

IBM DOORS 模块 ID。
Microsoft Word需求文档的路径。
Microsoft Excel需求文档的路径。

有关更多信息，请参阅验证需求文档中的需求链接。

`label` — IBM DOORS 中需求的链接标签
字符向量

IBM DOORS 中需求链接的标签，指定为字符向量。

数据类型: char

`template` — IBM DOORS 中需求链接的模板标签
字符向量

指向 IBM DOORS 中需求的链接的模板标签，指定为字符向量。

您可以使用以下格式说明符将相关的 DOORS 信息包含在需求链接标签中：

`%h`	对象标题
`%t`	对象文本
`%p`	模块前缀
`%n`	对象绝对数
`%m`	模块 ID
`%P`	工程名称
`%M`	模块名称
`%U`	DOORS URL
`%<ATTRIBUTE_NAME>`	您指定的其他 DOORS 属性

示例: '%m:%n [backup=%<Backup>]'

数据类型: char

`moduleID` — IBM DOORS 模块
DOORS 模块 ID

IBM DOORS 模块，指定为唯一的 DOORS 模块 ID。

数据类型: char

`objectID` — IBM DOORS 对象
DOORS 对象 ID

DOORS模块moduleID中的IBM DOORS对象，指定为本地唯一的DOORSID。

数据类型: char

输出参量

全部折叠

`reqlinks` — 需求链接数据
`struct`

需求链接数据，以具有以下字段的结构体数组形式返回：

doc

特征向量识别需求文档

id

特征向量定义需求文档中的位置。第一个字符指定标识符类型：

第一个字符	标识符	示例
`?`	搜索文本，第一次出现的位置位于需求文档中	`'?Requirement 1'`
`@`	已命名的项目，例如 Microsoft Word 文件中的书签或 HTML 文件中的锚点	`'@my_req'`
`#`	页码或项编号	`'#21'`
`>`	行号	`'>3156'`
`$`	电子表格中的工作表范围	`'$A2:C5'`

linked

布尔值指定需求链接是否可用于报告生成和突出显示：

1（默认）。突出显示模型对象并在报告中包含需求链接。

0

description

描述需求的字符向量

keywords

可选字符向量补充 description

reqsys

标识链接类型注册名称的字符向量；'other' 表示内置链接类型

`cmdStr` — 用于导航至模型对象的命令
字符向量

用于导航到模型对象object的命令，以字符向量形式返回。

示例: rmiobjnavigate('slvnvdemo_fuelsys_officereq.slx', 'GIDa_59e165f5_19fe_41f7_abc1_39c010e46167');

`titleStr` — 带有需求链接的模型对象的文本描述
字符向量

带有需求链接的模型对象的文本描述，以字符向量形式返回。

示例: slvnvdemo_fuelsys_officereq/.../Airflow calculation/Pumping Constant (Lookup2D)

`guidStr` — 模型对象的全局唯一标识符
字符向量

模型对象object的全局唯一标识符，以字符向量形式返回。

示例: GIDa_59e165f5_19fe_41f7_abc1_39c010e46167

`dialog` — 模型对象需求对话框
句柄

模型对象object的需求对话框，作为对话框的句柄返回。

`number_problems` — 外部文档中检测到的无效链接总数
整数

在外部文档 docName 中检测到的无效链接总数。

有关更多信息，请参阅验证需求文档中的需求链接。

`totalModifiedLinks` — 使用新标签模板更新的 DOORS需求链接总数
整数

使用新标签模板更新的DOORS需求链接总数。

`objHs` — 数值句柄
数组

数字句柄列表，以数组返回。

`parentIdx` — 模型层次结构索引
数组

模型层次结构索引，以数组返回。

`isSf` — 列表位置到Stateflow对象的对应关系
数组

指示哪些列表位置对应哪些 Stateflow 对象的逻辑数组。

`objSIDs` — Simulink ID
数组

与会话无关的 Simulink ID，以数组形式返回。

`status` — 内部 HTTP 和 HTTPS 服务器状态
结构体

内部 HTTP 和 HTTPS 服务器状态，以包含以下字段的结构体返回：

`httpPort` — HTTP 端口号
`double`

HTTP 端口号，以 double 形式返回。如果 HTTP 端口号是 0，则表示服务未处于活动。

`httpsPort` — HTTPS 端口号
`double`

HTTPS 端口号，以 double 形式返回。

版本历史记录

在 R2006b 中推出

全部展开

R2024a: 获取内部 HTTP 服务器端口号

使用以下语法将内部 HTTP 服务器端口号作为 status 输出返回：

status = rmi("httpLink","status");

另请参阅

rmi

语法

说明

示例

示例模型中的需求链接管理

示例模型的需求可追溯性报告

需求标签链接至 IBM DOORS

获取内部 HTTP 服务器状态并激活服务器

输入参数

model — Simulink 模型或 Stateflow® 图，可与需求关联 名称 | 句柄

object — 与需求关联的模型对象 名称 | 句柄

sig_builder — 包含具有需求可追溯性关联的信号组的 Signal Builder模块 名称 | 句柄

group_idx — Signal Builder 组索引 整数

matlabFilePath — 具有需求可追溯性关联的 MATLAB 代码文件 路径

dictionaryFile — Simulink 具有需求可追溯性关联的数据字典 字符向量

guidStr — 模型对象的全局唯一标识符 字符向量

index — 与模型对象关联的需求索引号 整数

docName — 外部应用程序中的需求文档 文件名 | 路径

label — IBM DOORS 中需求的链接标签 字符向量

template — IBM DOORS 中需求链接的模板标签 字符向量

moduleID — IBM DOORS 模块 DOORS 模块 ID

objectID — IBM DOORS 对象 DOORS 对象 ID

输出参量

reqlinks — 需求链接数据 struct

cmdStr — 用于导航至模型对象的命令 字符向量

titleStr — 带有需求链接的模型对象的文本描述 字符向量

guidStr — 模型对象的全局唯一标识符 字符向量

dialog — 模型对象需求对话框 句柄

number_problems — 外部文档中检测到的无效链接总数 整数

totalModifiedLinks — 使用新标签模板更新的 DOORS需求链接总数 整数

objHs — 数值句柄 数组

parentIdx — 模型层次结构索引 数组

isSf — 列表位置到Stateflow对象的对应关系 数组

objSIDs — Simulink ID 数组

status — 内部 HTTP 和 HTTPS 服务器状态 结构体

httpPort — HTTP 端口号 double

httpsPort — HTTPS 端口号 double

版本历史记录

R2024a: 获取内部 HTTP 服务器端口号

另请参阅

WeChat

`model` — Simulink 模型或 Stateflow^® 图，可与需求关联
名称 | 句柄

`object` — 与需求关联的模型对象
名称 | 句柄

`sig_builder` — 包含具有需求可追溯性关联的信号组的 Signal Builder模块
名称 | 句柄

`group_idx` — Signal Builder 组索引
整数

`matlabFilePath` — 具有需求可追溯性关联的 MATLAB 代码文件
路径

`dictionaryFile` — Simulink 具有需求可追溯性关联的数据字典
字符向量

`guidStr` — 模型对象的全局唯一标识符
字符向量

`index` — 与模型对象关联的需求索引号
整数

`docName` — 外部应用程序中的需求文档
文件名 | 路径

`label` — IBM DOORS 中需求的链接标签
字符向量

`template` — IBM DOORS 中需求链接的模板标签
字符向量

`moduleID` — IBM DOORS 模块
DOORS 模块 ID

`objectID` — IBM DOORS 对象
DOORS 对象 ID

`reqlinks` — 需求链接数据
`struct`

`cmdStr` — 用于导航至模型对象的命令
字符向量

`titleStr` — 带有需求链接的模型对象的文本描述
字符向量

`guidStr` — 模型对象的全局唯一标识符
字符向量

`dialog` — 模型对象需求对话框
句柄

`number_problems` — 外部文档中检测到的无效链接总数
整数

`totalModifiedLinks` — 使用新标签模板更新的 DOORS需求链接总数
整数

`objHs` — 数值句柄
数组

`parentIdx` — 模型层次结构索引
数组

`isSf` — 列表位置到Stateflow对象的对应关系
数组

`objSIDs` — Simulink ID
数组

`status` — 内部 HTTP 和 HTTPS 服务器状态
结构体

`httpPort` — HTTP 端口号
`double`

`httpsPort` — HTTPS 端口号
`double`