SysML v2
Руководства SysML v2
Девять пошаговых руководств для проектов SysML v2, от первого пакета до портов, действий, состояний, требований, верификации, ограничений и вариантов, с панелью шагов, которая проверяет вашу работу.
На этой странице
В 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
- Откройте Справка → Руководства на панели навигации или нажмите ⌘K / Ctrl+K и введите
tutorial. Вне проекта страница Руководства сначала перечисляет руководства LML, затем Руководства для проектов SysML v2. Внутри проекта SysML v2 она перечисляет только руководства SysML v2. - Нажмите Начать на карточке. 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.
- Откройте пакет. Нажмите Модель → Редактор. Каждое объявление — это ключевое слово и имя, затем тело в фигурных скобках или точка с запятой.
- Напишите перечисление. Над
part def Car {добавьтеenum def DriveMode { enum economy; enum normal; enum sport; }(по одному значению в строке). - Определите тип значения. Под ним добавьте
attribute def TirePressure :> ScalarValue;.:>означает «специализирует». - Напишите абстрактное определение. Добавьте
abstract part def Componentс комментариемdocи атрибутамиmass : MassValue,partNumber : Stringиpower : PowerValue.//начинает заметку, которая остаётся только в тексте. - Пусть средство проверки найдёт ошибку. Добавьте
part def Battery :> Componentсattribute redefines mass = 45 [kg];и намеренноattribute redefines power = 60 [kg];. Средство проверки подчеркнёт единицу: килограммы — это не мощность. - Исправьте единицу. Замените её на
60 [W]. - Дополните имя. В батарее введите
attribute capacity : Ener, примитеEnergyValueиз списка автодополнения клавишей Enter и завершите строку символом;. - Найдите его в Стандартной библиотеке. Нажмите Настройки → Стандартная библиотека внизу панели навигации и введите
EnergyValueв поле поиска. - Вставьте определение. В Редакторе на пустой строке нажмите ⌃⇧Space / Ctrl+Shift+Space (или нажмите Вставить ▾), выберите Определение части и допишите
part def Engine :> Componentсattribute redefines mass = 110 [kg];иattribute cylinders : Integer;. - Используйте определения. В
Carдобавьтеattribute mode : DriveMode;,part battery : Battery;иpart engine : Engine;. - Переименуйте везде. Поставьте курсор на
cylinders, нажмите F2 и переименуйте его вcylinderCount.
Порты и интерфейсы
В начальном проекте есть компоненты силовой установки с портами крутящего момента и мощности, определения портов TorquePort и PowerPort и определения интерфейсов Shaft и HighVoltageBus.
- Определите порт. Над
port def TorquePortдобавьтеport def FuelPortсout attribute flowRate : Real;иattribute kind : FuelKind;.outозначает, что значение выходит из части, владеющей портом. - Дайте частям порты. Добавьте
port fuelOut : FuelPort;вFuelTankиport fuelIn : ~FuelPort;вEngine.~сопрягает порт: вход и выход меняются местами. - Определите интерфейс. Добавьте
interface def FuelLine { end supply : FuelPort; end consumer : ~FuelPort; }. - Постройте силовую установку. В конце пакета добавьте
part def Powertrainс частямиtank,engine,motor,batteryиtransmission, портомoutput : TorquePortиbind output = transmission.output;. - Соедините две части. В силовой установке добавьте
interface fuel : FuelLine connect tank.fuelOut to engine.fuelIn;. - Добавьте валы. Добавьте
interface engineShaft : Shaft connect engine.output to transmission.engineIn;иinterface motorShaft : Shaft connect motor.output to transmission.motorIn;. - Создайте Interconnection View. Нажмите Архитектура → Представления Interconnection, затем + Новая диаграмма. Выберите
Powertrainв поле Показывает и нажмите Создать. - Нарисуйте интерфейс. Перетащите от маркера порта батареи
powerOutк порту электромотораpowerInи отпустите на Interface : HighVoltageBus. - Назовите интерфейс. Выделите новую линию и введите
hvBusв поле Имя в инспекторе. - Посмотрите на текст. Нажмите Модель → Редактор: интерфейс находится в силовой установке, со своим именем, типом и концами.
Действия и потоки
В начальном проекте есть пакет VehicleBehavior с предметами Fuel и Torque, функциями ProduceTorque (F.2) и DriveWheels (F.3) и тремя определениями частей.
- Определите функцию. Добавьте
action def <'F.1'> SupplyFuelсin attribute fuelDemand : Real;иout item fuel : Fuel;. Краткое имя в угловых скобках — это номер функции. - Напишите ездовой цикл. Добавьте
action def <'F'> DriveCycleсfirst start then split;,fork split;,then supply;,then produce;и шагамиaction supply : SupplyFuelиaction produce : ProduceTorque, каждый сduration. - Добавьте поток. В ездовом цикле добавьте
flow of Fuel from supply.fuel to produce.fuel;. - Объедините ветви. Добавьте
first supply then ready;,first produce then ready;,join ready;,then action drive : DriveWheels { … },then done;иflow produce.torque to drive.torque;. - Создайте представление Action Flow. Нажмите Поведение → Потоки действий, затем + Новая диаграмма и выберите
DriveCycleв поле Показывает. - Укажите, кто выполняет каждый шаг. Добавьте
part def DrivenCarсperform action trip : DriveCycle;и частямиtank,engineиtransmission, каждая сperform trip.supply;,perform trip.produce;илиperform trip.drive;. Представление получит дорожку для каждой части. - Откройте функциональный анализ. Нажмите Поведение → Функциональный анализ, нажмите Выбрать… и выберите
DriveCycle. - Объявите ещё одно действие. Добавьте
action def EmergencyShutdown;. - Постройте шаги в FFBD. Нажмите Поведение → FFBD, затем + Новая диаграмма и выберите
EmergencyShutdown. В панели Добавить введитеOpen Contactorsи нажмите Enter, затемCut Fuel. - Посмотрите шаги в тексте. Нажмите Модель → Редактор: FFBD записала шаги и их последовательности.
Состояния и переходы
В начальном проекте есть пакет PowertrainBehavior с пустым part def Car.
- Определите сигналы. Добавьте
attribute def StartRequest;, а такжеStopRequest,PlugInиUnplugтаким же образом. - Напишите определение состояния. Добавьте
state def PowertrainStatesсin attribute charge : Real;,entry; then off;и состояниямиoff,electricиhybrid. - Добавьте переходы. После
state off;добавьтеaccept StartRequest if charge > 20 then electric;иaccept StartRequest then hybrid;. - Дайте состоянию действия. Замените
state electric;телом, содержащимentry action spinUpMotor;,do action driveElectric;иexit action holdMotor;. - Выйдите из электрического состояния. После него добавьте
if charge < 15 then hybrid;иaccept StopRequest then off;; добавьтеaccept StopRequest then off;также послеstate hybrid;. - Добавьте состояние с именованными переходами. Добавьте
state charging { do action chargeBattery; },transition plugIn first off accept PlugIn then charging;иtransition unplugged first charging accept Unplug then off;. - Создайте представление переходов состояний. Нажмите Поведение → Машины состояний, затем + Новая диаграмма и выберите
PowertrainStatesв поле Показывает. - Нарисуйте переход по времени. Перетащите от маркера
chargingкoffи отпустите на Переход. В панели перехода введите Имяchargedи Триггерafter 30 [min]. - Посмотрите на текст. Нажмите Модель → Редактор: переход записан как именованный переход.
- Пусть автомобиль демонстрирует состояния. В
Carдобавьтеexhibit state powertrainStates : PowertrainStates;.
Требования
В начальном проекте есть пакет VehicleRequirements с небольшой копией проекта: Battery, Car и sedan из автопарка со снаряжённой массой 1580 кг.
- Назовите пределы. Добавьте
attribute maxCurbMass : MassValue = 1650 [kg];иattribute minBatteryCapacity : EnergyValue = 1.2 [kW*h];. - Напишите определение требования. Добавьте
requirement def <'VR-1'> CurbMassс формулировкойdoc,subject car : Car;,attribute limit : MassValue;иrequire constraint { car.curbMass <= limit }. - Вставьте требование. Нажмите ⌃⇧Space / Ctrl+Shift+Space на пустой строке, выберите Определение требования и напишите
VR-3 BatteryCapacityс субъектомbattery : Batteryиrequire constraint { battery.capacity >= minBatteryCapacity }. - Вложите требования в спецификацию. Добавьте
requirement carSpecсsubject car : Car;иrequirement <'VR-1.1'> sedanMass : CurbMass { attribute :>> limit = maxCurbMass; }. - Укажите, что их удовлетворяет. Добавьте
satisfy carSpec by fleet.sedan;иsatisfy requirement batterySpec : BatteryCapacity by fleet.sedan.battery;. - Нарушьте требование. Измените снаряжённую массу седана на
1700 [kg]. Редактор отметит satisfy: седан больше не соответствует VR-1.1. - Снова выполните его. Нажмите ⌘Z / Ctrl+Z или верните значение
1580 [kg]. - Посмотрите таблицу требований. Нажмите Потребности и требования → Требования.
- Создайте представление требований. На странице Диаграммы нажмите + Новая диаграмма, выберите Представление требований и
carSpecв поле Показывает. - Проверьте формулировки. Нажмите Потребности и требования → Качество и нажмите Проверить качество.
Верификация и прослеживаемость
В начальном проекте есть требование к снаряжённой массе и спецификация автомобиля, ездовой цикл с шагами cruise и brake, VR-6 batteryMassLimit и VR-7 stopFromCruise.
- Напишите вариант верификации. Добавьте
verification def <'VC-1'> CurbMassTestсsubject car : Car;,objective massObjective { verify carSpec.sedanMass; }иreturn verdict : Boolean = car.curbMass <= maxCurbMass;. - Примените его к седану. Добавьте
verification <'VC-1.1'> sedanWeighing : CurbMassTest { subject car = fleet.sedan; }. - Откройте варианты верификации. Нажмите Верификация → Варианты верификации. Шаги, результаты и статус — это данные Holarch рядом с моделью. В строке Sedan Weighing нажмите + Шаги, затем + Добавить шаг, введите
Weigh the carв столбце Action и нажмите Применить. Затем нажмите Пройдено среди кнопок статуса. - Прочитайте RVTM. Нажмите Верификация → RVTM.
- Трассируйте шаг к требованию. Нажмите Верификация → Матрица прослеживаемости, покажите требования в строках и действия в столбцах, щёлкните ячейку
stopFromCruiseиbrakeи выберите satisfied by. - Выведите требование. Добавьте
private import RequirementDerivation::*;иconnection batteryMassDerivation : Derivation connect carSpec.sedanMass to batteryMassLimit;. - Запустите проверки модели. Нажмите Верификация → Проверки модели.
Ограничения и вычисления
В начальном проекте есть пакет VehicleAnalysis с двигателем, батареей, автомобилем и значениями седана, а также целевые значения maxCurbMass и minPowerToWeight.
- Напишите определение ограничения. Добавьте
constraint def MassLimitсin mass : MassValue;,in limit : MassValue;и выражениемmass <= limit. - Напишите вычисление. Добавьте
calc def PowerToWeightс параметрамиpowerиmassиreturn ratio = power / mass;. - Свяжите значения седана. Добавьте
constraint sedanMassCheck : MassLimit { in mass = fleet.sedan.curbMass; in limit = maxCurbMass; }. - Создайте параметрическое представление. На странице Диаграммы нажмите + Новая диаграмма, выберите Параметрическое представление и
VehicleAnalysisв поле Показывает. Проверка проходит: 1580 кг не превышает 1650 кг. - Сделайте так, чтобы проверка не прошла. Измените снаряжённую массу седана на
1700 [kg]; представление покажет, что проверка не пройдена. - Снова добейтесь прохождения. Отмените изменение или верните значение
1580 [kg]. Решить все снова проверяет каждое ограничение. - Выполните вариант анализа. Добавьте
analysis def PowerToWeightAnalysisс целью, требующейratio >= minPowerToWeight, иanalysis sedanPowerToWeight : PowerToWeightAnalysis { subject car = fleet.sedan; }. - Отметьте открытые значения. Добавьте
private import HolarchMetadata::*;и требование VR-5ChargeTimeс#TBRна пределе времени и@TBDс ответственным, сроком и обоснованием на мощности зарядного устройства.TBDиTBRберутся из библиотеки HolarchHolarchMetadata, а не из стандартной библиотеки SysML v2; они специализируют стандартные метаданныеStatusInfo. - Откройте реестр TBD/TBR. Нажмите Потребности и требования → TBD/TBR. Время зарядки указано с ответственным и сроком из его метаданных
@TBD. Реестр доступен только для чтения: изменяйте ответственного или дату в метаданных в Редакторе. - Сверните массу. Нажмите Архитектура → Бюджеты и TPM и выберите корневую часть
sedan.
Варианты и конфигурации
В начальном проекте есть Component, Battery, Controller, Car и Powertrain.
- Импортируйте пакет вариативности. Добавьте
private import HolarchVariability::*;. - Напишите вариацию. На пустой строке нажмите ⌃⇧Space / Ctrl+Shift+Space (или нажмите Вставить ▾), выберите Вариация и допишите
variation part def BatteryPack :> Batteryс вариантамиstandardPack(1,4 кВт·ч) иlargePack(12 кВт·ч, 120 кг). - Напишите линейку продуктов. Добавьте
part def CarLine :> Carсpart pack : BatteryPack;,variation part chargerс вариантамиnoChargerиwallboxиassert constraint wallboxNeedsLargePack { charger == charger::wallbox implies pack == BatteryPack::largePack }. - Начните конфигурацию. Выберите Вставить ▾ → Конфигурация и заполните
part plugInHybrid : CarLine { @HolarchConfiguration; }. Редактор отметит ещё открытые точки вариации. - Выберите варианты. В
plugInHybridвыберите Вставить ▾ → Выбор варианта для каждой точки и заполнитеpart :>> pack = BatteryPack::largePack;иpart :>> charger = charger::wallbox;. - Добавьте вторую конфигурацию. Таким же образом добавьте
selfChargingHybridсо стандартным блоком батарей и без зарядного устройства. - Определите собственное ключевое слово. Добавьте
metadata def <safetyCritical> SafetyCritical. - Используйте ключевое слово. В
Powertrainнапишите#safetyCritical part controller : Controller;. - Посмотрите на линейку продуктов. Создайте General View пакета
Vehicles: блок батарей помечен как вариация.
Учебные проекты
Учебные проекты SysML v2 подчиняются тем же правилам, что и другие учебные проекты: они не учитываются в числе активных проектов вашего тарифа, содержат до 300 элементов, и для каждого руководства можно иметь один такой проект. См. Руководства.
Связанные материалы
- Руководства
- Начало работы с проектами SysML v2
- Текстовый редактор и браузер модели
- Текстовая нотация
- Представления
- Требования в проектах SysML v2
SysML® и OMG® — зарегистрированные товарные знаки Object Management Group, Inc. в США и других странах.