Holarch

SysML v2

Начало работы с проектами SysML v2

Выбор между проектом LML и проектом SysML v2, создание проекта SysML v2 или демо-проекта, написание первой модели и ориентирование в интерфейсе.

Как использовать →

На этой странице
  1. Обзор
  2. Понятия
    1. Два типа проектов
    2. Модель и текст — одно целое
    3. Данные модели и данные Holarch
    4. Определения и использования
  3. Как использовать
    1. Выбрать тип проекта
    2. Создать проект SysML v2
    3. Открыть демо-проект Hybrid Car
    4. Открыть демо-проект Hybrid Car Battery Pack
    5. Открыть демо-проект Earth Observation Satellite
    6. Написать первую модель
    7. Ориентирование
  4. Разобранный пример: изучение Hybrid Car
  5. Советы и типичные ошибки
  6. Панель навигации в проектах SysML v2
  7. Упрощённый режим
    1. Включение и выключение
    2. Что показывает
    3. Показать все
  8. Главная
  9. Спросить ИИ
  10. Пока недоступно
  11. Сообщения
  12. Ограничения
  13. Связанные страницы

Обзор

Holarch поддерживает проекты SysML v2. Проект SysML v2 содержит одну модель, написанную в текстовой нотации SysML v2 и основанную на спецификации OMG SysML v2.

Модель пишется текстом в Редакторе. Holarch хранит ту же модель в виде элементов: пакетов, определений, использований и связей. Браузер, представления и страницы жизненного цикла (требования, верификация, интерфейсы, риски, планирование) показывают те же самые элементы.

На этой странице описаны два типа проектов, как начать проект SysML v2 и где что находится. Сам язык описан в разделе Текстовая нотация SysML v2. Редактор и Браузер описаны в разделе Текстовый редактор и браузер модели.

Понятия

Два типа проектов

Каждый проект Holarch — либо проект LML, либо проект SysML v2. Тип выбирается при создании проекта. Он остаётся неизменным: проект меняет тип только через преобразованную копию (см. Преобразование между LML и SysML v2).

LMLSysML v2
Для чего предназначенМоделирование системы на Lifecycle Modeling Language: требования, функции, физическая архитектура, интерфейсы, тесты, риски и график. Holarch проверяет вашу работу на каждом шаге.Построение модели на языке SysML v2 в виде текста со стандартными понятиями SysML v2: пакеты, определения и использования, порты, соединения, действия, состояния и требования.
Как строится модельБаза данных, формы и более 30 типов диаграмм.Текст в Редакторе, а также представления и страницы жизненного цикла, которые записывают изменения в тот же текст.
Чем можно обмениватьсяИмпорт из Word, Excel, CSV, ReqIF и XMI; экспорт в Word, Excel и диаграмм; файлы проектов.Текст SysML v2 (.sysml) и SysML v2 JSON (см. Обмен моделями SysML v2); импорт SysML v1 из XMI и файлов Cameo или MagicDraw .mdzip (см. Импорт моделей SysML v1); файлы проектов.

Если сомневаетесь, выберите LML. В нём есть все страницы и диаграммы Holarch, и он подходит тем, кто только начинает работать с MBSE. Выбирайте SysML v2, если ваша команда уже моделирует на SysML v2 или обменивается моделями с инструментами SysML v2.

Модель и текст — одно целое

Внутри проекта SysML v2 нет файлов. Модель — это набор элементов, а Редактор показывает по одному текстовому документу на каждый пакет верхнего уровня. Когда текст успешно разбирается, Holarch применяет его к модели. Когда вы меняете модель в другом месте (в представлении, таблице, инспекторе), текст меняется вместе с ней. См. Синхронизация текста и представлений.

Данные модели и данные Holarch

