Посібник · SysML v2
Перенесення моделі SysML v1 на SysML v2: покрокова міграція
Модель SysML v1 можна перетворити на SysML v2 автоматично, але міграція — це більше, ніж перетворення файлу: хтось має вирішити, як повинна виглядати перетворена модель, і перевірити, що вона досі каже те саме, що й модель v1. Цей посібник проводить міграцію за вісім кроків — від інвентаризації моделі v1 до переходу — з невеликою моделлю, перетвореною й прочитаною рядок за рядком.
На цій сторінці
- Перш ніж почати: переклад, а не оновлення
- 1. Проведіть інвентаризацію моделі v1
- 2. Експортуйте модель з інструмента SysML v1
- 3. Перетворіть пілотний пакет
- 4. Прочитайте звіт про перетворення
- Практичний приклад: невелика модель марсохода
- 5. Доопрацюйте те, що наближено або пропущено
- 6. Відтворіть важливі подання
- 7. Перевірте та прорецензуйте модель v2
- 8. Перетворіть решту й перейдіть
- Контрольний список міграції
- Куди далі
Перш ніж почати: переклад, а не оновлення
SysML v2 — нова мова, а не нова версія формату файлів SysML v1. Блоки стають визначеннями частин, порти типізуються визначеннями портів, вимоги містять умови, а діаграми стають поданнями, які визначає модель. SysML v1 і v2 пояснює відмінності одну за одною.
Конвертер виконує механічну частину: кожен елемент, що має відповідник у SysML v2, записується в SysML v2, а про решту повідомляється. Чого конвертер не може — то це вирішити, як ваша команда хоче використовувати нову мову. Плануйте міграцію як завдання моделювання з відповідальним, рецензуванням і моментом, коли модель v2 стає еталонною.
Цей посібник використовує конвертер Holarch, який імпортує модель SysML 1.x у проєкт SysML v2 і для кожного елемента повідомляє «перетворено», «наближено» або «пропущено». Кроки планування застосовні до будь-якого конвертера.
1. Проведіть інвентаризацію моделі v1
Перш ніж щось експортувати, з’ясуйте, що містить модель і хто від неї залежить. Коротка інвентаризація заощадить доопрацювання згодом.
- Пакети та власники. Перелічіть пакети верхнього рівня, хто підтримує кожен і на які посилаються інші моделі чи документи. Пакети — це одиниця, яку ви перетворюватимете й рецензуватимете.
- Важливі діаграми. Зазначте діаграми, якими люди справді користуються в рецензуваннях і документах. Компонування діаграм не переноситься в SysML v2, тож вони стають поданнями, які ви відтворюєте.
- Профілі та стереотипи. Перелічіть власні стереотипи та їхні теговані значення. Вони стають визначеннями метаданих, і їхнє значення в новій моделі треба погодити знову.
- Поведінка, записана як код. Непрозорі поведінки, умови переходів і обмеження в OCL, мові дій або скриптовій мові інструмента зберігаються як текст мовою оригіналу; їх не перекладають.
- Неіменовані елементи. Зв’язки, що вказують на елементи без імені, неможливо записати в тексті SysML v2, який посилається на елементи за іменем. Назвіть елементи, до яких простежуєте, вже зараз, в інструменті v1.
- Розмір. Holarch перетворює за раз один файл обсягом до 64 MB і до 250,000 елементів. Більші моделі експортують по одному пакету.
2. Експортуйте модель з інструмента SysML v1
Конвертер читає модель з XMI — формату обміну, який записують інструменти SysML v1. Кожен інструмент експортує його трохи по-своєму:
| Інструмент | Що імпортувати |
|---|---|
| Cameo Systems Modeler, MagicDraw | Файл проєкту .mdzip або File → Export To → Eclipse UML2 (v5.x) XMI File і файл .xmi |
| Enterprise Architect | Виберіть пакет, Publish → Export XML, виберіть XMI 2.1 та імпортуйте файл .xml. Файли проєктів (.eap, .qea) безпосередньо не читаються. |
| IBM Rhapsody | Експорт XMI 2.x з набору інструментів XMI |
| Eclipse Papyrus | Файл моделі .uml |
Зберігайте експортований файл разом із записами міграції: це точні вхідні дані v1, на які посилається ваше рецензування.
3. Перетворіть пілотний пакет
Почніть з одного пакета, репрезентативного, але не найбільшого: підсистеми зі структурою, інтерфейсами, певною поведінкою та її вимогами. Пілот показує, як виглядає перетворення вашої моделі, перш ніж ви залучите до нього всю команду.
- Створіть проєкт SysML v2 або відкрийте той, у який має потрапити перетворена модель, і клацніть Модель → Імпорт і експорт.
- У розділі Імпорт виберіть У новий проєкт SysML v2 для пілота, щоб нічого іншого не зачепити.
- Перетягніть експортований файл на поле. Картка поступу показує етапи: читання файлу XMI, перетворення на SysML v2, перевірка результату.
Поки що нічого не імпортовано. Наступний екран — попередній перегляд зі звітом про перетворення.
4. Прочитайте звіт про перетворення
Перетворення з SysML v1 угорі попереднього перегляду показує кількість перетворених, наближених і пропущених елементів, а також чи перевіряється текст SysML v2 без проблем. Кожен елемент моделі v1 має один результат:
- Перетворено: елемент має прямий відповідник у SysML v2, як-от блок, що стає
part def. - Наближено: елемент збережено в зміненій формі, наприклад перехід через вибір, що стає окремим переходом для кожного шляху. Це місця, де значення може відрізнятися від моделі v1.
- Пропущено: SysML v2 не має відповідника, або елемент вказує на щось, чого немає у файлі.
Скористайтеся Показати, щоб перелічити наближені та пропущені елементи. Кожен рядок наводить елемент, його вид у SysML v1, на що він перетворився з іменем у SysML v2, і причину. Відкрийте Показати текст SysML v2, щоб прочитати результат, і клацніть Завантажити звіт, щоб зберегти звіт як файл CSV. CSV — це робочий список для кроку 5: відсортуйте його за причиною й призначте кожній групі відповідального.
Практичний приклад: невелика модель марсохода
Невелика модель SysML v1 тракту живлення планетного марсохода у трьох пакетах:
| Пакет | Елементи SysML v1 |
|---|---|
| Types | Тип значення Power з одиницею W; блок Charge; інтерфейсний блок Power Interface із двома вихідними властивостями потоку, charge (типу Charge) і voltage (типу Real) |
| Структура | Інкапсульований блок Rover із властивостями частин battery і computer, властивістю значення power budget 120 W, з’єднувачем power bus між їхніми портами та потоком елементів power flow типу Charge на ньому. Блок Battery з проксі-портом out; блок Computer зі спряженим проксі-портом in і повним портом raw. Обидва мають користувацький стереотип «Hardware» з тегованими значеннями. Асоціація, кінець якої належить самій асоціації. |
| Вимоги | Вимоги R-1 Mission і R-2 Power Margin; R-2 виведено з R-1; R-2 задовольняє частина battery; простеження від Computer до Battery |
Після перетворення вона виглядає так. Лістинг — це вихідні дані конвертера без змін:
package 'Rover Model' {
package Types {
attribute def Power :> ISQ::PowerValue;
part def Charge;
port def 'Power Interface' {
out item charge : Charge;
out attribute voltage : ScalarValues::Real;
}
}
package Structure {
part def Rover {
doc /* Six-wheeled science rover. */
@SysMLv1Library::BlockData { isEncapsulated = true; }
part battery : Battery;
part computer : Computer;
attribute 'power budget' : Types::Power = 120 [SI::W];
connection 'power bus' connect battery.'out' to computer.'in';
satisfy Requirements::'Power Margin' by battery;
flow 'power flow' of Types::Charge from battery.'out' to computer.'in';
}
part def Battery {
@'SysML v1 Profiles'::rov::Hardware { qualified = "true"; vendor = "Acme Cells"; }
port 'out' : Types::'Power Interface';
attribute capacity : Types::Power;
}
part def Computer {
@'SysML v1 Profiles'::rov::Hardware { vendor = "Orbital Logic"; }
port 'in' : ~Types::'Power Interface';
part raw : Types::Charge {
@SysMLv1Library::PortData { isFullPort = true; }
}
}
}
package Requirements {
requirement <'R-1'> Mission {
doc /* The rover shall explore the landing site. */
}
requirement <'R-2'> 'Power Margin' {
doc /* Keep a 50 % power margin. */
}
connection : DerivationConnections::Derivation connect 'Power Margin' to Mission;
dependency from Structure::Computer to Structure::Battery {
@SysMLv1Library::TraceData { isTrace = true; }
}
}
}
package 'SysML v1 Profiles' {
package rov {
metadata def Hardware {
attribute qualified : ScalarValues::String;
attribute vendor : ScalarValues::String;
}
}
}
Що сталося з кожною частиною моделі v1:
- Тип значення з одиницею. Power у ватах спеціалізує
ISQ::PowerValueзі стандартної бібліотеки, а значення за замовчуванням записується з одиницею:120 [SI::W]. Тип значення, одиниця якого не є зіставленою одиницею SI, лишається дійсним числом з одиницею в документації, і про нього повідомляється як про наближений. - Блоки та властивості. Блоки стають
part def, а властивості частин —part. Для isEncapsulated блока немає ключового слова SysML v2, тож його збережено як метаданіSysMLv1Library::BlockData. - Інтерфейсний блок і порти. Інтерфейсний блок стає
port def, властивості потоку якого — спрямовані ознаки:out itemдля типізованої блоком,out attributeдля значення. Спряжений проксі-порт має тип~Types::'Power Interface'. Повний порт стає частиною з метаданимиSysMLv1Library::PortData, бо порт SysML v2 типізується визначенням порту. - З’єднувач і потік елементів. З’єднувач стає
connectionміж двома портами, а потік елементів на ньому —flowтипу Charge між тими самими портами. - Вимоги. Кожна вимога зберігає свій ідентифікатор як коротке ім’я,
<'R-1'>, а текст — якdoc. Зв’язок satisfy розміщується в блоці, якому належить частина, що задовольняє; зв’язок derive стає з’єднанням виведення; простеження стає залежністю зSysMLv1Library::TraceData. - Користувацький стереотип. «Hardware» стає
metadata defу пакеті'SysML v1 Profiles', застосованим до кожного блока з тегованими значеннями. Про два його застосування повідомляється як про наближені: значення тегів стали текстовими атрибутами незалежно від того, якого типу вони були в профілі. - Асоціація. Асоціація без класу тут не має відповідника в SysML v2, і її кінець, що належить асоціації, теж не перетворюється. Про обидва повідомляється як про пропущені; структуру несуть властивості в блоках.
Звіт для цієї моделі: 31 елемент, 27 перетворено, 2 наближено, 2 пропущено, і текст перевіряється без помилок і попереджень. Імена, що не є простими ідентифікаторами, як-от 'power budget' чи 'out' (ключове слово SysML v2), беруться в лапки, щоб зберегти написання з v1.
5. Доопрацюйте те, що наближено або пропущено
Пройдіться наближеними та пропущеними рядками звіту за причинами. Більшість причин вимагають одного з кількох рішень:
| Що каже звіт | Що вирішити |
|---|---|
| Порт типізовано блоком, який не є інтерфейсним; він став портом без типу | Визначте визначення порту з ознаками, що перетинають межу, і типізуйте ним порт. |
| Переходи через вибір, вузол з’єднання, розгалуження чи злиття; кожен шлях став окремим переходом | Перевірте, що об’єднані умови досі кажуть те, що мала на увазі діаграма v1; спростіть там, де шляхи тепер легше читати. |
| Тригер збережено як документацію | Перепишіть тригери змін і часу як тригери SysML v2, де значення зрозуміле, як-от accept after тривалості. |
| Одиниця не є одиницею SI, яку зіставляє Holarch; тип значення — дійсне число | Вирішіть, чи підходить стандартна величина, або лишіть дійсне число й задокументовану одиницю. |
| Дія іншого виду, ніж дія виклику, непрозора дія чи дія прийняття, стала звичайною дією | Перепишіть надсилання та інші конкретні дії відповідною дією SysML v2, що робить те саме. |
| Розділи діяльності не перетворюються | Вкажіть, яка частина що робить, за допомогою perform у частині замість доріжки. |
| Він вказує на елемент без імені | Назвіть ціль в інструменті v1 і перетворіть знову або додайте зв’язок у моделі v2. |
| Його ім’я використано двічі в тому самому місці; перейменовано із суфіксом | Дайте кожному елементу ім’я, яке каже, що він таке. |
| Теговані значення стали текстовими атрибутами метаданих | Задайте атрибутам метаданих потрібні типи й погодьте, що тепер означає кожен стереотип. |
Два види тексту потребують перегляду, навіть якщо перетворилися чисто. Непрозорі тіла зберігаються як текстові представлення мовою оригіналу, як-от language "OCL" /* … */; Holarch перевіряє лише тіла, написані на SysML або KerML, тож перепишіть умову чи обмеження як вираз SysML там, де модель має його обчислювати. А дослівні переклади зберігають обхідні рішення v1, як-от типи для конкретної властивості, створені лише для задання значення: у SysML v2 це звичайні перевизначення на використаннях. Що потребує переосмислення перелічує поширені випадки.
6. Відтворіть важливі подання
Діаграми та їхнє компонування не перетворюються. Візьміть список діаграм із кроку 1 і створіть подання для кожної, яка досі потрібна: загальне подання для структури й вимог, подання взаємоз’єднань для частин і з’єднань, подання потоку дій для діяльностей, подання переходів станів для автоматів станів. Відтворюйте лише те, чим користуються люди; решту модель однаково зберігає. Див. довідник з подань.
7. Перевірте та прорецензуйте модель v2
- Текст перевіряється без проблем. Імпорт показує перевірку перетвореного тексту, перш ніж щось зміниться; після доопрацювання Редактор позначає нові проблеми під час введення.
- Кількості збігаються. Порівняйте кілька чисел між моделлю v1 і моделлю v2: вимоги, частини, порти, з’єднання, зв’язки верифікації. Різниця, яку неможливо пояснити зі звіту, варта уваги.
- Модель рецензують ті, хто нею користується. Пройдіться пілотним пакетом із його власниками, починаючи з наближених елементів і відтворених подань.
- Записуйте рішення. Запишіть шаблони моделювання, на яких ви зупинилися для портів, тригерів, одиниць і стереотипів, щоб решта міграції їх дотримувалася.
8. Перетворіть решту й перейдіть
Перетворюйте решту пакетів по одному в той самий проєкт SysML v2. Кожен імпорт показує той самий попередній перегляд: пакет, що вже є в проєкті, позначено як Змінено або Без змін, новий — як Новий, і ви вибираєте, які пакети імпортувати. Кожен імпорт — один крок відміни.
Тримайте модель v1 як еталонну, доки модель v2 не прорецензовано, потім заморозьте її й зробіть проєкт SysML v2 офіційною моделлю. Відтоді зміни вносяться лише в модель v2.
Контрольний список міграції
- Пакети, власників і важливі діаграми перелічено.
- Елементи, на які вказують зв’язки, мають імена.
- Експортований файл XMI збережено разом із записами міграції.
- Пілотний пакет перетворено, його звіт завантажено, і для кожного наближеного та пропущеного рядка ухвалено рішення.
- Шаблони моделювання для портів, тригерів, одиниць і стереотипів записано.
- Потрібні подання відтворено; текст перевіряється без проблем.
- Користувачі моделі прорецензували пілот.
- Решту пакетів перетворено так само, а модель v1 заморожено.
Куди далі
- SysML v1 на SysML v2 у Holarch: що конвертер читає й записує, і приклад CubeSat EO-1.
- Імпорт моделей SysML v1: кожен крок, зіставлення, обмеження й повідомлення в Docs.
- SysML v1 і v2: чим відрізняються дві мови.
- Підручник SysML v2: побудуйте модель у текстовій нотації.
- Покриття мови SysML v2: що підтримують проєкти SysML v2 і відомі прогалини.
Cameo Systems Modeler, MagicDraw, Enterprise Architect, Rhapsody і Eclipse Papyrus є товарними знаками відповідних власників. Holarch не пов’язаний з ними і не схвалений ними.