SysML v2
Посібники з SysML v2
Дев’ять покрокових посібників для проєктів SysML v2, від першого пакета до портів, дій, станів, вимог, верифікації, обмежень і варіантів, з панеллю кроків, яка перевіряє вашу роботу.
На цій сторінці
Holarch має серію покрокових посібників для проєктів SysML v2. Кожен створює невеликий стартовий проєкт SysML v2 і відкриває панель кроків поруч зі сторінкою. Панель перевіряє модель під час роботи: крок стає зеленим, коли модель містить те, що вимагає крок. Ця сторінка наводить кожен крок текстом, тож ви можете виконувати їх і тут.
Перший посібник використовує метеостанцію WS-1, як і посібники LML. Інші будують частини гібридного автомобіля, моделі демопроєкту Hybrid Car: типи значень і компоненти, порти й інтерфейси силової установки, їздовий цикл, стани силової установки, вимоги до автомобіля, їх верифікацію, перевірки значень седана та лінійку продуктів. Кожен посібник має власний стартовий проєкт, тож їх можна проходити в будь-якому порядку. Кожен стартовий проєкт і кожен завершений посібник перевіряються з 0 проблем.
| Посібник | Час | Ви навчитеся |
|---|---|---|
| Початок роботи | 15 хв | написати текст SysML v2, побачити його деревом і поданням, малювати в поданні й додати вимогу |
| Визначення та атрибути | 20 хв | написати переліки, типи значень і абстрактні визначення, спеціалізувати зі значеннями й одиницями, використати автодоповнення, вставлення й перейменування |
| Порти та інтерфейси | 20 хв | визначити порти й інтерфейси, спрягати порти, з’єднати частини й намалювати інтерфейс у Поданні взаємозв’язків |
| Дії та потоки | 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; подробиці — на сторінці Текстова нотація.
Початок роботи
Напишіть першу модель метеостанції: відкрийте текст, додайте визначення частини зі значенням і одиницею, використайте його в іншому визначенні, перегляньте модель в Оглядачі й Загальному поданні, намалюйте частину в поданні й простежте, як вона з’являється в тексті, додайте вимогу із 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;. - Створіть Подання взаємозв’язків. Натисніть Архітектура → Подання взаємозв’язків, потім + Нова діаграма. Виберіть
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і відпустіть на Transition. На панелі переходу введіть Назваchargedі Тригерafter 30 [min]. - Подивіться на нього в тексті. Натисніть Модель → Редактор: перехід записано як іменований перехід.
- Дайте автомобілю проявляти стани. У
Carдодайтеexhibit state powertrainStates : PowertrainStates;.
Вимоги
Стартовий проєкт має пакет VehicleRequirements з невеликою копією проєкту: Battery, Car і sedan автопарку зі спорядженою масою 1580 kg.
- Назвіть граничні значення. Додайте
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у стовпці Дія і натисніть Застосувати. Потім натисніть Пройдено серед кнопок його стану. - Прочитайте 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 kg не перевищує 1650 kg. - Зробіть так, щоб перевірка не пройшла. Змініть споряджену масу седана на
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 kWh) іlargePack(12 kWh, 120 kg). - Напишіть лінійку продуктів. Додайте
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;. - Перегляньте лінійку продуктів. Створіть Загальне подання
Vehicles: блок батарей позначено як варіацію.
Проєкти посібників
Проєкти посібників SysML v2 підлягають тим самим правилам, що й інші проєкти посібників: вони не враховуються в активних проєктах вашого тарифу, містять до 300 елементів, і для кожного посібника можна мати один. Див. Посібники.
Пов’язане
- Посібники
- Початок роботи з проєктами SysML v2
- Текстовий редактор і Оглядач
- Текстова нотація
- Подання
- Вимоги в проєктах SysML v2
SysML® і OMG® — зареєстровані торговельні марки Object Management Group, Inc. у США та інших країнах.