Часть информации входит в текст SysML; часть хранится Holarch рядом с моделью.

  • В тексте: имена элементов, краткие имена (номера требований), документация, типы, кратности, значения и связи, такие как satisfy, verify, perform и connect.
  • Рядом с моделью (данные Holarch): статус и утверждения требований, результаты верификации, метки, исполнители, сроки, комментарии обсуждений, раскладки представлений, настройки симулятора, бюджеты, риски, решения и задачи. Они связаны с элементами модели по идентичности, поэтому связи сохраняются при переименованиях и перемещениях.

Данные Holarch не записываются в текст SysML и не входят в экспорт .sysml.

Определения и использования

Большинство ключевых слов SysML v2 существуют в двух формах. Определение (part def Wheel;) описывает вид объекта. Использование (part frontWheel : Wheel;) — это одно применение определения внутри другого элемента. Та же схема действует для port def/port, action def/action и requirement def/requirement. Подробно это объясняется в разделе Текстовая нотация SysML v2.

Как использовать

Выбрать тип проекта

Определитесь с типом до создания проекта.

  1. Выберите LML, чтобы использовать полный метод Holarch: Базу данных, диаграммы LML и пошаговые проверки на каждом этапе.
  2. Выберите SysML v2, если модель должна быть текстом SysML v2, например для обмена с другим инструментом SysML v2.
  3. Чтобы сначала попробовать SysML v2, откройте демо-проект Hybrid Car (через одну процедуру ниже) вместо пустого проекта.

Создать проект SysML v2

  1. Откройте Управление проектами и нажмите + Новый проект.
  2. В разделе How will you model this system? выберите SysML v2.
  3. Введите имя и нажмите Создать проект.

Проект открывается на Главной. Фишка SysML v2 отображается рядом с именем проекта на верхней панели и на странице «Управление проектами». Новая модель пуста: Следующие действия на Главной предлагает Write the first package in the Editor.

Открыть демо-проект Hybrid Car

Демо-проект Hybrid Car — готовая модель SysML v2 для изучения и редактирования.

  1. Откройте Управление проектами.
  2. Нажмите Файлы проектов ▾ → Новый демо-проект → Hybrid Car (SysML v2).

Holarch создаёт проект Hybrid Car (SysML v2 demo) и открывает его на Главной. Нажмите Редактор на панели навигации, чтобы прочитать текст. В модели шесть пакетов верхнего уровня: Vehicles, VehicleRequirements, VehicleBehavior, VehicleViews, HolarchFrameworks и HybridCarArchitecture. Каждый из них — документ в списке Пакеты Редактора.

Демо-проект — ваша собственная копия. Меняйте её как угодно или создайте заново, чтобы начать с чистого листа.

Чтобы открыть демо-проект по ссылке, используйте https://app.holarch.app/#/?demo=hybrid. Ссылка создаёт демо-проект и открывает его; в размещённом приложении он открывается после входа.

Открыть демо-проект Hybrid Car Battery Pack

Демо-проект Hybrid Car Battery Pack — тяговая аккумуляторная батарея автомобиля в том виде, в каком её моделирует поставщик, в отдельном проекте. Если среди ваших проектов есть и демо-проект Hybrid Car, созданный до или после него, три требования к батарее связаны с требованиями автомобиля к аккумулятору (BP-1 с VR-3, BP-2 с VR-6, BP-3 с VR-5), поэтому Управление проектами → Карта программы показывает, как связаны два проекта. Эти демо-связи работают на всех тарифах.

  1. Откройте Управление проектами.
  2. Нажмите Файлы проектов ▾ → Новый демо-проект → Hybrid Car Battery Pack (SysML v2).

