Exponenta Banner
exponenta event banner

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® Рациональный® ДВЕРИ® программное обеспечение.

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, в котором можно настроить параметры синхронизации и синхронизировать модель с открытым проектом в базе данных IBM RATIONAL DOORS.

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

[objName, objType] = rmi('getObjLabel', object) возвращает Simulink object Name и Type информацию для объекта 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

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

Пример: 2

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

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

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

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

Типы данных: 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-АДРЕС ДВЕРЕЙ
%<ATTRIBUTE_NAME>Другой заданный атрибут DOORS

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

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

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

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

Объект IBM Rational DOORS в модуле DOORS moduleID, заданный как локально уникальный идентификатор ДВЕРЕЙ.

Типы данных: 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.

Session-independent Идентификаторы, возвращенные как массив.

См. также

| | | | |

Введенный в R2006b

Simulink Requirements документация

Поддержка