rmi

Взаимодействуйте программно с Requirements Management Interface

свернуть все на странице

Синтаксис

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 register linktypename
rmi unregister linktypename
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)

Описание

пример

reqlinks = rmi('createEmpty') создает пустой экземпляр структуры данных ссылок требования.

пример

reqlinks = rmi('get', object) возвращается требование соединяет структуру данных для object.

reqlinks = rmi('get', sig_builder, group_idx) возвращается требование соединяет структуру данных для группы Signal Builder, заданной индексом group_idx.

пример

rmi('set', model, reqlinks) наборы reqlinks как требования соединяются для model.

rmi('set', sig_builder, reqlinks, group_idx) наборы reqlinks как требования соединяют для группы сигнала group_idx в блоке Signal Builder sig_builder.

пример

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) возвращает команду MATLAB®, по которой cmdStr раньше перемещался к object.

[cmdStr, titleStr] = rmi('navCmd', object) возвращает команду MATLAB cmdStr и заголовок titleStr, который предоставляет описательный текст для object.

object = rmi('guidlookup', model, guidStr) возвращает имя объекта в model, который имеет глобально уникальный идентификатор guidStr.

rmi('highlightModel', object) подсветки все объекты в родительской модели object, которые имеют ссылки требования.

rmi('unhighlightModel', object) удаляет выделение объектов в родительской модели object, которые имеют ссылки требования.

rmi('view', object, index) получает доступ к требованию, пронумерованному index в документе требований, сопоставленном с object.

dialog = rmi('edit', object) отображает диалоговое окно Requirements для object и возвращает указатель диалогового окна.

guidStr = rmi('guidget', object) возвращает глобально уникальный идентификатор для object. Глобально уникальный идентификатор создается для object, если это испытывает недостаток в том.

пример

rmi('report', model) генерирует отчет Трассируемости требований в формате HTML для model.

rmi('report', matlabFilePath) генерирует отчет Трассируемости требований в формате HTML для файла кода MATLAB, заданного matlabFilePath.

rmi('report', dictionaryFile) генерирует отчет Трассируемости требований в формате HTML для словаря данных Simulink®, заданного dictionaryFile.

rmi('projectreport') генерирует отчет Трассируемости требований в формате HTML для текущего проекта. Основная страница этого отчета имеет ссылки HTTP на отчеты для каждого элемента проекта, который имеет ассоциации трассируемости требований. Для получения дополнительной информации смотрите, Создают Отчет Трассируемости требований для Проекта.

rmi setup конфигурирует RMI для использования с вашим программным обеспечением MATLAB и устанавливает интерфейс для использования с программным обеспечением IBM® Rational® DOORS®.

rmi register linktypename указывает тип настраиваемой ссылки, заданный функциональным linktypename. Для получения дополнительной информации смотрите Регистрацию Типа Настраиваемой ссылки.

rmi unregister linktypename удаляет тип настраиваемой ссылки, заданный функциональным linktypename. Для получения дополнительной информации смотрите Регистрацию Типа Настраиваемой ссылки.

rmi linktypelist отображает список в настоящее время зарегистрированных типов ссылки. Список указывает, является ли каждый тип ссылки встроенным или пользовательским, и обеспечивает путь к функции, используемой для ее регистрации.

number_problems = rmi('checkdoc') валидность проверок ссылок на Simulink из документа требований в Microsoft® Word, Microsoft Excel® или Rational DOORS IBM. Это запрашивает название документа требований, возвращает общее количество проблем, обнаруженных, и открывает отчет HTML в веб-браузере MATLAB. Для получения дополнительной информации смотрите, Подтверждают Ссылки Требований в Документе Требований.

number_problems = rmi('checkdoc', docName) валидность проверок ссылок на Simulink из документа требований задана docName. Это возвращает общее количество обнаруженных проблем и открывает отчет HTML в веб-браузере MATLAB. Для получения дополнительной информации смотрите, Подтверждают Ссылки Требований в Документе Требований.

rmi('check', matlabFilePath) непротиворечивость проверок ссылок трассируемости, сопоставленных со строками кода MATLAB в файле .m matlabFilePath, и, открывает отчет HTML в веб-браузере MATLAB.