Что можно попробовать:

  • Вычисляемые значения: в Редакторе Pack::mass складывает модули (по 12 элементов и корпусу в каждом), систему управления батареей, распределительную коробку, охлаждение и корпус батареи: 43 кг при пределе 48 кг, поэтому massMargin равен 5 кг. Pack::capacity складывает 120 элементов: 1,44 кВт·ч против 1,4 кВт·ч. Выберите атрибут, чтобы увидеть его значение в инспекторе.
  • Параметрическое представление: откройте packParametrics. Проверки ёмкости, массы, времени зарядки и балансировки элементов привязаны к значениям батареи и проходят.
  • RVTM: ёмкость и масса — Passed, приём заряда — Failed (испытание горячей зарядки длилось 34 минуты при пределе 30), а балансировка элементов ещё не выполнялась. Каждый случай верификации вычисляет свой вердикт из модели.
  • Симулятор: Симулятор открывается на pack вместе с Hot Day Charge. Нажмите ⏩ Выполнить до конца, затем Состояния: зарядка снижается до половинной мощности при перегреве элементов и возобновляется после их остывания. Выберите Cell Over Voltage Fault в поле Выполнять вместе с, чтобы увидеть защитное отключение и сервисный сброс.

Открыть демо-проект Earth Observation Satellite

Демо-проект Earth Observation Satellite — более крупная модель: миссия EO-2, спутник формата 12U для съёмки с наземным сегментом, около 3000 строк в 14 пакетах. Поверх модели заполнены собственные данные Holarch, поэтому каждой странице есть что показать.

  1. Откройте Управление проектами.
  2. Нажмите Файлы проектов ▾ → Новый демо-проект → Спутник наблюдения Земли (SysML v2).

Holarch создаёт проект Earth Observation Satellite (SysML v2 demo) и открывает Главную. В демо-проекте 1549 элементов, больше, чем 1000 элементов на проект тарифа Free: на тарифе Free пункт меню отключён и гласит Needs the Individual plan (1,549 items). Ссылка https://app.holarch.app/#/?demo=eosat тоже создаёт его. Что можно попробовать:

  • Документы: откройте EO-2 System Requirements Specification. Её разделы содержат требования EORequirements, живые значения и матрицу верификации.
  • Бюджеты: масса камеры превышает выделенные ей 4,0 кг; TPM Imager Mass показывает тенденцию.
  • Ссылки для проверки и TBD/TBR: изменённые требования и открытые значения, которые нужно разрешить.
  • Симулятор: запустите сеанс съёмки из представления imagingPassFlow.
  • Базовые линии: сравните базовую линию PDR Data Freeze с текущей моделью.
  • Представления: режимы космического аппарата, представления соединений и последовательность постановки задач.

Написать первую модель

Эта процедура строит небольшую модель дрона с таким текстом:

package Drone {
    private import ISQ::*;
    private import SI::*;

    part def Battery {
        attribute mass : MassValue = 0.4 [kg];
    }
    part def Quadcopter {
        part battery : Battery;
    }
}
  1. Откройте Модель → Редактор, нажмите + Новый пакет, введите Drone и подтвердите. Редактор откроет текст нового пакета.
  2. Введите импорты и члены внутри фигурных скобок пакета, как показано выше.
  3. Прекратите ввод. После короткой паузы строка состояния под текстом показывает Применено. Теперь модель содержит пакет, оба определения частей, атрибут и часть, и одно нажатие “Отменить” возвращает всё назад.
  4. Откройте Модель → Браузер и разверните Drone, чтобы увидеть те же элементы в виде дерева.

Если в строке есть ошибка, строка состояния показывает Not applied: fix line N. Модель сохраняет последнее корректное состояние, пока текст снова не будет успешно разобран. См. Ошибки и черновики.

Ориентирование

Проекты SysML v2 сохраняют панель жизненного цикла Holarch. Каждая группа работает с моделью SysML v2.

  1. Начните с Главной, чтобы увидеть, что требует внимания, группы жизненного цикла и следующие действия.
  2. Используйте Модель → Редактор, чтобы писать текст, и Модель → Браузер, чтобы видеть дерево.
  3. Используйте Потребности и требования и Верификация для требований, случаев верификации и прослеживаемости.
  4. Используйте Поведение, Архитектура и Интерфейсы для представлений и страниц анализа.
  5. Откройте инструмент Диаграммы внизу панели навигации, чтобы увидеть все представления.
  6. Нажмите ⌘K / Ctrl+K, чтобы найти любой элемент по имени, краткому имени, полному имени (Vehicles::Car) или тексту документации.
  7. Впервые работаете с SysML v2? Включите упрощённый режим, чтобы сначала видеть наиболее используемые элементы.

