Связи требований и типы связей

Связи отслеживания требований

При необходимости перехода из модели Simulink ® или из области кода ^MATLAB ® в расположение внутри документа требований можно добавить ссылки отслеживания требований к модели или коду.

Связи отслеживания требований имеют следующие атрибуты:

Описание длиной до 255 символов.
Имя пути документа требований, например, файл Microsoft ® Word или модуль в базе данных ^IBM ® ^Rational ® ^DOORS ®. (RMI поддерживает несколько встроенных форматов документов. Можно также зарегистрировать пользовательские типы документов требований. См. раздел Поддерживаемые требования к типам документов.)
Указанное место внутри документа потребности, например:
- Закладка
- Якорь
- Я бы
- Номер страницы
- Номер строки
- Диапазон ячеек
- Цель ссылки
- Определяемые теги

Поддерживаемые объекты модели для связывания требований

Можно связать связи требований между следующими типами объектов модели Simulink:

Симуляционные блок-схемы и подсистемы
Блоки и аннотации Simulink
Статьи словаря данных Simulink
Группы сигналов Signal Builder
Диаграммы, подразделы, состояния, переходы и поля Stateflow ®
Функции потока состояний
Строки кода MATLAB
Тестовые примеры Simulink Test™ Manager

Ссылки и типы ссылок

Ссылки требований - это структуры данных, управляемые Simulink, которые определяют определенное местоположение в документе. Вы получаете и устанавливаете ссылки на блоке с помощью rmi команда.

Ссылки и типы ссылок работают вместе для выполнения навигации и управления требованиями. doc и id поля ссылки однозначно идентифицируют связанный элемент во внешнем документе. RMI передает оба этих значения команде навигации при навигации по ссылке из модели.

Свойства типа связи

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

Собственность	Описание
`Registration`	Имя функции, создающей тип связи. RMI сохраняет это имя в модели Simulink.
`Label`	Строка для идентификации этого типа связи. В редакторе исходящих ссылок эта строка отображается в выпадающем списке Тип документа для объекта Simulink или Stateflow.
`IsFile`	Логическое свойство, указывающее, являются ли связанные документы файлами в файловой системе компьютера. Если документ является файлом: Программное обеспечение использует стандартный метод для разрешения пути. При нажатии кнопки «Обзор» в редакторе исходящих связей открывается диалоговое окно выбора файла.
`Extensions`	Массив расширений файлов. Используйте эти расширения файлов в качестве параметров фильтра в редакторе исходящих ссылок при нажатии кнопки «Обзор». Расширения файлов определяют тип связи на основе имени документа. Если для одного и того же расширения файла зарегистрировано несколько типов ссылок, то зарегистрированный тип ссылок имеет приоритет.
`LocDelimiters`	Строка, содержащая список поддерживаемых разделителей навигации. Первый символ в идентификаторе требования указывает тип идентификатора. Например, идентификатор может относиться к определенному номеру страницы (`#4`), именованная закладка (`@my_tag`) или некоторый текст с возможностью поиска (`?search_text`). Допустимые разделители местоположения определяют возможные записи в выпадающем списке «Расположение редактора исходящих ссылок».
`NavigateFcn`	Обратный вызов MATLAB вызывается при щелчке по ссылке. Функция имеет два входных аргумента: поле документа и поле идентификатора ссылки: feval(LinkType.NavigateFcn, Link.document, Link.id)
`ContentsFcn`	Обратный вызов MATLAB вызывается при переходе на вкладку «Индекс документа» в редакторе исходящих ссылок. Эта функция имеет единственный входной аргумент, который содержит полный путь к разрешенной функции или, если тип ссылки не является файлом, содержимое поля Документ. Функция возвращает три выхода: Этикетки Глубины Местоположения
`BrowseFcn`	Обратный вызов MATLAB вызывается при нажатии кнопки «Обзор» в редакторе исходящих ссылок. Эта функция не требуется, если типом связи является файл. Функция не принимает входные аргументы и возвращает один выходной аргумент, идентифицирующий выбранный документ.
`CreateURLFcn`	Обратный вызов MATLAB, который создает путь к требованию. Эта функция использует путь к документу или URL-адрес для создания определенного URL-адреса требования. URL-адрес требования основан на идентификаторе местоположения, указанном в третьем входном аргументе. Входные аргументы: Полное имя пути к документу требований Сведения о создании URL-адреса документа (если применимо) Расположение требования в документе Эта функция возвращает один выходной аргумент, указанный как символьный вектор. Этот аргумент используется при переходе к требованию из созданного отчета.
`IsValidDocFcn`	Обратный вызов MATLAB вызывается при выполнении проверки согласованности требований. Функция принимает один входной аргумент - полное имя документа потребности. Возвращает значение true, если можно найти документ; возвращает значение false, если документ не найден или указано недопустимое имя документа.
`IsValidIdFcn`	Обратный вызов MATLAB вызывается при выполнении проверки согласованности требований. Эта функция принимает два входных аргумента: Полное наименование документа требований Расположение требования в документе `IsValidIdFcn` возвращает true, если оно находит требование, и false, если оно не может найти это требование в указанном документе.
`IsValidDescFcn`	Обратный вызов MATLAB вызывается при выполнении проверки согласованности требований. Эта функция имеет три входных аргумента: Полный путь к документу требований Расположение требования в документе Метка описания требования, сохраненная в Simulink `IsValidDescFcn` возвращает два выходных сигнала: True, если описание соответствует требованию, в противном случае false. Метка требования в документе, если она не соответствует в Simulink.
`DetailsFcn`	Обратный вызов MATLAB вызывается при создании отчета о требованиях с опцией Включить сведения из связанных документов. Эта функция возвращает подробное содержимое, связанное с требованием, и имеет три входных аргумента: Полный путь к документу требований Расположение требования в документе Уровень детализации для включения в отчет (неиспользуемый) `DetailsFcn` возвращает два выходных сигнала: Числовой массив, описывающий иерархическую связь между фрагментами в массиве ячеек Массив ячеек отформатированных фрагментов (абзацы, таблицы и др.) из требования
`SelectionLinkFcn`	Обратный вызов MATLAB вызывается при использовании опции меню связывания на основе выбора для этого типа документа. Эта функция имеет два входных аргумента: Дескриптор объекта модели, который будет иметь связь требования True, если объект навигации вставлен в документ требований, или false, если объект навигации не вставлен. `SelectionLinkFcn` возвращает структуру связи требований для выбранного требования.
`GetResultFcn`	Обратный вызов MATLAB вызывается при связывании внешних тестовых примеров с требованиями к файлу пользовательского типа связи. Он используется в файле пользовательского типа связи и извлекает внешние результаты для интеграции со статусами проверки. Эта функция имеет один входной аргумент: `link`: Это `slreq.Link` объект. Функция определяет источник и назначение канала. Функция возвращает один выходной аргумент, `result` который указан как `struct` со следующими полями: `status` (Обязательно): Это значение от `slreq.verification.Status` (`Pass`, `Fail`, `Stale`, или `Unknown`) `timestamp` (Необязательно) Пропустите это поле или отметку `NaT` во избежание обнаружения устаревших результатов. `info` (Необязательно) Это должен быть символ, вектор или строка. Значение `info` печатается в виде диагностической подсказки состояния. `error` (Необязательно) Это должен быть символ, вектор или строка. Значение `error` печатается в виде диагностической подсказки состояния. Если он предоставляется, он имеет приоритет над `info` поле.

