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 і відкриває панель кроків поруч зі сторінкою. Панель перевіряє модель під час роботи: крок стає зеленим, коли модель містить те, що вимагає крок. Ця сторінка наводить кожен крок текстом, тож ви можете виконувати їх і тут.

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

ПосібникЧасВи навчитеся
Початок роботи15 хвнаписати текст SysML v2, побачити його деревом і поданням, малювати в поданні й додати вимогу
Визначення та атрибути20 хвнаписати переліки, типи значень і абстрактні визначення, спеціалізувати зі значеннями й одиницями, використати автодоповнення, вставлення й перейменування
Порти та інтерфейси20 хввизначити порти й інтерфейси, спрягати порти, з’єднати частини й намалювати інтерфейс у Поданні взаємозв’язків
Дії та потоки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; подробиці — на сторінці Текстова нотація.

Початок роботи

Напишіть першу модель метеостанції: відкрийте текст, додайте визначення частини зі значенням і одиницею, використайте його в іншому визначенні, перегляньте модель в Оглядачі й Загальному поданні, намалюйте частину в поданні й простежте, як вона з’являється в тексті, додайте вимогу із 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. Створіть Подання взаємозв’язків. Натисніть Архітектура → Подання взаємозв’язків, потім + Нова діаграма. Виберіть 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 і відпустіть на Transition. На панелі переходу введіть Назва charged і Тригер after 30 [min].
  9. Подивіться на нього в тексті. Натисніть Модель → Редактор: перехід записано як іменований перехід.
  10. Дайте автомобілю проявляти стани. У Car додайте exhibit state powertrainStates : PowertrainStates;.

Вимоги

Стартовий проєкт має пакет VehicleRequirements з невеликою копією проєкту: Battery, Car і sedan автопарку зі спорядженою масою 1580 kg.

  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 у стовпці Дія і натисніть Застосувати. Потім натисніть Пройдено серед кнопок його стану.
  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 kg не перевищує 1650 kg.
  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 kWh) і largePack (12 kWh, 120 kg).
  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. Перегляньте лінійку продуктів. Створіть Загальне подання Vehicles: блок батарей позначено як варіацію.

Проєкти посібників

Проєкти посібників SysML v2 підлягають тим самим правилам, що й інші проєкти посібників: вони не враховуються в активних проєктах вашого тарифу, містять до 300 елементів, і для кожного посібника можна мати один. Див. Посібники.

SysML® і OMG® — зареєстровані торговельні марки Object Management Group, Inc. у США та інших країнах.