Разобранный пример: изучение Hybrid Car

В этом обзоре используется демо-проект Hybrid Car.

  1. Создайте демо-проект (см. Открыть демо-проект Hybrid Car). Он откроется на Главной. Откройте Модель → Редактор и выберите Vehicles в списке Пакеты.
  2. Найдите part def Car. У него есть части body, powertrain, frontAxle, rearAxle и spare : Wheel [0..1].
  3. Щёлкните с ⌘ / Ctrl по Powertrain в part powertrain : Powertrain;. Курсор переходит к part def Powertrain с его частями tank, engine, motor, battery, transmission и controller и интерфейсами, такими как interface fuel : FuelLine connect tank.fuelOut to engine.fuelIn;.
  4. Наведите указатель на MassValue в attribute mass : MassValue;. Карточка покажет его вид и полное имя из стандартной библиотеки.
  5. Откройте Модель → Браузер. Введите sedan в поле Фильтровать по имени. Дерево покажет sedan под fleet в Vehicles. Выберите его: инспектор покажет Kind part, Typed by Car и полное имя Vehicles::fleet::sedan.
  6. Откройте Главную. Карточка Жизненный цикл группы Потребности и требования подсчитывает требования модели; Требует внимания показывает связи для проверки, просроченные TBD и высокие риски модели.
  7. Откройте Потребности и требования → Требования. Среди строк есть VR-1.1 sedanMass — использование требования, номер которого является его кратким именем <'VR-1.1'>.
  8. Откройте инструмент Диаграммы и откройте driveCycleFlow — представление потока действий DriveCycle. Переименуйте там действие и вернитесь в Редактор: VehicleBehavior показывает новое имя.

Советы и типичные ошибки

  • Начните с демо-проекта. Копирование шаблонов из текста Hybrid Car — самый быстрый способ освоить нотацию.
  • Импортируйте единицы измерения. Чтобы 5 [kg] работало, должен быть виден SI (а для MassValue — ISQ). Добавьте в пакет private import ISQ::*; и private import SI::*;.
  • Одна модель на проект. Разделяйте большую модель на несколько пакетов верхнего уровня; каждый из них — отдельный документ в Редакторе.
  • Выбран не тот тип. Тип нельзя переключить на месте. Создайте преобразованную копию на странице «Управление проектами» (⋯ → Создать копию LML… или Создать копию SysML v2…).
  • Ожидание статуса в тексте. Статус требований, результаты верификации и метки — это данные Holarch. Они не отображаются в тексте и в экспорте .sysml.

Панель навигации в проектах SysML v2

ГруппаСтраницы
Главная«Требует внимания», «Жизненный цикл», «Следующие действия» и другие панели Главной
Потребности и требованияДокументы, Требования, Качество, TBD/TBR, Ссылки для проверки, Утверждения, Матрица соответствия*
МодельРедактор, Браузер, импорт и экспорт
ПоведениеФункциональный анализ, потоки действий, FFBD, машины состояний, последовательности, симулятор
АрхитектураЧасти, представления General, представления Interconnection, иерархия, бюджеты и TPM
ИнтерфейсыРеестр интерфейсов, ICD, Диаграммы N², Элементы и входы/выходы
ВерификацияRVTM, варианты верификации, отклонения и отступления*, матрица прослеживаемости, покрытие программы, проверки модели
Безопасность и надёжность†Журнал опасностей, FMECA, деревья отказов, структурные схемы надёжности
Риски, проблемы и решенияРеестр рисков, Диаграммы Risk, Анализы компромиссов, Решения, Проблемы и задачи
ТарифМоя работа, Процесс SE, Управление проектом, Графики, Доски, Презентации
Управление и рецензированиеЗапросы на изменение, Базовые линии и версии, Библиотеки, Рецензирование, Активность
ФреймворкиDoDAF, UAF