Редактор исходящих ссылок

Управление связями отслеживания требований с помощью редактора исходящих связей

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

в редакторе Simulink щелкните правой кнопкой мыши объект модели, имеющий связь отслеживания требований. В контекстном меню выберите "Требования" > "Открыть диалоговое окно" Исходящие связи ".
в редакторе MATLAB щелкните правой кнопкой мыши внутри области кода, имеющей связь отслеживания требований. В контекстном меню выберите "Требования" > "Открыть диалоговое окно" Исходящие связи ".

Откроется редактор исходящих ссылок, как показано ниже.

В редакторе исходящих ссылок можно выполнить следующие действия.

Создайте связи требований из одного или нескольких объектов модели Simulink или строк кода MATLAB.
Настройка сведений о ссылках требований, включая указание тегов пользователей для фильтрации выделения требований и отчетов.
Удалить существующие ссылки требований.
Изменение сохраненного порядка требований для управления порядком меток в контекстных меню связанных объектов.

Вкладка «Требования»

На вкладке Требования указывается подробная информация о ссылке, в том числе:

Описание требования (до 255 слов). Если ссылка создается с помощью индекса документа, если описание не существует, имя расположения индекса становится описанием для ссылки.
Имя пути к документу требований.
Тип документа (Microsoft Word, Microsoft Excel ®, IBM Rational DOORS, ^MuPAD ®, HTML, текстовый файл и т.д.).
Расположение требования (текст поиска, именованное расположение, страница или номер элемента).
Пользовательский тег или ключевое слово.

Вкладка «Индекс документа»

Вкладка Индекс документа (Document Index) доступна только в том случае, если в поле Документ (Document) на вкладке Требования (Requirements) указан файл, поддерживающий индексирование. На закладке Индекс документа в RMI создается список местоположений в указанном документе потребности для следующих типов документов потребности:

Microsoft Word
IBM Rational DOORS
HTML-файлы
MuPAD

Примечание

RMI не может создавать индексы документов для PDF-файлов.

В индексе документа выберите требуемое требование из индекса документа и нажмите кнопку OK. Если описание не существует, имя расположения индекса становится описанием для ссылки.

Если в документ требований вносятся какие-либо изменения, для загрузки вновь созданных расположений в индекс документа необходимо нажать кнопку Обновить. Во время сеанса MATLAB RMI не перезагружает индекс документа, если не нажать кнопку «Обновить».

Документация