Holarch

SysML v2

Руководства SysML v2

Девять пошаговых руководств для проектов SysML v2, от первого пакета до портов, действий, состояний, требований, верификации, ограничений и вариантов, с панелью шагов, которая проверяет вашу работу.

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

На этой странице
  1. Как использовать
    1. Начать руководство SysML v2
    2. Ввести текст шага
    3. Советы
  2. Начало работы
  3. Определения и атрибуты
  4. Порты и интерфейсы
  5. Действия и потоки
  6. Состояния и переходы
  7. Требования
  8. Верификация и прослеживаемость
  9. Ограничения и вычисления
  10. Варианты и конфигурации
  11. Учебные проекты
  12. Связанные материалы

В Holarch есть серия пошаговых руководств для проектов SysML v2. Каждое из них создаёт небольшой начальный проект SysML v2 и открывает панель шагов рядом со страницей. Панель проверяет модель по ходу работы: шаг становится зелёным, когда в модели есть то, что он требует. На этой странице каждый шаг приведён в виде текста, так что выполнять их можно и здесь.

Первое руководство, как и руководства LML, использует метеостанцию WS-1. Остальные строят части гибридного автомобиля — модели демо-проекта Hybrid Car: типы значений и компоненты, порты и интерфейсы силовой установки, ездовой цикл, состояния силовой установки, требования к автомобилю, их верификацию, проверки значений седана и линейку продуктов. У каждого руководства свой начальный проект, поэтому проходить их можно в любом порядке. Каждый начальный проект и каждое завершённое руководство проверяются с 0 проблем.

РуководствоВремяВы научитесь
Начало работы15 минписать текст SysML v2, видеть его в виде дерева и представления, рисовать в представлении и добавлять требование
Определения и атрибуты20 минписать перечисления, типы значений и абстрактные определения, специализировать со значениями и единицами, использовать автодополнение, вставку и переименование
Порты и интерфейсы20 минопределять порты и интерфейсы, сопрягать порты, соединять части и рисовать интерфейс в Interconnection View
Действия и потоки20 минписать определения действий и ездовой цикл с разветвлением, потоками и слиянием, добавлять дорожки и строить шаги в FFBD
Состояния и переходы20 минписать сигналы и машину состояний с триггерами, условиями и действиями состояний, рисовать переход по времени
Требования20 минписать пределы, определения и использования требований, удовлетворять их и видеть невыполненное требование
Верификация и прослеживаемость15 минписать вариант верификации, трассировать шаг в матрице прослеживаемости и выводить требование
Ограничения и вычисления20 минписать ограничения и вычисления, связывать значения в параметрическом представлении, выполнять вариант анализа и отмечать значения TBD и TBR
Варианты и конфигурации15 минписать вариации и варианты, линейку продуктов с правилом, конфигурации и собственное ключевое слово

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

Начать руководство SysML v2

  1. Откройте Справка → Руководства на панели навигации или нажмите ⌘K / Ctrl+K и введите tutorial. Вне проекта страница Руководства сначала перечисляет руководства LML, затем Руководства для проектов SysML v2. Внутри проекта SysML v2 она перечисляет только руководства SysML v2.
  2. Нажмите Начать на карточке. Holarch создаст проект, например Tutorial: SysML v2 Ports and Interfaces (Hybrid Car), и откроет его с панелью шагов справа.

Панель шагов работает так же, как в руководствах LML: Показать обводит элемент управления, нужный для шага, Перейти открывает страницу, Подробнее открывает раздел справки, а Начать заново…, Отметить как выполненный и × работают так же. См. Руководства.

Ввести текст шага

В большинстве шагов дан текст SysML, который нужно ввести в Модель → Редактор. Шаг указывает, куда вставить строки, например «перед последней закрывающей фигурной скобкой пакета». Текст применяется к модели, когда вы делаете паузу при вводе; об этом сообщает строка состояния под редактором, и шаг становится зелёным.

  • Вводите строки так, как показано. Отступы для модели не важны; Редактор сохраняет ваши.
  • Красное подчёркивание обозначает ошибку: наведите на него указатель, чтобы прочитать сообщение. Текст с синтаксической ошибкой остаётся черновиком и не применяется, пока вы её не исправите.
  • ⌘Z / Ctrl+Z отменяет последнее применённое изменение.

