Exponenta Banner
exponenta event banner

rmi

Программное взаимодействие с интерфейсом управления требованиями

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

Синтаксис

reqlinks = rmi («createEmpty»)
reqlinks = rmi ('получить', объект)
reqlinks = rmi («получить», sig_builder, group_idx)
rmi («set», модель, обратные ссылки)
rmi («set», sig_builder, reqlinks, group_idx)
rmi ('кот', модель, обратные ссылки)
cnt = rmi ('count', объект)
rmi (clearAll, объект)
rmi («clearAll», объект, «deep»)
rmi («clearAll», объект, «noprompt»)
rmi («clearAll», объект, «deep», «noprompt»)
cmdStr = rmi («navCmd», объект)
[cmdStr, startStr] = rmi («navCmd», объект)
object = rmi («guidlookup», модель, guidStr )
rmi («» Модель «», объект)
rmi ('unhigheyModel', объект)
rmi (представление, объект, индекс)
dialog = rmi ('редактировать', объект)
guidStr = rmi ('guidget', объект)
rmi (отчет, модель)
rmi (отчет, matlabFilePath)
rmi («отчет», файл-каталог)
rmi ('projectreport')
установка rmi
rmi регистр linktypename
rmi отменить регистрацию linktypename
rmi linktypelist
number_problems = rmi ('checkdoc')
number_problems = rmi ('checkdoc', docName)
rmi («check», matlabFilePath)
rmi ('check', dictionateFile)
rmi («doorssync», модель)
[objHs, parentIdx, isSf, objSID] = rmi («getObjectsInModel», модель)
[objName, objType] = rmi («getObjLabel», объект)
rmi («setTalkedLabelTemplate», шаблон)
template = rmi («» getTalkingLabelTemplate «»)
маркируйте = rmi ('doorsLabel', moduleID, возраженный)
totalModifiedLinks = rmi ('updateDoorsLabels', модель)

Описание

пример

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 в блоке Построитель сигналов 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) отображает диалоговое окно «Требования» для 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') создает отчет Отслеживание требований (Requirements Traceability) в формате 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 ® или IBM Rational DOORS. Он запрашивает имя документа требований, возвращает общее количество обнаруженных проблем и открывает 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 synchronization settings), в котором можно настроить настройки синхронизации и синхронизировать модель с открытым проектом в базе данных IBM Rational DOORS.

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

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

пример

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

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

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

пример

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

Примеры

свернуть все

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

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

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

Измените описание ссылки требования.

reqts.description = 'Mass airflow estimation';

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

addpath(fullfile(matlabroot,'toolbox','slrequirements',...
'slrequirementsdemos','fuelsys_req_docs'))
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-отчета данных отслеживания требований в примерной модели.

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

rmi('report', 'slvnvdemo_fuelsys_officereq');

Откроется веб-браузер MATLAB, показывающий отчет.

Укажите новый шаблон меток для связей с требованиями в DOORS и обновите метки всех связей требований DOORS в модели в соответствии с новым шаблоном.

Укажите новый шаблон метки для ссылок требований на IBM Rational DOORS, чтобы новые ссылки на объекты DOORS были помечены соответствующим идентификатором модуля, абсолютным номером объекта и значением атрибута «Backup». 

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

Укажите новый шаблон метки для ссылок требований на IBM Rational DOORS и задайте максимальную длину метки, например, 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

Индекс группы построителя сигналов, заданный как скаляр.

Пример: 2

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

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

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

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

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

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

Пример: GIDa_59e165f5_19fe_41f7_abc1_39c010e46167

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

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

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

  • Идентификатор модуля IBM Rational DOORS.

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

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

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

Метка для ссылок на требования в IBM Rational DOORS, заданная как символьный вектор.

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

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

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

%hЗаголовок объекта
%tТекст объекта
%pПрефикс модуля
%nАбсолютное число объектов
%mИдентификатор модуля
%PНазвание проекта
%MИмя модуля
%UURL-АДРЕС DOORS
%<ATTRIBUTE_NAME>Другой указанный атрибут DOORS

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

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

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

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

Объект IBM Rational DOORS в модуле DOORS moduleID, указанный как локально уникальный идентификатор 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

диалоговое окно «Требования» для объекта модели object, возвращен в диалоговом окне в качестве дескриптора.

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

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

Общее количество связей требований DOORS, обновленных с помощью нового шаблона метки.

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

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

Логический массив, указывающий, какие позиции списка соответствуют объектам Stateflow.

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

См. также

| | | | |

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

Документация по требованиям Simulink

Поддержка