* При включённой формальной программе. † При включённой программе «Безопасность и надёжность». Обе включаются в Параметры проекта → Функции программы.

Инструменты внизу панели навигации те же, что и в проектах LML: База данных, Диаграммы, Корзина, Настройки и Справка. В проектах SysML v2 в Настройках также есть Стандартная библиотека. Страницы, неприменимые к проектам SysML v2, не показываются.

Страницы описаны в разделах Представления SysML v2, Требования и верификация в проектах SysML v2, Вычисление, единицы и анализ в проектах SysML v2 и Функции Holarch в проектах SysML v2.

Упрощённый режим

Упрощённый режим предназначен для тех, кто только знакомится с SysML v2. Он показывает элементы, с которых начинается большинство моделей, объясняет каждый из них одним предложением и скрывает остальные, пока вы их не запросите. Он меняет только то, что вы видите: модель, её текст и все экспорты остаются прежними.

Включение и выключение

  • Параметры → SysML v2 → Упрощённый режим.
  • Простой режим в заголовке страницы Модель → Браузер (кнопка нажата, пока режим включён).
  • ⌘K / Ctrl+K → Включить простой режим или Выключить простой режим.

По умолчанию он выключен. Настройка относится к вашей учётной записи: она следует за вами на любой компьютер, на котором вы входите, и при входе применяется настройка учётной записи. Сбросить параметры её не меняет.

При первом открытии проекта SysML v2 под верхней панелью появляется подсказка Впервые работаете с SysML v2? Включите упрощённый режим, чтобы сначала видеть самые используемые элементы. Нажмите Включить, чтобы включить упрощённый режим, или ×, чтобы закрыть подсказку. Любой ответ сохраняется в вашей учётной записи, и подсказка больше не показывается. Пока вы на неё не ответили, она появляется при каждом открытии проекта SysML v2. Она не показывается, если упрощённый режим уже включён.

Что показывает

Двенадцать понятий, которые чаще всего используются в демо-проекте Hybrid Car и в руководствах: пакет, часть, атрибут, порт, соединение и интерфейс, действие, поток и последовательность (succession), состояние, переход, требование, удовлетворение (satisfy) и верификация.

ГдеВ упрощённом режимеСкрыто до «Показать все»
General View, панель добавленияПакет, определение части, часть, определение порта, порт, атрибут, определение интерфейса, определение действия, действие, определение требования, требование, вариант верификацииОпределение атрибута, определение предмета, определение перечисления
Диаграмма Spider, панель добавленияПакет, определение части, часть, определение порта, порт, атрибут, определение действия, действие, состояние, определение требования, требование, вариант верификацииОпределение предмета, предмет, определение атрибута, вариант использования
Interconnection View, панель добавленияЧасть, портПредмет
Представление переходов состояний, панель добавленияНачальное состояние, конечное состояние, состояние, действие entry, действие do, действие exitПараллельное состояние, область
Представление Action Flow, панель добавления и + Action ▾Действие, разветвление, слияние, решение, объединение, дорожкаAccept, Send, Loop, Terminate
Редактор, Вставить ▾Пакет, определение части, часть, атрибут, определение порта, порт, интерфейс, соединение, определение действия, действие, последовательность (succession), поток, определение состояния, состояние, начальное состояние, переход, определение требования, требование, удовлетворение (satisfy), определение верификации, верификация (verify)Все остальные фрагменты, подходящие к позиции курсора
Модель → БраузерПакеты, определения, использования, соединения, потоки, переходы, требования, satisfy и verifyИмпорты, псевдонимы, expose, комментарии, документация, метаданные, библиотечные пакеты, связывающие соединители, элементы уровня KerML, а также строки триггера и эффекта перехода