Советы

  • В первый раз проходите руководства по порядку: каждое объясняет используемый в нём текст, а последующие опираются на идеи предыдущих (определения и использования, :> и :>>).
  • Если шаг остаётся незавершённым, обычно в имени есть опечатка. Сравните свой текст со строками шага; в SysML v2 имена чувствительны к регистру.
  • Руководства учат тому же языку, что и Основы SysML v2; подробности — на странице Текстовая нотация.

Начало работы

Напишите первую модель метеостанции: откройте текст, добавьте определение части со значением и единицей, используйте его в другом определении, посмотрите модель в Браузере и в General View, нарисуйте часть в представлении и посмотрите, как она появится в тексте, добавьте требование с satisfy и экспортируйте модель в файл .sysml. Шаги описаны в разделе Начало работы с проектами SysML v2.

Определения и атрибуты

В начальном проекте есть пакет Vehicles с одним определением части — Car.

  1. Откройте пакет. Нажмите Модель → Редактор. Каждое объявление — это ключевое слово и имя, затем тело в фигурных скобках или точка с запятой.
  2. Напишите перечисление. Над part def Car { добавьте enum def DriveMode { enum economy; enum normal; enum sport; } (по одному значению в строке).
  3. Определите тип значения. Под ним добавьте attribute def TirePressure :> ScalarValue;. :> означает «специализирует».
  4. Напишите абстрактное определение. Добавьте abstract part def Component с комментарием doc и атрибутами mass : MassValue, partNumber : String и power : PowerValue. // начинает заметку, которая остаётся только в тексте.
  5. Пусть средство проверки найдёт ошибку. Добавьте part def Battery :> Component с attribute redefines mass = 45 [kg]; и намеренно attribute redefines power = 60 [kg];. Средство проверки подчеркнёт единицу: килограммы — это не мощность.
  6. Исправьте единицу. Замените её на 60 [W].
  7. Дополните имя. В батарее введите attribute capacity : Ener, примите EnergyValue из списка автодополнения клавишей Enter и завершите строку символом ;.
  8. Найдите его в Стандартной библиотеке. Нажмите Настройки → Стандартная библиотека внизу панели навигации и введите EnergyValue в поле поиска.
  9. Вставьте определение. В Редакторе на пустой строке нажмите ⌃⇧Space / Ctrl+Shift+Space (или нажмите Вставить ▾), выберите Определение части и допишите part def Engine :> Component с attribute redefines mass = 110 [kg]; и attribute cylinders : Integer;.
  10. Используйте определения. В Car добавьте attribute mode : DriveMode;, part battery : Battery; и part engine : Engine;.
  11. Переименуйте везде. Поставьте курсор на cylinders, нажмите F2 и переименуйте его в cylinderCount.

Порты и интерфейсы

В начальном проекте есть компоненты силовой установки с портами крутящего момента и мощности, определения портов TorquePort и PowerPort и определения интерфейсов Shaft и HighVoltageBus.

  1. Определите порт. Над port def TorquePort добавьте port def FuelPort с out attribute flowRate : Real; и attribute kind : FuelKind;. out означает, что значение выходит из части, владеющей портом.
  2. Дайте частям порты. Добавьте port fuelOut : FuelPort; в FuelTank и port fuelIn : ~FuelPort; в Engine. ~ сопрягает порт: вход и выход меняются местами.
  3. Определите интерфейс. Добавьте interface def FuelLine { end supply : FuelPort; end consumer : ~FuelPort; }.
  4. Постройте силовую установку. В конце пакета добавьте part def Powertrain с частями tank, engine, motor, battery и transmission, портом output : TorquePort и bind output = transmission.output;.
  5. Соедините две части. В силовой установке добавьте interface fuel : FuelLine connect tank.fuelOut to engine.fuelIn;.
  6. Добавьте валы. Добавьте interface engineShaft : Shaft connect engine.output to transmission.engineIn; и interface motorShaft : Shaft connect motor.output to transmission.motorIn;.
  7. Создайте Interconnection View. Нажмите Архитектура → Представления Interconnection, затем + Новая диаграмма. Выберите Powertrain в поле Показывает и нажмите Создать.
  8. Нарисуйте интерфейс. Перетащите от маркера порта батареи powerOut к порту электромотора powerIn и отпустите на Interface : HighVoltageBus.
  9. Назовите интерфейс. Выделите новую линию и введите hvBus в поле Имя в инспекторе.
  10. Посмотрите на текст. Нажмите Модель → Редактор: интерфейс находится в силовой установке, со своим именем, типом и концами.

Действия и потоки

В начальном проекте есть пакет VehicleBehavior с предметами Fuel и Torque, функциями ProduceTorque (F.2) и DriveWheels (F.3) и тремя определениями частей.

  1. Определите функцию. Добавьте action def <'F.1'> SupplyFuel с in attribute fuelDemand : Real; и out item fuel : Fuel;. Краткое имя в угловых скобках — это номер функции.
  2. Напишите ездовой цикл. Добавьте action def <'F'> DriveCycle с first start then split;, fork split;, then supply;, then produce; и шагами action supply : SupplyFuel и action produce : ProduceTorque, каждый с duration.
  3. Добавьте поток. В ездовом цикле добавьте flow of Fuel from supply.fuel to produce.fuel;.
  4. Объедините ветви. Добавьте first supply then ready;, first produce then ready;, join ready;, then action drive : DriveWheels { … }, then done; и flow produce.torque to drive.torque;.
  5. Создайте представление Action Flow. Нажмите Поведение → Потоки действий, затем + Новая диаграмма и выберите DriveCycle в поле Показывает.
  6. Укажите, кто выполняет каждый шаг. Добавьте part def DrivenCar с perform action trip : DriveCycle; и частями tank, engine и transmission, каждая с perform trip.supply;, perform trip.produce; или perform trip.drive;. Представление получит дорожку для каждой части.
  7. Откройте функциональный анализ. Нажмите Поведение → Функциональный анализ, нажмите Выбрать… и выберите DriveCycle.
  8. Объявите ещё одно действие. Добавьте action def EmergencyShutdown;.
  9. Постройте шаги в FFBD. Нажмите Поведение → FFBD, затем + Новая диаграмма и выберите EmergencyShutdown. В панели Добавить введите Open Contactors и нажмите Enter, затем Cut Fuel.
  10. Посмотрите шаги в тексте. Нажмите Модель → Редактор: FFBD записала шаги и их последовательности.

Состояния и переходы

В начальном проекте есть пакет PowertrainBehavior с пустым part def Car.

  1. Определите сигналы. Добавьте attribute def StartRequest;, а также StopRequest, PlugIn и Unplug таким же образом.
  2. Напишите определение состояния. Добавьте state def PowertrainStates с in attribute charge : Real;, entry; then off; и состояниями off, electric и hybrid.
  3. Добавьте переходы. После state off; добавьте accept StartRequest if charge > 20 then electric; и accept StartRequest then hybrid;.
  4. Дайте состоянию действия. Замените state electric; телом, содержащим entry action spinUpMotor;, do action driveElectric; и exit action holdMotor;.
  5. Выйдите из электрического состояния. После него добавьте if charge < 15 then hybrid; и accept StopRequest then off;; добавьте accept StopRequest then off; также после state hybrid;.
  6. Добавьте состояние с именованными переходами. Добавьте state charging { do action chargeBattery; }, transition plugIn first off accept PlugIn then charging; и transition unplugged first charging accept Unplug then off;.
  7. Создайте представление переходов состояний. Нажмите Поведение → Машины состояний, затем + Новая диаграмма и выберите PowertrainStates в поле Показывает.
  8. Нарисуйте переход по времени. Перетащите от маркера charging к off и отпустите на Переход. В панели перехода введите Имя charged и Триггер after 30 [min].
  9. Посмотрите на текст. Нажмите Модель → Редактор: переход записан как именованный переход.
  10. Пусть автомобиль демонстрирует состояния. В Car добавьте exhibit state powertrainStates : PowertrainStates;.

Требования

В начальном проекте есть пакет VehicleRequirements с небольшой копией проекта: Battery, Car и sedan из автопарка со снаряжённой массой 1580 кг.

  1. Назовите пределы. Добавьте attribute maxCurbMass : MassValue = 1650 [kg]; и attribute minBatteryCapacity : EnergyValue = 1.2 [kW*h];.
  2. Напишите определение требования. Добавьте requirement def <'VR-1'> CurbMass с формулировкой doc, subject car : Car;, attribute limit : MassValue; и require constraint { car.curbMass <= limit }.
  3. Вставьте требование. Нажмите ⌃⇧Space / Ctrl+Shift+Space на пустой строке, выберите Определение требования и напишите VR-3 BatteryCapacity с субъектом battery : Battery и require constraint { battery.capacity >= minBatteryCapacity }.
  4. Вложите требования в спецификацию. Добавьте requirement carSpec с subject car : Car; и requirement <'VR-1.1'> sedanMass : CurbMass { attribute :>> limit = maxCurbMass; }.
  5. Укажите, что их удовлетворяет. Добавьте satisfy carSpec by fleet.sedan; и satisfy requirement batterySpec : BatteryCapacity by fleet.sedan.battery;.
  6. Нарушьте требование. Измените снаряжённую массу седана на 1700 [kg]. Редактор отметит satisfy: седан больше не соответствует VR-1.1.
  7. Снова выполните его. Нажмите ⌘Z / Ctrl+Z или верните значение 1580 [kg].
  8. Посмотрите таблицу требований. Нажмите Потребности и требования → Требования.
  9. Создайте представление требований. На странице Диаграммы нажмите + Новая диаграмма, выберите Представление требований и carSpec в поле Показывает.
  10. Проверьте формулировки. Нажмите Потребности и требования → Качество и нажмите Проверить качество.

Верификация и прослеживаемость

В начальном проекте есть требование к снаряжённой массе и спецификация автомобиля, ездовой цикл с шагами cruise и brake, VR-6 batteryMassLimit и VR-7 stopFromCruise.

  1. Напишите вариант верификации. Добавьте verification def <'VC-1'> CurbMassTest с subject car : Car;, objective massObjective { verify carSpec.sedanMass; } и return verdict : Boolean = car.curbMass <= maxCurbMass;.
  2. Примените его к седану. Добавьте verification <'VC-1.1'> sedanWeighing : CurbMassTest { subject car = fleet.sedan; }.
  3. Откройте варианты верификации. Нажмите Верификация → Варианты верификации. Шаги, результаты и статус — это данные Holarch рядом с моделью. В строке Sedan Weighing нажмите + Шаги, затем + Добавить шаг, введите Weigh the car в столбце Action и нажмите Применить. Затем нажмите Пройдено среди кнопок статуса.
  4. Прочитайте RVTM. Нажмите Верификация → RVTM.
  5. Трассируйте шаг к требованию. Нажмите Верификация → Матрица прослеживаемости, покажите требования в строках и действия в столбцах, щёлкните ячейку stopFromCruise и brake и выберите satisfied by.
  6. Выведите требование. Добавьте private import RequirementDerivation::*; и connection batteryMassDerivation : Derivation connect carSpec.sedanMass to batteryMassLimit;.
  7. Запустите проверки модели. Нажмите Верификация → Проверки модели.

Ограничения и вычисления

В начальном проекте есть пакет VehicleAnalysis с двигателем, батареей, автомобилем и значениями седана, а также целевые значения maxCurbMass и minPowerToWeight.

  1. Напишите определение ограничения. Добавьте constraint def MassLimit с in mass : MassValue;, in limit : MassValue; и выражением mass <= limit.
  2. Напишите вычисление. Добавьте calc def PowerToWeight с параметрами power и mass и return ratio = power / mass;.
  3. Свяжите значения седана. Добавьте constraint sedanMassCheck : MassLimit { in mass = fleet.sedan.curbMass; in limit = maxCurbMass; }.
  4. Создайте параметрическое представление. На странице Диаграммы нажмите + Новая диаграмма, выберите Параметрическое представление и VehicleAnalysis в поле Показывает. Проверка проходит: 1580 кг не превышает 1650 кг.
  5. Сделайте так, чтобы проверка не прошла. Измените снаряжённую массу седана на 1700 [kg]; представление покажет, что проверка не пройдена.
  6. Снова добейтесь прохождения. Отмените изменение или верните значение 1580 [kg]. Решить все снова проверяет каждое ограничение.
  7. Выполните вариант анализа. Добавьте analysis def PowerToWeightAnalysis с целью, требующей ratio >= minPowerToWeight, и analysis sedanPowerToWeight : PowerToWeightAnalysis { subject car = fleet.sedan; }.
  8. Отметьте открытые значения. Добавьте private import HolarchMetadata::*; и требование VR-5 ChargeTime с #TBR на пределе времени и @TBD с ответственным, сроком и обоснованием на мощности зарядного устройства. TBD и TBR берутся из библиотеки Holarch HolarchMetadata, а не из стандартной библиотеки SysML v2; они специализируют стандартные метаданные StatusInfo.
  9. Откройте реестр TBD/TBR. Нажмите Потребности и требования → TBD/TBR. Время зарядки указано с ответственным и сроком из его метаданных @TBD. Реестр доступен только для чтения: изменяйте ответственного или дату в метаданных в Редакторе.
  10. Сверните массу. Нажмите Архитектура → Бюджеты и TPM и выберите корневую часть sedan.

Варианты и конфигурации

В начальном проекте есть Component, Battery, Controller, Car и Powertrain.

  1. Импортируйте пакет вариативности. Добавьте private import HolarchVariability::*;.
  2. Напишите вариацию. На пустой строке нажмите ⌃⇧Space / Ctrl+Shift+Space (или нажмите Вставить ▾), выберите Вариация и допишите variation part def BatteryPack :> Battery с вариантами standardPack (1,4 кВт·ч) и largePack (12 кВт·ч, 120 кг).
  3. Напишите линейку продуктов. Добавьте part def CarLine :> Car с part pack : BatteryPack;, variation part charger с вариантами noCharger и wallbox и assert constraint wallboxNeedsLargePack { charger == charger::wallbox implies pack == BatteryPack::largePack }.
  4. Начните конфигурацию. Выберите Вставить ▾ → Конфигурация и заполните part plugInHybrid : CarLine { @HolarchConfiguration; }. Редактор отметит ещё открытые точки вариации.
  5. Выберите варианты. В plugInHybrid выберите Вставить ▾ → Выбор варианта для каждой точки и заполните part :>> pack = BatteryPack::largePack; и part :>> charger = charger::wallbox;.
  6. Добавьте вторую конфигурацию. Таким же образом добавьте selfChargingHybrid со стандартным блоком батарей и без зарядного устройства.
  7. Определите собственное ключевое слово. Добавьте metadata def <safetyCritical> SafetyCritical.
  8. Используйте ключевое слово. В Powertrain напишите #safetyCritical part controller : Controller;.
  9. Посмотрите на линейку продуктов. Создайте General View пакета Vehicles: блок батарей помечен как вариация.

Учебные проекты

Учебные проекты SysML v2 подчиняются тем же правилам, что и другие учебные проекты: они не учитываются в числе активных проектов вашего тарифа, содержат до 300 элементов, и для каждого руководства можно иметь один такой проект. См. Руководства.

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