SysML v2
Текстова нотація SysML v2
Мова SysML v2 у тому обсязі, який підтримує Holarch, з прикладами з демопроєкту Hybrid Car, перевірками, які вона виконує, і Стандартною бібліотекою лише для читання.
На цій сторінці
- Огляд
- Поняття
- Елементи, власники та кваліфіковані назви
- Пакети
- Імпорти та видимість
- Визначення та використання
- Типізація, спеціалізація та перевизначення
- Кратності
- Значення та одиниці
- Структура: порти, з’єднання, інтерфейси, прив’язки та потоки
- Поведінка: дії
- Поведінка: стани
- Вимоги, обмеження та верифікація
- Варіанти використання
- Подання
- Коментарі, документація та метадані
- Екземпляри, знімки та часові зрізи
- Варіації, варіанти та конфігурації
- Текстові представлення
- Як користуватися
- Приклад: читання вимоги до седана
- Поради та поширені помилки
- Що підтримує Holarch
- Перевірки
- Стандартна бібліотека
- Обмеження
- Пов’язані сторінки
Огляд
SysML v2 описує систему як дерево іменованих елементів, записане текстом. Holarch підтримує текстову нотацію SysML v2 на основі специфікації OMG SysML v2. Ви пишете текст у Редакторі, а Holarch показує ті самі елементи в Оглядачі, поданнях, таблицях і на сторінках життєвого циклу.
Ця сторінка навчає нотації на прикладах із демопроєкту Hybrid Car (SysML v2). Далі вона перелічує, що підтримує Holarch, перевірки, які він виконує для вашого тексту, і Стандартна бібліотека.
Поняття
Елементи, власники та кваліфіковані назви
Кожен елемент має одного власника, крім пакетів верхнього рівня. Кваліфікована назва елемента — це ланцюжок назв його власників, з’єднаних ::. У демопроєкті батарея визначення силової установки — це Vehicles::Powertrain::battery.
Назву з пробілами або іншими спеціальними символами беруть в одинарні лапки: 'Fuel Tank'. Коротка назва в кутових дужках дає елементу другий, короткий ідентифікатор: requirement def <'VR-1'> CurbMass. Holarch використовує коротку назву вимоги як її номер.
Пакети
Пакет групує елементи, як папка. Пакети можна вкладати. Кожен пакет верхнього рівня — це один документ у Редакторі.
package Vehicles {
doc /* A hybrid passenger car: structure, interfaces and variants. */
private import ScalarValues::*;
private import ISQ::*;
private import SI::*;
}
Імпорти та видимість
Імпорт робить члени іншого пакета видимими за їхніми короткими назвами.
import ISQ::*;імпортує члениISQ.import VehicleRequirements::**;імпортує також члени вкладених елементів (рекурсивно).import Vehicles::Car;імпортує один елемент.import Vehicles::*[@SysML::PartDefinition];імпортує лише члени одного виду (фільтрований імпорт).
private, protected і public визначають, хто ще бачить член або імпорт. Демопроєкт пише private import, щоб імпорти не передавалися далі пакетам, які, своєю чергою, імпортують цей пакет.
Без імпорту пишіть кваліфіковану назву: ISQ::MassValue розпізнається будь-де, MassValue — лише там, де імпортовано ISQ.
alias дає елементу другу назву: alias Hybrid for Car;.
Визначення та використання
Визначення описує вид речі. Використання — це одне застосування визначення всередині іншого елемента. Більшість ключових слів має обидві форми:
| Визначення | Використання | Що це |
|---|---|---|
part def Battery; | part battery : Battery; | Система, підсистема або компонент |
attribute def TirePressure; | attribute mass : MassValue = 45 [kg]; | Значення, часто з одиницями |
item def Fuel; | item fuel : Fuel; | Щось, що протікає або обробляється |
port def FuelPort { … } | port fuelOut : FuelPort; | Точка з’єднання на частині |
connection def … / interface def FuelLine { … } | interface fuel : FuelLine connect …; | Зв’язок між частинами або портами |
action def ProduceTorque { … } | action produce : ProduceTorque; | Поведінка: крок, що приймає входи й дає виходи |
state def PowertrainStates { … } | state off; | Поведінка: стан і його переходи |
constraint def MassLimit { … } | constraint …; | Булева умова над значеннями |
calc def PowerToWeight { … } | calc …; | Обчислення зі значенням return |
requirement def <'VR-1'> CurbMass { … } | requirement <'VR-1.1'> sedanMass : CurbMass; | Вимога |
use case def DriveToWork { … } | use case commute : DriveToWork; | Варіант використання |
analysis def PowerToWeightAnalysis { … } | analysis sedanPowerToWeight : …; | Випадок аналізу |
verification def CurbMassTest { … } | verification sedanWeighing : CurbMassTest; | Випадок верифікації |
view def RequirementsView { … } | view driveCycleFlow : ActionFlowView { … } | Подання моделі |
enum def DriveMode { … } | attribute mode : DriveMode; | Фіксований набір значень |
Члени, вкладені у визначення, належать кожному його використанню. part frontAxle : Axle; має differential, leftWheel і rightWheel від Axle без їх повторення.
Типізація, спеціалізація та перевизначення
Чотири оператори пов’язують визначення й використання. Кожен має також форму ключового слова.
| Оператор | Ключове слово | Значення | Приклад |
|---|---|---|---|
: | defined by | Типізує використання визначенням | part engine : Engine; |
:> на визначенні | specializes | Визначення є різновидом іншого й успадковує його члени | part def FuelTank :> Component |
:> на використанні | subsets | Використання є підмножиною іншого використання | part spareWheel :> wheels; |
:>> | redefines | Замінює успадковане використання, наприклад щоб задати йому значення | attribute redefines mass = 18 [kg]; |
~ | Спрягає порт: його властивості in і out міняються місцями | port fuelIn : ~FuelPort; |
Перевизначення — це спосіб, у який варіант або сконфігурована частина змінює те, що успадковує. У демопроєкті SportCar перевизначенням прибирає запасне колесо:
part def SportCar :> Car {
attribute topSpeed : SpeedValue = 210 [km/h];
part redefines spare [0];
}
abstract позначає визначення, яке не має прямих екземплярів (abstract part def Component). ref позначає посилання, яке не є власністю. in, out і inout задають напрямок властивості або параметра. end позначає кінці визначення з’єднання або інтерфейсу.
Кратності
Кратність у квадратних дужках указує, скільки їх є.
[2]: рівно дві.part runabout : CityCar [2];[0..1]: необов’язковий.part spare : Wheel [0..1];[1..*]і[*]: один або більше, будь-яка кількість.[0]: жодного; використовується, щоб прибрати успадковану частину.- Межі можуть бути виразами.
orderedіnonuniqueідуть після дужок.
Значення та одиниці
= прив’язує значення. := задає початкове значення, яке може змінюватися. default задає значення за замовчуванням, яке перевизначення може замінити.
attribute maxCurbMass : MassValue = 1650 [kg];
attribute minBatteryCapacity : EnergyValue = 1.2 [kW*h];
attribute minPowerToWeight = 40 [W/kg];
attribute topSpeed : SpeedValue = 210 [km/h];
Величина — це число з одиницею у квадратних дужках. Одиниці поєднуються за допомогою *, / і ^ ([m/s^2]). Види величин, як-от MassValue, походять з ISQ, а одиниці, як-от kg, — з SI (або USCustomaryUnits). Holarch перевіряє розмірності: присвоєння 5 [s] значенню MassValue є помилкою.
Вирази використовують арифметику, порівняння (<=, ==), логічні оператори (and, or, not, implies), умовний вираз if c ? a else b, ланцюжки властивостей (car.powertrain.battery.capacity), виклики обчислень (PowerToWeight(power, mass)) і операції над послідовностями, як-от ->sum, ->size, ->select і ->collect. Holarch обчислює їх з одиницями для значень, обмежень, подань і сторінок аналізу.
Структура: порти, з’єднання, інтерфейси, прив’язки та потоки
Частини з’єднуються через свої порти.
part def Powertrain {
part tank : FuelTank;
part engine : Engine;
interface fuel : FuelLine connect tank.fuelOut to engine.fuelIn;
connect controller.engineCtl to engine.ecu;
port output : TorquePort;
bind output = transmission.output;
}
connect a to b;з’єднує дві частини або порти.- Інтерфейс — це типізоване з’єднання між портами. Його визначення називає кінці:
interface def FuelLine { end supply : FuelPort; end consumer : ~FuelPort; }. - Кожен кінець з’єднання або інтерфейсу може мати назву і кратність:
interface motorShaft : Shaft connect [1] driver ::> motor.output to [1] driven ::> transmission.motorIn;. Іменований кінець — це властивість з’єднання, тожmotorShaft.driverпосилається на нього. bind a = b;указує, що дві властивості однакові (зв’язувальний з’єднувач).flow of Fuel from supply.fuel to produce.fuel;переносить предмет від однієї властивості до іншої.messageнадсилає предмет між частинами як подію.
Поведінка: дії
Визначення дії містить свої кроки (використання дій), параметри й порядок кроків.
action def DriveCycle {
in attribute targetSpeed : Real;
first start then switchOn;
action switchOn { attribute duration : DurationValue = 2 [s]; }
then fork split;
then supply;
then produce;
action supply : SupplyFuel;
action produce : ProduceTorque;
flow of Fuel from supply.fuel to produce.fuel;
first supply then ready;
first produce then ready;
join ready;
}
- Послідовності впорядковують кроки:
first a then b;абоthen b;одразу післяa.startіdone— це початок і кінець. - Вузли керування:
forkіjoinдля паралельних шляхів;decideіmergeдля альтернатив. Послідовність з умовою після рішення має виглядif speed > 30 then cruise;, аelse brake;— гілка за замовчуванням. - Завершення:
terminate;одразу завершує охопну дію разом з усіма її кроками, які ще виконуються;then terminate;ставить його після попереднього кроку.terminate x;завершує входженняx. - Інші дії:
acceptчекає на сигнал,sendнадсилає його,assign x := expr;змінює значення,ifвиконує блок або пропускає його,while … { … } until …;іfor v in seq { … }повторюють блок. - Розподіл поведінки: частина виконує дію через
perform(perform action trip : DriveCycle;,perform trip.supply;), аallocate a to b;розподіляє один елемент на інший.
Поведінка: стани
Визначення стану містить стани й переходи між ними.
state def PowertrainStates {
entry; then off;
state off;
accept StartRequest then hybrid;
state hybrid {
entry action startEngine;
do action driveHybrid;
exit action stopEngine;
}
transition recharged first hybrid if charge > 60 then electric;
}
entry; then off;задає початковий стан.- Переходи мають тригер (
accept StartRequest), необов’язкову умову (if charge > 20) і необов’язковий ефект (do …). Коротка форма йде після вихідного стану; довга форма —transition name first a … then b;. - У моделі тригер і ефект переходу — окремі елементи: дія прийому (accept) і дія (
send,assign,perform,terminateабо іменована дія). Оглядач показує їх як trigger і effect під переходом. Це власніaccepterіeffectпереходу, тож інші частини моделі можуть називати їх:chargerStates.plugIn.effect.sentMessage— це повідомлення, яке надсилає ефект, так, як його прив’язує модель послідовності. - Тригер через порт має приймати те, що переносить порт: у
ChargeManagerдемопроєктуaccept connectCharger : ChargerConnected via chargePortвідповідаєin connected : ChargerConnectedпорту. Ефектsend new ChargeRequest() to controllerнадсилає повідомлення частині; значення, як-от атрибут, не може отримати повідомлення. - Дії
entry,doіexitвиконуються під час входу в стан, перебування в ньому й виходу з нього. Станиparallelмають області, які активні одночасно. - Частина проявляє стан через
exhibit:exhibit state powertrainStates : PowertrainStates;.
Вимоги, обмеження та верифікація
Вимога містить своє формулювання в doc, елемент, до якого вона застосовується, як subject, а умову, яку можна перевірити, як require constraint.
requirement def <'VR-1'> CurbMass {
doc /* The car's curb mass shall not exceed the mass limit. */
subject car : Car;
attribute limit : MassValue;
require constraint { car.curbMass <= limit }
}
satisfy carSpec by fleet.sedan;
assume constraintзадає умову, яку вимога припускає. Якщо вона не виконується, ця вимога та вкладені в неї вимоги вважаються виконаними; охопна вимога та інші вкладені вимоги все одно перевіряються.actor,stakeholderіframe concernназивають, для кого й для чого призначено вимогу.satisfy R by part;указує, що частина виконує вимогу.- Випадок верифікації верифікує вимоги у своїй цілі:
objective { verify carSpec.sedanMass; }. Він може матиreturn verdict : Boolean = …;. - Випадок аналізу має суб’єкт, ціль і результат
return, який Holarch обчислює, коли кожен вхід має значення. Атрибути випадку без значення розв’язуються з рівнянь==його цілі (Випадки аналізу з невідомими). connection : Derivation connect original to derived;фіксує похідну вимогу.#refinement dependency x to R;фіксує уточнення.dependency from a to b;фіксує загальний слід простежуваності.
Варіанти використання
use case def DriveToWork { subject car : Car; actor driver : Driver; objective { … } include use case startCar : StartCar; }. Використання варіанта використання бере суб’єкт і акторів свого визначення.
Подання
Подання показує частину моделі. Воно типізоване стандартним визначенням подання й через expose відкриває те, що показує:
view driveCycleFlow : StandardViewDefinitions::ActionFlowView {
expose DriveCycle;
}
filter звужує елементи (filter @SysML::RequirementUsage;). render вибирає спосіб відображення. viewpoint окреслює інтереси, які подання має врахувати. Подання SysML v2 пояснює кожен вид подання.
Коментарі, документація та метадані
doc /* text */документує свого власника. Він є частиною моделі; для вимоги це текст вимоги.comment about x /* text */— примітка в моделі про інший елемент.// textі//* text */— примітки лише в тексті. Holarch зберігає їх у тексті, але вони не є елементами моделі.- Метадані анотують елемент:
@TBD { owner = "Powertrain lead"; }у тілі,#TBR attribute limit …як префікс абоmetadata Capability about Vehicles::Car;ззовні. - Ключові слова користувача: будь-яке визначення метаданих працює як ключове слово:
#safetyCritical part controller : Controller;позначає контролер метаданимиSafetyCritical(коротка назва<safetyCritical>). Визначення метаданих може обмежувати, що воно позначає::>> annotatedElement : SysML::PartDefinition;дозволяє лише визначення частин. - Семантичні метадані: визначення метаданих, яке спеціалізує
SemanticMetadata, задає базовий тип,:>> baseType = faults meta SysML::Usage;. Кожен позначений ним елемент тоді спеціалізує базовий: використання є підмножиною базового використання, визначення спеціалізує базове визначення або визначення базового використання. Тож#fault def BatteryOverheat;і#fault overheat : BatteryOverheat;є несправностями й мають властивостіFault. Із семантичними метаданими ключове слово мови можна пропустити, як у цих двох рядках; Оглядач показує їх із ключовим словом (#fault def). Запис ззовні,metadata Fault about x;, не робитьxнесправністю: перевірка попереджає й пропонує позначити самxчерез#fault. - Метадані з власним значенням: властивості визначення метаданих — це те, що має вказати кожне його застосування, і його обмеження мають для них виконуватися. З
metadata def SafetyRating { attribute level : Natural; assert constraint { level >= 1 and level <= 4 } }перевірка повідомляє про@SafetyRating;(немає рівня) і@SafetyRating { level = 7; }(поза діапазоном);@SafetyRating { level = 4; }правильне. Властивість зі значенням абоdefaultу визначенні чи оголошену як[0..1]можна пропустити. Кожне значення має відповідати типу своєї властивості:trueабоfalseдля Boolean, текст у лапках для String, ціле число для Integer (0 або більше для Natural, більше за 0 для Positive), а для переліку — одне з його значень, як-отHazardAnalysis::fmea; перевірка повідомляє про будь-яке інше значення, а також про значення за замовчуванням у визначенні, яке не підходить. Тіло метаданих лише задає значення властивостям визначення (level = 4;), аabstract metadata defзастосувати не можна. Демопроєкт Hybrid Car оцінює свій контролер як@SafetyRating { level = 4; }і записує рецензування батареї як@SafetyReview { method = HazardAnalysis::fmea; closed = true; }. У Редакторі Вставити ▾ → Визначення метаданих починає визначення з властивістю й правилом, а Застосувати метадані застосовує їх усередині тіла. Без написання тексту: виберіть визначення або використання й скористайтеся розділом Метадані в інспекторі. Додати метадані застосовує одне з визначень метаданих проєкту; кожна властивість тоді отримує поле (список значень для переліку або Boolean, звичайний текст для String, який Holarch бере в лапки; значення за замовчуванням із визначення показується як підказка, а властивість без нього позначено як обов’язкову); зауваження перевірки щодо цих метаданих показуються під ними; Вилучити знімає їх. Кожна зміна відміняється одним натисканням “Відмінити”. Метадані зі стандартної бібліотеки та власні метадані Holarch (симуляція, цілі, варіативність) мають власні елементи керування й там не перелічуються.
Екземпляри, знімки та часові зрізи
Індивід — це одна конкретна річ протягом усього її життя, наприклад один автомобіль із серійним номером, а не вид речей. Знімок — це ця річ в один момент часу; часовий зріз — період її життя. Обидва належать входженню, якому підпорядковані, і мають його властивості, тож можуть задавати цим властивостям власні значення.
individual part def Car_VIN1234 :> Car {
snapshot atDelivery { attribute :>> mileage = 0 [km]; }
timeslice firstOwner { attribute ownerName : String = "Dana Reyes"; }
snapshot atService { attribute :>> mileage = 15000 [km]; }
first atDelivery then atService;
assert constraint mileageGrows { atDelivery.mileage <= atService.mileage }
}
individualстоїть перед ключовим словом виду (individual part def,individual item def) або окремо (individual def Plate_77;). Використання, записане якindividual, типізоване рівно одним визначенням індивіда:individual car1 : Car_VIN1234;.snapshotіtimesliceстоять перед ключовим словом виду або окремо, усередині частини, предмета, дії чи іншого входження.then timeslice secondOwner;ставить часовий зріз після члена перед ним.- Значення всередині знімка або часового зрізу спершу читається там, потім з індивіда, потім з його визначення. У прикладі
atService.mileageстановить 15,000 km, і обмеження виконується. - Індивідами, знімками або часовими зрізами можуть бути лише входження: атрибути й переліки є значеннями.
- В Архітектура → Частини, у поданнях “База даних” і “Сітка”, стовпець Екземпляри перелічує індивіди визначення кожної частини (для
part sedan : Car:Car_VIN1234): визначення індивідів, які його спеціалізують, і використання індивідів, які воно типізує. Індивід (Так) і Частка (portion) (Знімок або Часовий зріз) теж є стовпцями (Стовпці ▾ → SysML v2). Сторінка “Частини” показує Екземпляри за замовчуванням, щойно модель має індивід, і тоді експорт Table (CSV) містить ці три стовпці; експорт Визначення перелічує їх для кожного елемента, який їх має. - В інспекторі Подія (occurrence) у розділі “Властивості” задає Індивід, а для використань — Увесь життєвий цикл, Часовий зріз або Знімок. Фільтр видів в Оглядачі має Індивіди, а меню ⋯ рядка має Новий знімок… і Новий часовий зріз…. Загальне подання показує «individual part def», «snapshot» і «timeslice» у заголовках блоків, перелічує знімки й часові зрізи блоку в окремому відділенні й малює послідовності між блоками пунктирними стрілками; Упорядкувати ▾ → Упорядкувати як часову шкалу вишиковує їх зліва направо. У демопроєкті Hybrid Car Загальне подання
carLifelineпоказує знімки й часовий зрізCar_VIN1234.
Варіації, варіанти та конфігурації
Варіація перелічує варіанти вибору, дозволені в одній точці проєкту; кожен варіант вибору — це варіант. Визначення варіації (variation part def) — це багаторазовий набір варіантів вибору; використання варіації (variation part charger) — точка всередині одного проєкту. Конфігурація вибирає один варіант для кожної точки.
variation part def BatteryPack :> Battery {
variant part standardPack { attribute :>> capacity = 1.4 [kW*h]; }
variant part largePack { attribute :>> capacity = 12 [kW*h]; }
}
part def CarLine :> Car {
part pack : BatteryPack;
variation part charger : Component {
variant part noCharger;
variant part wallbox;
}
assert constraint wallboxNeedsLargePack { charger == charger::wallbox implies pack == BatteryPack::largePack }
}
part plugInHybrid : CarLine {
@HolarchConfiguration;
part :>> pack = BatteryPack::largePack;
part :>> charger = charger::wallbox;
}
- Варіант має властивості своєї варіації й може їх перевизначати:
largePackмаєcapacity, боBatteryPackєBattery. variant x;без ключового слова виду робить наявне використанняxодним із варіантів вибору; його названо заx.- Варіація містить лише варіанти (а також визначення, коментарі, метадані та імпорти). Варіація вже абстрактна, тож
abstractна ній позначається як зайве. - Виберіть варіант значенням:
part :>> pack = BatteryPack::largePack;. Вибір, який не є варіантом цієї точки, — помилка. - Поки точку не вибрано, її значення невідоме, тож твердження щодо неї ані виконується, ані порушується. У конфігурації використовуються значення вибраних варіантів.
- Позначте конфігурацію через
@HolarchConfiguration(пакетHolarchVariability, у Стандартній бібліотеці в розділі Holarch): тоді Редактор зазначає кожну точку, яку ще не вибрано. - У Редакторі Вставити ▾ записує кожну з цих конструкцій: Варіація (визначення на рівні пакета, точка всередині частини), Варіант (усередині варіації), Конфігурація і Вибір варіанта (усередині конфігурації).
- У демопроєкті Hybrid Car
CarLineмає дві точки (packіcharger), аselfChargingHybridіplugInHybrid— її конфігурації; твердження виключає wallbox зі стандартним блоком батарей.
Текстові представлення
Текстове представлення записує елемент іншою мовою: rep language "Python" /* … */ у тілі елемента. Тіло зберігається як текст. Модель — це те, що оголошує SysML навколо нього; Holarch ніколи не виконує тіло.
- У демопроєкті Hybrid Car
DriveWheelsмістить своє обчислення мовою Python:rep language "Python" /* wheel_speed = torque.value * GEAR_RATIOS[gear] / WHEEL_RADIUS */. - Тіло мовою
"sysml"або"kerml"перевіряється.SpeedLimitзаписано якrep language "sysml" /* speed <= limit */, і Holarch обчислює його як обмеження, записане безпосередньо. - Редактор підсвічує тіла SysML і KerML як код на тонованому тлі. Інші мови показуються як текст коментаря.
- Розділ Представлення в інспекторі перелічує кожне представлення з його Мова і тілом. Натисніть Додати подання на визначенні або використанні, щоб додати його, і Вилучити, щоб видалити.
- Подання Action Flow позначає дію, визначення якої має представлення, назвою його мови у фігурних дужках, наприклад {Python}.
- Відомі мови: SysML, KerML, OCL, Alf, Python, JavaScript, MATLAB, Modelica, C, природна мова (
naturalLanguage,English,text). Версія після назви ігнорується (OCL2.0,Python 3). - Тіло не може містити
*/, бо це завершило б коментар.
Власні коментарі обговорень Holarch, мітки, виконавці й терміни зберігаються поруч із моделлю. У текст вони не записуються.
Як користуватися
Змоделювати структуру
- У Редакторі відкрийте пакет (або натисніть + Новий пакет).
- Напишіть
port defдля кожного виду точки з’єднання зі спрямованими властивостями (out attribute torque : TorqueValue;). - Напишіть
part defдля кожного виду компонента з його атрибутами й портами. - Напишіть
part defдля збірки зpartдля кожного компонента. - З’єднайте частини:
connect a.p to b.q;абоinterface name : Def connect a.p to b.q;. - Зробіть паузу. Рядок стану показує Застосовано, а Оглядач показує нові елементи.
Вставити ▾ (або ⌃⇧Space / Ctrl+Shift+Space) записує кожну з цих конструкцій за вас, з полями для заповнення. Див. Вставлення конструкції.
Задати значення з одиницями
- Імпортуйте види величин і одиниці на початку пакета:
private import ISQ::*;іprivate import SI::*;. - Типізуйте атрибут видом величини й задайте значення:
attribute mass : MassValue = 45 [kg];. - У визначенні, яке успадковує атрибут, перевизначте його власним значенням:
attribute redefines mass = 18 [kg];. - Наведіть вказівник на значення. Якщо одиниця не відповідає виду величини, з’являється картка помилки.
Описати поведінку
- Напишіть
action defз параметрамиinіout. - Додайте крок для кожного використання
actionі впорядкуйте їх черезfirst … then …;абоthen. - Використовуйте
forkіjoinдля паралельних кроків,decideіmerge— для альтернатив. - Додайте
flow of Item from a.out to b.in;між кроками, які передають предмети. - У частині, яка виконує поведінку, напишіть
perform action name : Def;, а в її частинах —perform name.step;. - Відкрийте дію в Поданні Action Flow, щоб побачити її намальованою (див. Подання SysML v2).
Написати вимогу й простежити її
- Напишіть
requirement <'ID'> name { doc /* The system shall … */ subject s : Def; }. - Додайте
require constraint { … }, коли вимогу можна перевірити за значеннями. - Напишіть
satisfy name by somePart;там, де проєкт її виконує. - Напишіть
verification, ціль якого верифікує її черезverify. - Відкрийте Потреби та вимоги → Вимоги: вимогу наведено з її номером, а Верифікація → RVTM показує, як її верифіковано. Див. Вимоги та верифікація в проєктах SysML v2.
Позначити значення як TBD або TBR
Запис TBD замість значення не є коректним SysML. Натомість використовуйте метадані Holarch.
- Імпортуйте їх:
private import HolarchMetadata::*;. - Додайте префікс до атрибута:
#TBD attribute chargerPower : PowerValue;(значення ще немає) або#TBR attribute limit : TimeValue = 0.5 [h];(значення для перегляду). - Щоб записати власника й причину, напишіть довгу форму в тілі атрибута:
@TBD { owner = "Powertrain lead"; rationale = "The charging standard is not chosen yet."; due = "2026-12-01"; }.
Реєстр TBD/TBR перелічує ці значення. TBD і TBR спеціалізують ModelingMetadata::StatusInfo, тож інші інструменти SysML v2 читають їх як анотації стану. Вставити ▾ → Значення TBD і Значення TBR записують їх за вас.
Знайти назву в бібліотеці
- Відкрийте Стандартна бібліотека серед інструментів панелі навігації.
- Введіть частину назви в Знайти пакет або визначення…, наприклад
MassValue. - Натисніть Копіювати ім’я у рядку. Кваліфіковану назву, тут
ISQBase::MassValue, буде скопійовано. - Вставте її в Редакторі або імпортуйте її пакет і використовуйте коротку назву.
Приклад: читання вимоги до седана
Цей приклад простежує одну вимогу в тексті демопроєкту Hybrid Car.
- Відкрийте демопроєкт і виберіть VehicleRequirements у списку Пакети Редактора.
- Знайдіть
requirement def <'VR-1'> CurbMass. Йогоrequire constraint { car.curbMass <= limit }порівнює споряджену масу суб’єкта зlimit. - Знайдіть
requirement carSpec. Вона міститьrequirement <'VR-1.1'> sedanMass : CurbMass { attribute :>> limit = maxCurbMass; }. Використання перевизначаєlimitцільовим значенням рівня пакетаmaxCurbMass = 1650 [kg]. - Знайдіть
satisfy carSpec by fleet.sedan;. Клацнітьsedanіз ⌘ / Ctrl: Редактор відкриває Vehicles наpart sedan : Car, деattribute redefines curbMass = 1580 [kg];задає значення. - Повернувшись у VehicleRequirements, знайдіть
verification def CurbMassTest. Його цільverify carSpec.sedanMass;робить його випадком верифікації VR-1.1, аverification sedanWeighing : CurbMassTest { subject car = fleet.sedan; }застосовує його до седана. - Змініть
1580 [kg]на1700 [kg]у Vehicles і зробіть паузу. Тепер седан перевищує межу 1650 kg, і Редактор показує в VehicleRequirements попередження, щоsedanне виконує вимогу, з хибним обмеженням і його значеннями. Відмініть зміну клавішами ⌘Z / Ctrl+Z.
Поради та поширені помилки
- “…” is not defined here. (“…” тут не визначено.) Назву написано з помилкою або її пакет не імпортовано. Додайте
private import Package::*;або напишіть кваліфіковану назву. - Пропущено
;. Кожне оголошення закінчується;або тілом{ … }. The declaration does not end. Add ; or a { … } body. (Оголошення не завершено.) :>проти:>>. Використовуйте:>, щоб спеціалізувати або утворити підмножину; використовуйте:>>, щоб замінити успадковану властивість. Перевизначення властивості, яку не успадковано, дає “x” is not inherited by “y”. (“x” не успадковується “y”.)- Одиниці потребують імпортів.
5 [kg]розпізнається лише там, де видноSI. - Два члени з однією назвою. “x” is already used in this namespace. (“x” уже використано в цьому просторі імен.) Перейменуйте один; варіант натомість перевизначає.
verifyпоза ціллю. Помістіть його вobjective { verify R; }випадку верифікації.- Ключові слова як назви. Слова, як-от
part,stateабоaction, зарезервовано. Візьміть їх у лапки ('state') або виберіть іншу назву.
Що підтримує Holarch
Holarch підтримує такі частини текстової нотації SysML v2. Редактор перевіряє їх усі, і модель їх зберігає.
| Область | Підтримується |
|---|---|
| Пакети й простори імен | package, вкладені пакети, library package (лише для читання), doc, comment … about, примітки // і //* */, alias … for …, public/private/protected, короткі назви <'1.2'>, назви в лапках |
| Імпорти | імпорти членів і просторів імен, ::*, рекурсивний ::**, фільтровані імпорти [@Kind] |
| Визначення та використання | part, attribute, item, port, connection, interface, flow, action, state, requirement, constraint, calc, use case, analysis, verification, view, viewpoint, concern, enum, occurrence, allocation, metadata; ref, abstract, in/out/inout, end |
| Спеціалізація | :>/specializes, :/defined by, :>/subsets, :>>/redefines, спряження ~, disjoint, ланцюжки властивостей a.b.c |
| Кратності | [n], [n..m], [*], [0..*], ordered, nonunique, вирази як межі |
| Значення та одиниці | =, :=, default, величини 5 [kg], вирази одиниць [m/s^2], види величин ISQ, одиниці SI та звичаєві одиниці США зі стандартної бібліотеки, перевірки розмірностей |
| Структура | порти й спряжені порти, connect, інтерфейси з кінцями, іменовані кінці з’єднувачів із кратностями, bind, flow of T from … to …, message |
| Дії | параметри, perform, послідовності (first … then …, then), fork, join, decide, merge, умови, accept, send, assign, if, while, for, loop, start, done, terminate |
| Стани | entry/do/exit, переходи з тригером, умовою та ефектом, стани parallel, вкладені стани, exhibit |
| Вимоги | subject, actor, stakeholder, require constraint, assume constraint, frame concern, satisfy … by …, verify, короткі назви як ідентифікатори, doc як текст вимоги |
| Обмеження та обчислення | визначення й використання constraint і calc, return, assert constraint, виклики, вирази KerML з арифметикою, порівнянням, логікою, if ? else і операціями над послідовностями, обчислення з одиницями |
| Варіанти використання, аналіз і верифікація | subject, actor, objective, include use case, випадки аналізу з результатом return, випадки верифікації з verify і вердиктом |
| Подання | view, view def, expose (з ::*, ::** і фільтрами), filter, viewpoint, frame, render, стандартні визначення подань |
| Розподіл і сліди простежуваності | allocate a to b, визначення розподілу, dependency from … to … |
| Індивіди | визначення й використання individual, snapshot і timeslice (також після then), їхні значення й послідовності |
| Варіативність | визначення й використання variation, члени variant і посилання на варіанти (variant x;), вибір значенням, конфігурації з позначкою @HolarchConfiguration (HolarchVariability) |
| Метадані | @Name { … }, префікс #Name, metadata Name about …, пакети Holarch HolarchMetadata (TBD, TBR) і HolarchFrameworks; користувацькі metadata def; ключові слова користувача й семантичні метадані (#fault def …) |
Зберігається як написано, без інтерпретації
Holarch читає й зберігає ці конструкції точно так, як їх написано, але не надає їм власного значення:
- текстові представлення мовами, відмінними від SysML і KerML (зберігаються як текст; див. Текстові представлення).
Ще недоступно
- Імпорт файлів KerML (
.kerml). - Коміти в
main, теги й об’єднання через Systems Modeling API: інші інструменти надсилають коміти в гілки запитів на зміну, які затверджувач застосовує в Holarch (див. API і MCP у проєктах SysML v2). - Розширення мови, крім ключових слів користувача й семантичних метаданих.
Перевірки
Holarch перевіряє текст під час введення. Кожну проблему позначено на полі Редактора й підкреслено; повідомлення називає проблему, а потім спосіб виправлення. Помилки не дають застосувати член; попередження — ні.
| Область | Що перевіряється | Приклад повідомлення |
|---|---|---|
| Синтаксис | Символи, коментарі, рядки, дужки, ;, очікувані назви й токени | This brace has no partner. Add the matching { or }, or delete this one. |
| Назви | Нерозпізнані, неоднозначні, недійсні, повторювані (попередження) і приватні назви | “Batery” is not defined here. Check the spelling, or import its package. |
| Типізація та спеціалізація | Цикли; типізація та спеціалізація визначенням правильного виду; підмножини й перевизначення властивостей; перевизначення лише успадкованих властивостей | “capacity” is not inherited by “Car”. Specialize its type, or subset it with :> instead. |
| Кратності | Дійсні й цілочисельні межі; перевизначення не ширше, ніж те, що воно перевизначає | Multiplicity [3..1] is not valid. Use a lower bound from 0 up to the upper bound. |
| Одиниці й значення | Відповідність розмірностей, пропущені одиниці, назви одиниць, типи чисел | The units do not match: kg and s. Convert one side to a compatible unit. |
| Вирази | Синтаксис, типи операндів, аргументи обчислень, булеві умови | The condition must be true or false; it is a number. Write a comparison such as x > 0. |
| Структура | Кінці з’єднань є властивостями, інтерфейси з’єднують порти, напрямки портів, потоків і повідомлень, типи предметів потоку, типи прив’язок | These port directions do not fit together. Conjugate one port (~) or change a direction. |
| Дії | Послідовності між діями одного тіла, кількість входів і виходів вузлів керування, умови рішень і else, start і done, присвоєння, цілі perform, значення, які перебирає цикл for, щодо типу змінної циклу | then needs an earlier action. Add an action or first … then …. |
| Стани | Переходи між станами одного тіла, по одній дії entry/do/exit, початкові переходи, паралельні області, цілі exhibit, ефект do переходу (send до того, що може отримати, assign, accept, action або іменована дія), корисне навантаження тригера щодо предметів його порту, тригер на простому бібліотечному значенні, як-от Real (попередження), тригери at, що називають час | “electric” has substates but no initial transition, so none of them is entered. Add entry; then <first state>;. |
| Вимоги, випадки й подання | Члени на правильному місці, один суб’єкт, цілі satisfy/verify/require, типи суб’єктів, цілі expose і import, цілі frame | verify belongs in the objective of a verification case. Move it into objective { … }. |
| Текстові представлення | Тіла SysML і KerML розбираються й оголошують елемент, який вони представляють; невідомі мови зазначаються | The representation of “SpeedLimit” declares a part definition, not a constraint definition. Make the body declare “SpeedLimit” itself. |
| Екземпляри, знімки та часові зрізи | individual лише на входженнях і рівно з одним визначенням індивіда; snapshot/timeslice лише на використаннях входжень усередині входження; часовий зріз усередині знімка (попередження) | “parked” is individual, but none of its definitions is. Type it by an individual definition, or remove individual. |
| Варіативність | Варіація містить лише варіанти; варіант розташований у варіації й має її вид; вибір є варіантом своєї точки; abstract на варіації зайве (примітка); відкриті точки конфігурації (примітка) | “compact” is not a variant of “pack”. Choose one of: standardPack, largePack. |
| Ключові слова користувача | #Name називає визначення метаданих; оголошення без ключового слова мови використовує семантичні метадані (попередження); метадані позначають лише види, які дозволяє їхній annotatedElement; семантичний базовий тип є визначенням або використанням, відповідає елементу, який позначає (попередження), і не утворює циклу | “safetyCritical” applies to PartDefinition, not to “invert” (ActionUsage). Move it, or remove it. |
| Значення метаданих | Кожна обов’язкова властивість користувацького визначення метаданих отримує значення (попередження); кожне значення й значення за замовчуванням відповідає типу своєї властивості (Boolean, String, цілі числа, переліки); обмеження визначення виконуються для заданих значень; тіло метаданих лише перевизначає властивості визначення; абстрактні визначення метаданих не застосовуються; семантичні метадані, записані з about (попередження) | The values of “SafetyRating” break its constraint levelRange: level >= 1 and level <= 4. Change the values. |
| Оцінювання | Обмеження, вимоги й цілі, які не виконуються для поточних значень | “sedanMass” is not met by “sedan”: … is false (…). Change the design values or the requirement. |
Стандартна бібліотека
Сторінка Стандартна бібліотека перелічує пакети й визначення, якими може користуватися кожен проєкт SysML v2: значення й одиниці, величини, частини, порти, дії, стани, вимоги, аналіз тощо. Вона доступна лише для читання.
- Відкрийте її через Налаштування → Стандартна бібліотека серед інструментів панелі навігації. У проєктах LML її немає.
- Папки. Ліворуч наведено файли бібліотеки за папками: Kernel Libraries, Systems Library, Domain Libraries (Analysis, Cause and Effect, Geometry, Metadata, Quantities and Units, Requirement Derivation) і Holarch (пакет
HolarchMetadataз TBD і TBR,HolarchVariabilityзHolarchConfigurationіHolarchRequirementsзObjective). - Файл. Виберіть файл, щоб побачити його пакети, кожен із документацією й таблицею визначень: Назва, Вид і Документація.
- Знайти. Вводьте в Знайти пакет або визначення…, щоб шукати в назвах і документації кожного файлу. Результати показують файл; натисніть його, щоб відкрити цей файл. Натисніть Esc, щоб очистити.
- Копіювати ім’я копіює кваліфіковану назву елемента, як-от
ISQ::MassValue, для використання в Редакторі. - Показати текст показує файл бібліотеки так, як його написано; Показати визначення повертає до таблиць.
Бібліотека — це бібліотека випуску SysML v2 з одним виправленням: tonne (псевдонім 'metric ton') перетворюється на 1000 kg; у файлі випуску вказано 0.001 kg. Ваша модель посилається на неї за назвою; вона не копіюється в проєкт і не входить до експорту .sysml.
Обмеження
- Текстовий документ, більший за 8 MB, не перевіряється: This text is larger than 8 MB and is not checked. Split it into several packages. (Цей текст більший за 8 MB і не перевіряється. Розділіть його на кілька пакетів)
- Рядок, довший за 64 KB, не перевіряється.
- Вкладеність, глибша за 256 рівнів, не перевіряється.
- Стандартну бібліотеку не можна редагувати.
Пов’язані сторінки
- Початок роботи з проєктами SysML v2
- Текстовий редактор і Оглядач
- Подання SysML v2
- Вимоги та верифікація в проєктах SysML v2
- Обмін моделями SysML v2
SysML® і OMG® — зареєстровані торговельні марки Object Management Group, Inc. у США та інших країнах.