Посібник · SysML v2
SysML v1 і v2: чим відрізняються дві мови
Прослухати цей посібник 20 хв
SysML v1 і SysML v2 мають спільну мету й багато спільних назв, але SysML v2 — нова мова, а не редакція. Цей посібник порівнює їх поруч: основу, визначення та використання, текстову нотацію, одиниці, порти, поведінку, вимоги, подання, API і те, що включає міграція з v1 на v2.
На цій сторінці
- Коротко
- Основа: профіль UML проти KerML
- Визначення та використання замість блоків і властивостей
- Стандартна текстова нотація
- Стандартна бібліотека, величини та одиниці
- Порти, інтерфейси та з’єднання
- Поведінка: дії та стани
- Вимоги та випадки верифікації
- Подання замість намальованих діаграм
- Systems Modeling API та обмін у JSON
- Міграція моделі з SysML v1 на v2
- Як перевіряли лістинги
- Спробуйте в Holarch
- Куди далі
Коротко
Читачі, які знають SysML v1, упізнають більшість понять у SysML v2. Змінилося те, як вони побудовані й наскільки точно визначені. Таблиця підсумовує порівняння; кожен рядок має власний розділ нижче.
| Тема | SysML v1 | SysML v2 |
|---|---|---|
| Основа | Профіль UML 2: стереотипи на підмножині метакласів UML | Власна метамодель на основі Kernel Modeling Language (KerML) із семантикою, визначеною у формальній бібліотеці |
| Структура | Блоки з властивостями частин, посилань і значень | Визначення та використання для кожного виду елементів: part def і part, port def і port тощо |
| Нотація | Графічна (дев’ять видів діаграм); немає стандартного тексту для всієї моделі | Стандартна текстова нотація та стандартна графічна нотація для тієї самої моделі |
| Величини та одиниці | Типи значень з одиницями через модель одиниць і бібліотеки моделей | Величини ISQ та одиниці SI в стандартній бібліотеці, що використовуються безпосередньо в значеннях на зразок 6.5 [kg] |
| Інтерфейси | Повні та проксі-порти, інтерфейсні блоки, властивості потоку, потоки елементів на з’єднувачах | Визначення портів зі спрямованими ознаками, спряження ~, визначення інтерфейсів із типізованими кінцями, потоки та зв’язування |
| Поведінка | Діяльності, автомати станів і взаємодії з UML, пов’язані зі структурою через розподіл | Дії, стани й повідомлення як події, пов’язані зі структурою через perform і exhibit |
| Вимоги | Стереотипний клас з ідентифікатором і текстом; обмеження зберігаються окремо в блоках обмежень | Вимога — це обмеження із суб’єктом; текст і перевірювана умова в одному елементі |
| Верифікація | Тестові випадки, пов’язані через verify | Випадки верифікації з метою та вердиктом |
| Діаграми | Малюнки, що зберігаються в інструменті; компонування рідко переносяться між інструментами | Подання — це елементи моделі, які зазначають, що вони показують; інструмент їх відображає |
| Обмін | Файли XMI з відмінностями між інструментами | Текстові файли, JSON і стандартний Systems Modeling API |
Основа: профіль UML проти KerML
SysML v1 визначено як профіль UML 2. Вона бере підмножину UML і додає стереотипи: блок — це клас UML зі стереотипом «block», вимога — клас із «requirement», властивість потоку — властивість із «flowProperty». Це дало змогу швидко запровадити SysML v1, бо UML-інструменти могли її підтримувати, але також означало, що системні поняття підганяли під програмні, а значення багатьох конструкцій походило із семантики UML, написаної для програмного забезпечення.
SysML v2 відмовляється від основи UML. Вона побудована на Kernel Modeling Language (KerML) — меншій мові, ядру якої надано точне значення в бібліотеці моделей KerML. SysML v2 додає згори поняття системної інженерії: частини, порти, дії, стани, вимоги, випадки й подання. Кожну конструкцію SysML v2 визначено як спеціалізацію чогось у цій бібліотеці. На практиці це означає:
- Структура й поведінка мають спільну основу. Частини й дії — це події, що існують у часі, тож частина може виконувати дію чи демонструвати стан без окремого рівня розподілу.
- Інструменти краще узгоджуються щодо значення моделі, бо значення закладено в специфікації та її бібліотеках, а не в інтерпретації кожного інструмента.
- Стереотипи більше не є механізмом розширення. SysML v2 використовує визначення метаданих для анотацій, специфічних для інструмента чи предметної області.
Визначення та використання замість блоків і властивостей
У SysML v1 центральний елемент — блок: діаграма визначення блоків визначає блоки, а внутрішня діаграма блока показує частини одного блока. Властивість частини типізується блоком; властивість значення — типом значення. Щоб надати одній частині значення, відмінне від значення за замовчуванням її блока, наприклад важчий насос в одному варіанті продукту, потрібне обхідне рішення: спеціалізований блок, що перевизначає властивість, тип для конкретної властивості або специфікація екземпляра.
SysML v2 узагальнює це в один шаблон для кожного елемента: визначення каже, що таке певний вид речі, використання — це така річ у контексті. Використання вкладаються, і вкладене використання може перевизначити успадковане власним значенням. Той самий шаблон діє для атрибутів, портів, дій, станів, вимог і подань.
package CoolingLoop {
doc /* The engine cooling loop of a small generator set. */
private import ScalarValues::*;
private import ISQ::*;
private import SI::*;
part def Pump {
attribute mass : MassValue;
attribute shaftPower : PowerValue;
}
part def ElectricPump :> Pump {
attribute supplyVoltage : ElectricPotentialValue;
}
part def Radiator {
attribute mass : MassValue;
attribute heatRejection : PowerValue;
}
part def CoolingSystem {
part pump : ElectricPump {
attribute redefines mass = 2.4 [kg];
attribute redefines shaftPower = 150 [W];
attribute redefines supplyVoltage = 24 [V];
}
part radiator : Radiator {
:>> mass = 6.5 [kg];
:>> heatRejection = 18 [kW];
}
attribute totalMass : MassValue = pump.mass + radiator.mass;
}
}
| SysML v1 | SysML v2 у цьому лістингу |
|---|---|
Блок Pump із властивостями значень | part def Pump з атрибутами |
Узагальнення від ElectricPump до Pump | Спеціалізація part def ElectricPump :> Pump |
Властивість частини pump блока CoolingSystem, типізована блоком | Використання частини part pump : ElectricPump |
| Значення для конкретного контексту через спеціалізований блок або екземпляр | attribute redefines mass = 2.4 [kg] безпосередньо на використанні |
| Похідне значення з блоком обмежень і параметричною діаграмою | totalMass як вираз в атрибуті |
:>> — скорочена форма redefines. Властивості посилань у v1, що вказують на частину, яка належить іншому елементу, стають використаннями ref у v2.
Стандартна текстова нотація
SysML v1 не має стандартної текстової форми для всієї моделі. Модель живе в репозиторії інструмента, люди працюють у діаграмах, а файли переходять між інструментами як XMI, призначений для машин, а не для читання. Текст з’являється лише місцями: вирази обмежень, непрозорі поведінки та мови дій у деяких інструментах.
SysML v2 має текстову нотацію, що охоплює всю мову, поряд із графічною нотацією. Обидві показують ту саму модель. Кожен лістинг на цій сторінці — це текстова нотація; підручник SysML v2 крок за кроком будує в ній повну модель. Текст змінює спосіб, у який може працювати команда:
- Модель можна рецензувати рядок за рядком, порівнювати за допомогою diff і зберігати в системі керування версіями разом з іншими інженерними даними.
- Інженери можуть швидко вводити модель, копіювати шаблони між моделями й генерувати її частини скриптами.
- Модель можна перевіряти як вихідний код: нерозпізнані імена, неправильні одиниці й невідповідні порти повідомляються там, де вони трапляються.
Текстова нотація не замінює діаграм. Вона робить модель основним артефактом, а діаграми стають її поданнями, як описано нижче.
Стандартна бібліотека, величини та одиниці
У SysML v1 властивість значення типізується типом значення, який може мати одиницю й вид величини. Специфікація містить модель величин і одиниць та бібліотеки моделей для поширених одиниць, але інструменти відрізняються тим, які бібліотеки вони постачають і наскільки глибоко перевіряють одиниці у виразах.
SysML v2 постачає стандартну бібліотеку як частину мови. Вона містить Міжнародну систему величин (ISQ), одиниці SI (SI), звичаєві одиниці США, скалярні типи, колекції та стандартні визначення подань. У лістингу вище:
attribute mass : MassValueозначає, що атрибут є масою, а не числом.6.5 [kg]— це значення величини: число з одиницею, записане безпосередньо у виразі.pump.mass + radiator.massдодає дві маси. Інструмент, що обчислює одиниці, може відхилити вираз, який додає масу до потужності, або масу, задану у вольтах.
Порти, інтерфейси та з’єднання
Порти в SysML v1 пройшли кілька варіантів. Ранні версії мали стандартні порти й порти потоку; пізніші замінили їх повними портами, проксі-портами та інтерфейсними блоками з властивостями потоку. Властивість потоку має напрямок (in, out або inout), порт можна спрягти, щоб обернути напрямки, а потоки елементів на з’єднувачах вказують, що передається. Багато наявних моделей v1 досі поєднують старі й нові види портів.
SysML v2 зберігає ці ідеї й робить їх однорідними. Визначення порту перелічує спрямовані характеристики, сторона, що отримує, використовує спряження ~ того самого визначення, а визначення інтерфейсу описує вид з’єднання з типізованими кінцями.
package CoolantInterfaces {
private import ISQ::*;
item def Coolant {
attribute temperature : ThermodynamicTemperatureValue;
}
port def CoolantPort {
out item coolant : Coolant;
}
interface def Hose {
end supply : CoolantPort;
end ret : ~CoolantPort;
}
part def Pump {
port outlet : CoolantPort;
}
part def Radiator {
port inlet : ~CoolantPort;
}
part def Loop {
part pump : Pump;
part radiator : Radiator;
interface hose : Hose connect pump.outlet to radiator.inlet;
}
}
| SysML v1 | SysML v2 |
|---|---|
| Інтерфейсний блок із властивостями потоку | port def з характеристиками in, out або inout |
| Проксі-порт або повний порт, типізований інтерфейсним блоком | Використання port, типізоване визначенням порту |
| Спряжений тип порту | ~CoolantPort |
| З’єднувач, за потреби типізований блоком асоціації | connect … to … або використання interface, типізоване interface def |
| Зв’язувальний з’єднувач | bind a = b |
| Потік елементів на з’єднувачі | Використання flow або характеристика-елемент порту |
Оскільки напрямки є частиною визначень, засіб перевірки може попередити, коли обидва кінці з’єднання надсилають ту саму характеристику й жоден її не отримує.
Loop із лістингу в Поданні взаємозв’язків — відповіднику внутрішньої блок-діаграми в SysML v2.Поведінка: дії та стани
SysML v1 запозичує поведінку з UML: діяльності із семантикою потоку токенів, машини станів і взаємодії для діаграм послідовності. Поведінку пов’язують зі структурою, що її виконує, через розподіл, часто за допомогою розділів діяльності (доріжок) або зв’язків «allocate».
У SysML v2 дії та стани є подіями-входженнями (occurrences), як і частини. Визначення дії має вхідні й вихідні параметри; послідовності (first … then …) задають порядок, а потоки вказують, що передається між кроками. Визначення стану має стани й переходи з тригерами, умовами-охоронцями та ефектами. Частина виконує дію (perform) і демонструє стан (exhibit), тож зв’язок зі структурою є частиною мови, а не доданим зв’язком.
package PumpBehavior {
private import ISQ::*;
item def StartCommand;
item def StopCommand;
item def Coolant;
action def Circulate {
in item cold : Coolant;
out item warm : Coolant;
}
action def CoolEngine {
action pumpCoolant : Circulate;
action rejectHeat : Circulate;
flow pumpCoolant.warm to rejectHeat.cold;
first start then pumpCoolant;
first pumpCoolant then rejectHeat;
first rejectHeat then done;
}
state def PumpModes {
entry; then off;
state off;
state running;
transition first off accept StartCommand then running;
transition first running accept StopCommand then off;
}
part def Pump {
exhibit state modes : PumpModes;
}
}
| SysML v1 | SysML v2 |
|---|---|
| Діяльність із діями, потоками керування й потоками об’єктів | action def з використаннями дій, послідовностями й потоками flow |
| Вузли розгалуження, з’єднання, рішення й злиття | fork, join, decide і merge |
| Дія виклику поведінки | Використання дії, типізоване іншим визначенням дії |
| Розділ або «allocate» від діяльності до блоку | perform у частині |
| Машина станів, що належить блоку | state def з exhibit state у частині |
| Перехід із тригером, умовою-охоронцем і ефектом | transition … accept … if … do … then … |
| Взаємодія (діаграма послідовності) | Входження з повідомленнями message, показані в Поданні послідовності |
PumpModes у Поданні переходів станів, побудоване з наведеного вище тексту.Вимоги та випадки верифікації
Вимога SysML v1 — це стереотипований клас із двома рядками: ідентифікатором і текстом. Зв’язки поєднують її з рештою моделі: satisfy, verify, derive, refine, trace і copy. Тестовий випадок — це поведінка, позначена «testCase». Щоб перевірити вимогу числами, потрібен окремий блок обмежень на параметричній діаграмі, і ніщо в мові не пов’язує це обмеження з текстом вимоги.
У SysML v2 визначення вимоги є різновидом визначення обмеження. Воно має суб’єкт (те, чого стосується вимога), може мати атрибути, як-от граничне значення, і містить умову, яка має виконуватися. Текст doc і умова містяться в одному елементі. Випадок верифікації вказує у своїй меті вимогу, яку він верифікує, і повертає вердикт.
package CoolingRequirements {
private import ScalarValues::*;
private import ISQ::*;
private import SI::*;
part def CoolingSystem {
attribute heatRejection : PowerValue;
}
part cooling : CoolingSystem {
attribute redefines heatRejection = 18 [kW];
}
requirement def <'CR-1'> HeatRejection {
doc /* The cooling system shall reject at least the engine's waste heat at full load. */
subject system : CoolingSystem;
attribute wasteHeat : PowerValue;
require constraint { system.heatRejection >= wasteHeat }
}
requirement coolingSpec : HeatRejection {
subject system : CoolingSystem;
attribute redefines wasteHeat = 15 [kW];
}
satisfy coolingSpec by cooling;
verification def <'VC-1'> HeatRunTest {
doc /* Run the engine at full load on a test stand and measure the heat the radiator rejects. */
subject system : CoolingSystem;
objective {
verify coolingSpec;
}
return verdict : Boolean = system.heatRejection >= coolingSpec.wasteHeat;
}
verification heatRun : HeatRunTest {
subject system = cooling;
}
}
<'CR-1'>— це коротке ім’я, місце, де у v2 живе ідентифікатор вимоги з v1.require constraint— це перевірювана форма тексту. За 18 kW проти 15 kW інструмент, що обчислює обмеження, повідомляє, що вимогу виконано.satisfyіverifyзберігають своє значення з v1. Derive, refine і trace відображаються на залежності або на використання вимог, вкладені в інші вимоги; команди самі вирішують, як їх моделювати.- SysML v2 додає до вимог припущення (
assume constraint), зацікавлених сторін і занепокоєння, а поряд із випадками верифікації — випадки використання та випадки аналізу.
Подання замість намальованих діаграм
Діаграма SysML v1 — це креслення, яким володіє інструмент: хтось вирішує, які елементи на ній з’являються і де. Дві діаграми того самого блоку можуть розходитися щодо того, що він містить, а компонування діаграм рідко переживає обмін між інструментами. Пізніші версії v1 додали подання й точки зору, але їх здебільшого використовують для документів, а не для діаграм, які інженери малюють щодня.
У SysML v2 подання є елементом моделі. Воно називає, що показати, через expose, які види елементів включити, через filter, і яким стандартним визначенням подання його відобразити. Компонування залишено інструменту; вміст подання міститься в моделі й читається в тексті.
package CoolingViews {
private import StandardViewDefinitions::*;
part def Pump;
part def Radiator;
part def Loop {
part pump : Pump;
part radiator : Radiator;
connect pump to radiator;
}
view loopConnections : InterconnectionView {
expose Loop;
}
view structure : GeneralView {
filter @SysML::PartDefinition;
expose CoolingViews::*;
}
}
| Діаграма SysML v1 | Подання SysML v2 |
|---|---|
| Діаграма визначення блоків, пакетів, вимог | Загальне подання з фільтрами |
| Внутрішня блок-діаграма | Подання взаємозв’язків |
| Діаграма діяльності | Подання Action Flow |
| Діаграма машини станів | Подання переходів станів |
| Діаграма послідовності | Подання послідовності |
| Параметрична діаграма | Загальне подання або Подання взаємозв’язків обмежень та їхніх прив’язок |
| Діаграма випадків використання | Загальне подання випадків використання та акторів |
| Таблиці й матриці (у v1 залежать від інструменту) | Табличне подання (Grid View) |
Systems Modeling API та обмін у JSON
Моделі SysML v1 переходять між інструментами у форматі XMI. XMI — стандарт, але кожен інструмент записує власний варіант, стереотипи й дані діаграм, тому обмін зазвичай треба тестувати для кожної пари інструментів, і немає стандартного способу, щоб програма запитувала модель, яка зберігається в іншому інструменті.
SysML v2 супроводжує специфікація Systems Modeling API and Services. Вона визначає сервіси для проєктів, гілок, комітів, елементів і запитів, а також прив’язку REST/HTTP, у якій кожен елемент — це об’єкт JSON з @id і @type. Наслідки:
- Скрипт, панель моніторингу чи інший інструмент може читати модель і робити до неї запити через один задокументований інтерфейс замість специфічного для постачальника.
- Ідентифікатори елементів переходять разом із моделлю, тож зв’язки між інструментами можуть пережити обмін.
- Моделі версіонуються як коміти в гілках, майже як вихідний код.
Текстові файли та JSON доповнюють одне одного: текст призначений для людей — читати, рецензувати й порівнювати; JSON зберігає ідентифікатори, на які покладаються інструменти.
Міграція моделі з SysML v1 на v2
Перенесення моделі v1 у v2 — це переклад між мовами, а не оновлення файлу, і цільовий інструмент визначає, наскільки цей процес автоматизовано: що перевірити в інструменті SysML v2 розглядає імпорт v1 серед інших перевірок. Значна частина типової моделі відображається безпосередньо, а дещо краще перебудувати по-новому, у стилі v2, ніж перекладати дослівно.
Що зіставляється чисто
- Пакети та їхня вкладеність.
- Блоки — у визначення частин, властивості частин — у використання частин, властивості-посилання — у використання
ref, узагальнення — у спеціалізації. - Властивості значень — в атрибути, з величинами й одиницями, якщо типи значень у v1 мали одиниці.
- Інтерфейсні блоки з властивостями потоку — у визначення портів; проксі-порти й повні порти — у використання портів; з’єднувачі — у з’єднання або інтерфейси.
- Ідентифікатори й текст вимог — у короткі імена та
doc; зв’язки satisfy і verify. - Машини станів — у визначення станів; добре структуровані діяльності — у визначення дій з послідовностями й потоками.
Що потребує переосмислення
- Контекстно-залежні значення. Типи, специфічні для властивості, специфікації екземплярів і перевизначення, зроблені лише для того, щоб задати значення, стають звичайними перевизначеннями у використаннях. Дослівний переклад зберігає обхідне рішення.
- Вимоги лише з текстом. v2 їх дозволяє, але виграш з’являється, коли додано умову. Вирішіть, які вимоги отримають
require constraint. - Блоки обмежень і параметричні діаграми. Вони стають визначеннями обмежень і обчислень, часто записаними як вирази безпосередньо в атрибутах, як
totalMassвище. - Розподіл. Розділи діяльності й зв’язки «allocate» від поведінки до структури стають
performіexhibitтам, де значення — «ця частина робить це». - Старі види портів. Стандартні порти й порти потоку з ранніх моделей v1 потребують найбільше роботи, оскільки v2 має одне поняття порту.
- Профілі й стереотипи. Власні стереотипи й теговані значення стають визначеннями метаданих; їхнє значення доводиться проєктувати заново.
- Діаграми. Компонування не переноситься. Кожна важлива діаграма стає поданням, а її вміст описується заново через
exposeіfilter. - Непрозорі поведінки й скрипти інструментів. Код мовою дій або скриптами інструменту не перекладається; його доводиться переписати або залишити поза моделлю.
Плануйте міграцію як будь-яку зміну моделі: спершу перетворіть показовий пакет, прорецензуйте його з людьми, які користуються моделлю, узгодьте шаблони моделювання для наведених вище пунктів, потім перетворіть решту. Зберігайте модель v1 як еталон, доки модель v2 не пройде рецензування. Перенесення моделі SysML v1 у SysML v2 докладно описує ці кроки.
Як перевіряли лістинги
Кожен лістинг на цій сторінці розібрано й перевірено за допомогою Holarch Language Engine — рушія Редактора SysML v2 у Holarch — із завантаженою стандартною бібліотекою SysML v2, і він не дає ні помилок, ні попереджень. Які конструкції SysML v2 підтримує рушій і які в нього відомі прогалини, див. у покритті мови SysML v2. Довшу опрацьовану модель див. у підручнику з SysML v2.
Спробуйте в Holarch
У Holarch є проєкти SysML v2, де текстова нотація й подання редагують одну модель, і проєкти LML. Щоб прочитати наведені вище лістинги як модель:
- Створіть проєкт SysML v2. Див. початок роботи з проєктами SysML v2.
- У Модель → Редактор натисніть + Новий пакет і вставте лістинг. Текст, що розбирається без помилок, застосовується після короткої паузи, а проблеми позначаються на місці. Див. Редактор.
- Відкрийте список Діаграми, щоб побачити подання. Див. довідник із подань.
Моделі SysML v1. Проєкт SysML v2 безпосередньо імпортує модель SysML 1.x: у Модель → Імпорт і експорт перетягніть файл XMI (з Cameo Systems Modeler або MagicDraw, Enterprise Architect, Rhapsody чи Papyrus) або проєкт Cameo чи MagicDraw .mdzip. Holarch перетворює його на текст SysML v2, перевіряє текст і показує звіт про перетворення, у якому кожен елемент позначено як перетворений, наближений або пропущений, із причиною, ще до будь-яких змін. Компонування діаграм не перетворюється, тож вважайте результат відправною точкою для описаного вище переосмислення, а не завершеною міграцією. Див. імпорт моделей SysML v1.
Проєкти LML також імпортують SysML 1.x XMI і знову експортують модель як SysML 1.6 XMI або як файл Papyrus .uml; файл, відредагований у Papyrus, імпортується назад у той самий проєкт і оновлює елементи на місці за ідентифікатором XMI. Див. імпорт моделі UML/SysML і двосторонній обмін із Papyrus.
Куди далі
- Підручник із SysML v2: покрокова побудова невеликої системи в текстовій нотації.
- Інструменти SysML v2: що перевірити, перш ніж обрати: контрольний список і тестова модель для будь-якого інструменту-кандидата.
- Проєкти SysML v2 у Holarch: текст, подання й інженерні сторінки на одній моделі.
- Покриття мови SysML v2: що підтримує рушій і які в нього відомі прогалини.
- Обмін моделями SysML v2: текст, JSON і репозиторії Systems Modeling API.