rmi('check', dictionaryFile) непротиворечивость проверок ссылок трассируемости, сопоставленных со словарем данных Simulink dictionaryFile, и, открывает отчет HTML в веб-браузере MATLAB.

rmi('doorssync', model) открывает диалоговое окно настроек синхронизации DOORS, где можно настроить настройки синхронизации и синхронизировать модель с открытым проектом в базе данных IBM Rational DOORS.

[objHs, parentIdx, isSf, objSIDs] = rmi('getObjectsInModel', model) возвращает список объектов Simulink, которые могут быть рассмотрены для включения в модуль суррогата Rational DOORS IBM.

[objName, objType] = rmi('getObjLabel', object) возвращает имя объекта Simulink и информацию о Типе для объекта Simulink, с которым вы соединяетесь со сторонним приложением для управления требованиями.

пример

rmi('setDoorsLabelTemplate', template) задает новый пользовательский шаблон для меток ссылок требований на Rational DOORS IBM. Шаблон метки по умолчанию содержит номер раздела и объектное достижение цели ссылки требования DOORS. Чтобы вернуться шаблон метки ссылки назад к значению по умолчанию, введите rmi('setDoorsLabelTemplate', '') в подсказке команды MATLAB.

template = rmi('getDoorsLabelTemplate') возвращает в настоящее время заданный пользовательский шаблон для меток ссылок требований на Rational DOORS IBM.

label = rmi('doorsLabel', moduleID, objectID) генерирует метку для ссылки требований на объект IBM Rational DOORS, заданный objectID в модуле DOORS, заданном moduleID, согласно текущему шаблону.

пример

totalModifiedLinks = rmi('updateDoorsLabels', model) обновления все требования Rational DOORS IBM соединяют метки в model согласно текущему шаблону.

Примеры

свернуть все

Сопоставьте требование с блоком в модели slvnvdemo_fuelsys_officereq, измените ее описание и сохраните требование назад в тот блок. Задайте новую ссылку требования и добавьте его в существующие ссылки требований в блоке.

Получите ссылку требования, сопоставленную с блоком вычисления Потока воздуха в модели slvnvdemo_fuelsys_officereq в качестве примера.

