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

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

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

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

  • Описание длиной до 255 символов.

  • Имя пути к документу требований, например, Microsoft® Word файла или модуль в IBM® Рациональный® ДВЕРИ® база данных. (RMI поддерживает несколько встроенных форматов документов. Можно также зарегистрировать пользовательские типы документов требований. См. раздел Поддерживаемые типы документа требований.)

  • Указанное место внутри документа потребности, например:

    • Закладка

    • Якорь

    • Я бы

    • Номер страницы

    • Номер линии

    • Область значений камер

    • Ссылка на цель

    • Теги, которые вы задаете

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

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

  • Диаграммы Simulink и подсистемы

  • Блоки Simulink и аннотации

  • Функции Simulink записей в словаре данных

  • Группы сигналов Signal Builder

  • Stateflow® графики, субдиаграммы, состояния, переходы и коробки

  • Функции Stateflow

  • Линии кода MATLAB

  • Диспетчер Test™ Simulink тестов

Ссылки и типы каналов

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

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

Свойства типа ссылки

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

СвойствоОписание
Registration

Имя функции, которая создает тип ссылки. RMI хранит это имя в модели Simulink.

Label

Строка для идентификации этого типа ссылки. В редакторе исходящих ссылок эта строка появляется в раскрывающемся списке Document type для объекта Simulink или Stateflow.

IsFile

Свойство Boolean, которое указывает, являются ли связанные документы файлами в компьютерной файловой системе. Если документ является файлом:

  • Программа использует стандартный метод для разрешения пути.

  • В редакторе исходящих ссылок при нажатии кнопки Browse откроется диалоговое окно выбора файла.

Extensions

Массив расширений файлов. Используйте эти расширения файлов в качестве опций фильтра в редакторе исходящих ссылок при нажатии кнопки Browse. Расширения файлов выводят тип ссылки на основе имени документа. Если вы зарегистрировали несколько типов ссылок для одного и того же расширения файла, то тип ссылок, который вы зарегистрировали, приобретает первый приоритет.

LocDelimiters

Строка , содержащая список поддерживаемых разделителей навигации. Первый символ в идентификаторе требования задает тип идентификатора. Например, идентификатор может ссылаться на определенный номер страницы (#4), именованная закладка (@my_tag), или какой-то текст с возможностью поиска (?search_text). Допустимые разделители местоположения определяют возможные значения в выпадающем списке «Редактор исходящих ссылок Location».

NavigateFcn

Коллбэк MATLAB вызывается при клике по ссылке. Функция имеет два входных параметров: поле документа и поле идентификатора ссылки:

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, если находит требование, и false, если не может найти это требование в указанном документе.

IsValidDescFcn

Коллбэк MATLAB вызывается при запуске проверки согласованности требований. Эта функция имеет три входных параметров:

  • Полный путь к документу требований

  • Расположение требования в документе

  • Метка описания требования, сохраненная в Simulink

IsValidDescFcn возвращает два выхода:

  • True, если описание соответствует требованию, false в противном случае.

  • Метка требования в документе, если она не совпадает в Simulink.

DetailsFcn

Коллбэк MATLAB вызывается при создании отчета о требованиях с опцией Include details from linked documents. Эта функция возвращает подробное содержимое, сопоставленное с требованием, и имеет три входных параметров:

  • Полный путь к документу требований

  • Расположение требования в документе

  • Уровень детализации для включения в отчет (неиспользованный)

The DetailsFcn возвращает два выхода:

  • Числовой массив, который описывает иерархическую связь между фрагментами в массиве ячеек

  • Массив ячеек форматированных фрагментов (абзацы, таблицы и др.) от требования

SelectionLinkFcn

Коллбэк MATLAB вызывается при использовании основанного на выборе опции меню связывания для этого типа документа. Эта функция имеет два входных параметров:

  • Указатель на объект модели, который будет иметь ссылку требования

  • True, если объект навигации вставлен в документ требований, или false, если объект навигации не вставлен

SelectionLinkFcn возвращает структуру связи требований для выбранного требования.

GetResultFcn

Коллбэк MATLAB вызывается при соединении внешних тестов с требованиями к пользовательскому файлу типа ссылки. Он используется в файле пользовательского типа ссылок и извлекает внешние результаты для интеграции со статусами верификации.

Эта функция имеет один входной параметр:

  • link: Это a slreq.Link объект. Функция определяет источник и место назначения ссылки.

Функция возвращает один выходной аргумент, result который задается как struct со следующими полями:

  • status (Обязательно): Это значение от slreq.verification.Status (Pass, Fail, Stale, или Unknown)

  • timestamp (Необязательно): Пропустите это поле или отметьте NaT чтобы избежать устаревшего обнаружения результатов.

  • info (Необязательно): Это должен быть символ, вектор или строка. Значение info печатается как диагностика на подсказке состояния.

  • error (Необязательно): Это должен быть символ, вектор или строка. Значение error печатается как диагностика на подсказке состояния. Если он предусмотрен, он имеет приоритет над info поле.

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

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

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

  • в редакторе Simulink щелкните правой кнопкой мыши объект модели, который имеет трассируемость требований ссылку. В контекстном меню выберите Requirements > Open Outgoing Links dialog.

  • в редакторе MATLAB щелкните правой кнопкой мыши в области кода, которая имеет трассируемость требований ссылку. В контекстном меню выберите Requirements > Open Outgoing Links dialog.

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

В редакторе исходящих ссылок можно:

  • Создайте ссылки требований из одного или нескольких объектов модели Simulink или линий кода MATLAB.

  • Настройка информации о ссылках требований, включая указание тегов пользователей для фильтрации подсветки требований и создания отчетов.

  • Удалите существующие ссылки требований.

  • Измените сохраненный порядок требований, чтобы контролировать порядок меток в контекстных меню для связанных объектов.

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

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

  • Описание требования (до 255 слов). Если вы создаете ссылку с помощью индекса документа, если описание не существует, то имя расположения индекса становится описанием для ссылки.

  • Имя пути к документу требований.

  • Тип документа (Microsoft Word, Microsoft Excel®, IBM RATIONAL DOORS, MuPAD®HTML, текстовый файл и т.д.).

  • Расположение требования (текст поиска, именованное местоположение, страница или номер элемента).

  • Заданный пользователем тег или ключевое слово.

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

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

  • Microsoft Word

  • IBM Rational DOORS

  • HTML файлов

  • MuPAD

Примечание

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

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

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