Наведите указатель на элемент в панели добавления или на вид строки в Браузере, чтобы прочитать объяснение этого элемента в одно предложение.

Представления требований, вариантов использования, параметрические представления, представления последовательности, пакетов и Geometry, а также панели иерархии, дерева, IDEF0 и FFBD сохраняют все свои элементы: каждое из них посвящено виду, который оно добавляет. + Новая диаграмма, таблицы, поиск, инспектор и ввод текста в Редакторе (с автодополнением) не фильтруются.

Показать все

  • Панели добавления: Показать все (ещё n) под элементами; Показать меньше снова их скрывает.
  • + Action ▾: пункт Показать все… в конце снова открывает меню со всеми видами.
  • Вставить ▾: установите флажок Показать все в его заголовке.
  • Браузер: установите флажок Показать все на панели фильтров.

«Показать все» действует, пока вы не перезагрузите страницу или не переключите упрощённый режим; упрощённый режим при этом остаётся включённым. В Браузере элемент, открытый из другого места (например, через Показать в браузере в инспекторе), показывается всегда вместе со своими владельцами, даже если его вид скрыт.

Главная

Главная — та же страница, что и в проектах LML (см. Главная): Требует внимания (ссылки для проверки, просроченные TBD, неуспешные тесты, нарушения TPM, высокие риски, проверки модели, состояние сохранения), карточка Жизненный цикл для каждой группы панели навигации и панели, такие как Следующие действия, Контрольная точка процесса SE и Вехи. Числа берутся из модели SysML v2 и данных Holarch рядом с ней. ✦ Написать сводку проекта в проектах SysML v2 не предлагается.

  • Группы панели навигации показывают те же значки проблем, а обзорная страница каждой группы перечисляет то, что требует внимания, и её показатели.
  • + Добавить панель → Содержимое модели показывает Пакеты (с числом пакетов верхнего уровня), Определения, Использования, Связи и Требования (n не удовлетворено · n не верифицировано), элементы не на своём месте, если элементы потеряли владельца, и Последние изменения: последние изменения модели (создание, изменение, перемещение, удаление или восстановление) с видом элемента и временем.

Спросить ИИ

«Спросить ИИ» отвечает на вопросы о языке SysML v2 и о работе с Holarch на основе Справки и Docs. На тарифах Individual и Team, а также с вашим собственным ключом ИИ или ключом вашей организации он также отвечает на вопросы об открытой модели и предлагает изменения, которые открываются для проверки перед применением. См. Спросить ИИ.

Пока недоступно

  • Коммиты в main, теги и слияния через Systems Modeling API: другие инструменты делают коммиты в ветки запросов на изменение, которые утверждающий применяет в Holarch (см. API и MCP в проектах SysML v2).
  • Редактирование языка: стандартная библиотека доступна только для чтения.

В разделе Текстовая нотация SysML v2 подробно перечислено, что поддерживается из языка.

Сообщения

СообщениеЗначение
Модель пустаВ проекте нет элементов. Нажмите + Новый пакет, затем напишите его члены в Редакторе.
Не применено: исправьте строку N.В тексте ошибка в строке N. Модель сохраняет последнее корректное состояние, пока текст не будет успешно разобран.
Только просмотр: попросите владельца предоставить доступ на редактирование.У вас есть доступ на просмотр проекта. Текст и страницы доступны только для чтения.
Этому проекту нужна более новая версия Holarch.Проект сохранён более новой версией Holarch, а эта страница старее. Проект открывается только для просмотра, а баннер вверху объясняет причину. Нажмите Перезагрузить на баннере, чтобы получить новую версию.

Ограничения

  • Тип проекта задаётся при создании и не меняется.
  • Одна модель на проект.
  • Текстовый документ размером больше 8 МБ не проверяется; разделите его на несколько пакетов.

SysML® и OMG® — зарегистрированные товарные знаки Object Management Group, Inc. в США и других странах.