slvnvdemo_fuelsys_officereq;
blk_with_req = sprintf('slvnvdemo_fuelsys_officereq/fuel rate\ncontroller' ...
'/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 = 'A new requirement';

Добавьте новую ссылку требования к существующим ссылкам требований для блока вычисления Потока воздуха.

rmi('cat', blk_with_req, new_req);

Создайте отчет HTML данных о трассируемости требований в модели в качестве примера.

Создайте отчет требований HTML для модели slvnvdemo_fuelsys_officereq в качестве примера.

rmi('report', 'slvnvdemo_fuelsys_officereq');

Веб-браузер MATLAB открывается, показывая отчет.

Задайте новый шаблон метки для ссылок на требования в DOORS и обновите метки всех ссылок требований DOORS в вашей модели, чтобы соответствовать новому шаблону.

Задайте новый шаблон метки для ссылок требований на Rational DOORS IBM так, чтобы новые ссылки на объекты DOORS были маркированы соответствующим ID модуля, возразили абсолютному номеру и значению 'Резервного' атрибута. 

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

Задайте новый шаблон метки для ссылок требований на Rational DOORS IBM и установите максимальную длину метки на (например), 200 символов. 

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

Обновите существующие метки ссылки требований DOORS, чтобы совпадать с новым заданным шаблоном в вашей модели example_model. При обновлении меток должны запускаться DOORS, и все соединенные модули должны быть доступными для чтения.

rmi('updateDoorsLabels', example_model);

Входные параметры

свернуть все

Модель Simulink или диаграмма Stateflow, с которой могут быть сопоставлены требования, задали как вектор символов или указатель.

Пример: 'slvnvdemo_officereq'

Типы данных: char

Объект модели, с которым могут быть сопоставлены требования, задал как вектор символов или указатель.

Пример: 'slvnvdemo_fuelsys_officereq/fuel rate controller/Airflow calculation'

Типы данных: char

Блок Signal Builder, содержащий группу сигнала с ассоциациями трассируемости требований, заданными как вектор символов или указатель.

Типы данных: char

Индекс группы Signal Builder, заданный как скаляр.

Пример 2

Типы данных: char

Файл кода MATLAB с ассоциациями трассируемости требований, заданными как путь к файлу.

Пример:

Типы данных: char

Словарь данных Simulink с ассоциациями трассируемости требований, заданными как вектор символов, содержащий имя файла и, опционально, путь словаря.

Пример:

Типы данных: char

Глобально уникальный идентификатор для объекта модели object, заданный как вектор символов.

Пример: GIDa_59e165f5_19fe_41f7_abc1_39c010e46167

Типы данных: char

Индекс требования соединяется с объектом модели, заданным как целое число.

Документ требований во внешнем приложении, заданном как вектор символов, который представляет одно из следующего:

  • ID модуля Rational DOORS IBM.

  • путь к документу требований Microsoft Word.

  • путь к документу требований Microsoft Excel.

Для получения дополнительной информации смотрите, Подтверждают Ссылки Требований в Документе Требований.

Пример:

Типы данных: char

Обработайте метку по шаблону для ссылок на требования в Rational DOORS IBM, заданном как вектор символов.

Можно использовать следующие спецификаторы формата, чтобы включать связанную информацию о DOORS в марки ссылок требований:

%hОбъектный заголовок
%tОбъектный текст
%pПрефикс модуля
%nВозразите абсолютному номеру
%mID модуля
%PНазвание проекта
%MИмя модуля
%UДВЕРНОЙ URL
%<ATTRIBUTE_NAME>Другой атрибут DOORS вы задаете

Пример: '%m:%n [backup=%<Backup>]'

Типы данных: char

Модуль Rational DOORS IBM, заданный как уникальный ID модуля DOORS.

Пример:

Типы данных: char

Объект IBM Rational DOORS в модуле DOORS moduleID, заданный как локально уникальный ID DOORS.

Пример:

Типы данных: char

Выходные аргументы

свернуть все

Требование соединяет данные, возвращенные как массив структур со следующими полями:

doc

Вектор символов, идентифицирующий документ требований

id

Местоположение определения вектора символов в документе требований. Первый символ задает тип идентификатора:

Сначала
Символ		ИдентификаторПример

?

Искомый текст, первое вхождение которого расположено в документе требований

'?Requirement 1'

@

Названный элемент, такой как закладка в файле Microsoft Word или привязка в файле HTML

'@my_req'

#

Страница или номер изделия

'#21'

>

Номер строки

'>3156'

$

Область значений рабочего листа в электронной таблице

'$A2:C5'

linked

Булево значение, задающее, доступна ли ссылка требования для генерации отчета и выделения:

1 (значение по умолчанию). Подсветите объект модели и включайте ссылку требования в отчеты.
0
description

Вектор символов, описывающий требование

keywords

Дополнительный вектор символов, добавляющий description

reqsys

Вектор символов, идентифицирующий ссылку, вводит регистрационное имя; 'other' для встроенных типов ссылки

Команда, используемая, чтобы переместиться к объекту модели по object, возвратилась как вектор символов.

Пример: rmiobjnavigate('slvnvdemo_fuelsys_officereq.slx', 'GIDa_59e165f5_19fe_41f7_abc1_39c010e46167');

Текстовое описание объекта модели со ссылками требований, возвращенными как вектор символов.

Пример: slvnvdemo_fuelsys_officereq/.../Airflow calculation/Pumping Constant (Lookup2D)

Глобально уникальный идентификатор для объекта модели object, возвращенный как вектор символов.

Пример: GIDa_59e165f5_19fe_41f7_abc1_39c010e46167

Диалоговое окно Requirements для объекта модели object, возвращенный как указатель на диалоговое окно.

Общее количество недопустимых ссылок обнаружило во внешнем документе docName.

Для получения дополнительной информации смотрите, Подтверждают Ссылки Требований в Документе Требований.

Общее количество ссылок требований DOORS обновляется с новым шаблоном метки.

Список числовых указателей, возвращенных как массив.

Индексы иерархии модели, возвращенные как массив.

Логический массив, который указывает, которому соответствуют положения списка, которому возражает Stateflow.

Независимые от сеанса идентификаторы Simulink, возвращенные как массив.

Смотрите также

| | | | |

Представленный в R2006b

Документация Simulink Requirements
Поддержка
Для просмотра документации необходимо авторизоваться на сайте