Ссылки требования и типы ссылки

Ссылки трассируемости требований

Когда это необходимо, чтобы перейти из модели Simulink^® или из области кода MATLAB^® к местоположению в документе требований, можно добавить ссылки трассируемости требований к модели или коду.

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

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

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

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

Диаграммы Simulink и подсистемы
Блоки Simulink и аннотации
Записи в словаре данных Simulink
Группы сигнала Signal Builder
Графики Stateflow^®, подграфики, состояния, переходы и поля
Функции Stateflow
Строки кода MATLAB
Менеджер по Simulink Test™ тесты

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

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

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

Соедините свойства типа

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

Свойство	Описание
`Registration`	Имя функции, которое создает тип ссылки. RMI хранит это имя в модели Simulink.
`Label`	Строка, чтобы идентифицировать этот тип ссылки. В Исходящем Редакторе Ссылок эта строка появляется на Document type выпадающий список для объекта Simulink или Stateflow.
`IsFile`	Булево свойство, которое указывает, являются ли соединенные документы файлами в компьютерной файловой системе. Если документ является файлом: Программное обеспечение использует стандартный метод для решения пути. В Исходящем Редакторе Ссылок, когда вы нажимаете Browse, открывается диалоговое окно выбора файла.
`Extensions`	Массив расширений файла. Используйте эти расширения файла в качестве опций фильтра в Исходящем Редакторе Ссылок, когда вы нажмете Browse. Расширения файла выводят тип ссылки на основе названия документа. Если вы указали больше чем один тип ссылки для того же расширения файла, тип ссылки, который вы указали, берет первоочередную задачу.
`LocDelimiters`	Строка, содержащая список поддерживаемых разделителей навигации. Первый символ в ID требования задает тип идентификатора. Например, идентификатор может относиться к определенному номеру страницы (`#4`), именованная закладка (`@my_tag`) или некоторый распознаваемый текст (`?search_text`). Допустимые разделители местоположения определяют возможные записи в Исходящем Редакторе Ссылок Location выпадающий список.
`NavigateFcn`	Коллбэк MATLAB вызвал, когда вы щелкаете по ссылке. Функция имеет два входных параметра: поле документа и поле ID ссылки: feval(LinkType.NavigateFcn, Link.document, Link.id)
`ContentsFcn`	Коллбэк MATLAB вызвал, когда вы кликаете по вкладке Document Index в Исходящем Редакторе Ссылок. Эта функция имеет один входной параметр, который содержит полный путь разрешенной функции или, если тип ссылки не является файлом, содержимым поля Document. Функция возвращает три выходных параметра: Метки Глубины Местоположения
`BrowseFcn`	Коллбэк MATLAB вызвал, когда вы нажимаете Browse в Исходящем Редакторе Ссылок. Вам не нужна эта функция, когда тип ссылки является файлом. Функция не берет входных параметров и возвращает один выходной аргумент, который идентифицирует выбранный документ.
`CreateURLFcn`	Коллбэк MATLAB, который создает путь к требованию. Эта функция использует путь к документу или URL, чтобы создать конкретное требование URL. Требование URL основано на идентификаторе местоположения, заданном в третьем входном параметре. Входные параметры: Имя полного пути к документу требований Информация о создании URL к документу (если применимо) Местоположение требования в документе Эта функция возвращает один выходной аргумент, заданный как вектор символов. Используйте этот аргумент при навигации к требованию из сгенерированного отчета.
`IsValidDocFcn`	Коллбэк MATLAB вызвал, когда вы запускаете проверку на непротиворечивость требований. Функция берет один входной параметр — полностью определенное имя для документа требований. Это возвращает true, если документ может быть расположен; это возвращает false, если документ не может быть найден, или название документа недопустимо.
`IsValidIdFcn`	Коллбэк MATLAB вызвал, когда вы запускаете проверку на непротиворечивость требований. Эта функция берет два входных параметра: Полностью определенное имя для документа требований Местоположение требования в документе `IsValidIdFcn` возвращает true, если это находит требование и ложь, если это не может найти что требование в заданном документе.
`IsValidDescFcn`	Коллбэк MATLAB вызвал, когда вы запускаете проверку на непротиворечивость требований. Эта функция имеет три входных параметра: Полный путь к документу требований Местоположение требования в документе Описание требования маркирует, как сохранено в Simulink `IsValidDescFcn` возвращает два выходных параметра: Верный, если описание совпадает с требованием, ложь в противном случае. Метка требования в документе, если не соответствующий в Simulink.
`DetailsFcn`	Коллбэк MATLAB вызвал, когда вы генерируете отчет требований с опцией Include details from linked documents. Эта функция возвращает подробное содержимое, сопоставленное с требованием, и имеет три входных параметра: Полный путь к документу требований Местоположение требования в документе Уровень деталей, чтобы включать в (Неиспользованный) отчет `DetailsFcn` возвращает два выходных параметра: Числовой массив, который описывает иерархическое отношение среди фрагментов в массиве ячеек Массив ячеек отформатированных фрагментов (абзацы, таблицы, и др.) от требования
`SelectionLinkFcn`	Коллбэк MATLAB вызвал, когда вы используете основанный на выборе пункт меню соединения для этого типа документа. Эта функция имеет два входных параметра: Обработайте к объекту модели, который будет иметь ссылку требования Верный, если объект навигации вставляется в документ требований или ложь, если никакой объект навигации не вставляется `SelectionLinkFcn` возвращается, требования соединяют структуру для выбранного требования.

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

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

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

в Редакторе Simulink щелкните правой кнопкой по объекту модели, который имеет ссылку трассируемости требований. Из контекстного меню выберите Requirements> Open Outgoing Links dialog.
в редакторе MATLAB щелкните правой кнопкой в области кода, который имеет ссылку трассируемости требований. Из контекстного меню выберите Requirements> Open Outgoing Links dialog.

Исходящий Редактор Ссылок открывается, как показано ниже.

В Исходящем Редакторе Ссылок вы можете:

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

Вкладка требований

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

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

Индексная вкладка документа

Вкладка Document Index доступна, только если вы задали файл в поле Document на вкладке Requirements, которая поддерживает индексацию. На вкладке Document Index RMI генерирует список местоположений в заданном документе требований для следующих типов документов требований:

Microsoft Word
IBMRationalDOORS
Файлы HTML
MuPAD

Примечание

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

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

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

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