Holarch

SysML v2

Текстовая нотация SysML v2

Язык SysML v2 в том объёме, в котором его поддерживает Holarch, с примерами из демо-проекта Hybrid Car, выполняемые им проверки и Стандартная библиотека, доступная только для чтения.

Как использовать →

На этой странице
  1. Обзор
  2. Понятия
    1. Элементы, владельцы и квалифицированные имена
    2. Пакеты
    3. Импорты и видимость
    4. Определения и использования
    5. Типизация, специализация и переопределение
    6. Кратности
    7. Значения и единицы измерения
    8. Структура: порты, соединения, интерфейсы, связывания и потоки
    9. Поведение: действия
    10. Поведение: состояния
    11. Требования, ограничения и верификация
    12. Варианты использования
    13. Представления
    14. Комментарии, документация и метаданные
    15. Экземпляры, снимки и временные срезы
    16. Вариации, варианты и конфигурации
    17. Текстовые представления
  3. Как использовать
    1. Смоделировать структуру
    2. Задать значения с единицами
    3. Описать поведение
    4. Написать требование и трассировать его
    5. Отметить значение как TBD или TBR
    6. Найти имя в библиотеке
  4. Разобранный пример: чтение требования к седану
  5. Советы и типичные ошибки
  6. Что поддерживает Holarch
    1. Сохраняется как написано, без интерпретации
    2. Пока недоступно
  7. Проверки
  8. Стандартная библиотека
  9. Ограничения
  10. Связанные страницы

Обзор

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;
}
  • Последовательности (successions) упорядочивают шаги: 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;.
  • В модели триггер и эффект перехода — самостоятельные элементы: действие приёма и действие (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) — это один конкретный объект на протяжении всей его жизни, например один автомобиль со своим серийным номером, а не вид объектов. Снимок (snapshot) — это объект в один момент времени; временной срез (time slice) — период его жизни. Оба принадлежат вхождению, которое ими владеет, и имеют его характеристики, поэтому могут задавать этим характеристикам собственные значения.

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 км, и ограничение выполняется.
  • Индивидами, снимками или временными срезами могут быть только вхождения: атрибуты и перечисления — это значения.
  • В Архитектура → Части, в представлениях базы данных и Grid столбец Экземпляры перечисляет индивиды определения каждой части (для part sedan : Car: Car_VIN1234): специализирующие его определения индивидов и типизируемые им использования индивидов. Individual (Да) и Доля (portion) (Снимок или Временной срез) также являются столбцами (Столбцы ▾ → SysML v2). Страница «Части» по умолчанию показывает Экземпляры, как только в модели появляется индивид, и тогда экспорт Таблица (CSV) включает эти три столбца; экспорт Определения перечисляет их для каждого элемента, у которого они есть.
  • В инспекторе Вхождение в разделе характеристик задаёт Individual, а для использований — Вся жизнь, Временной срез или Снимок. Фильтр видов в Браузере содержит Individuals, а меню ⋯ строки — Новый снимок… и Новый временной срез…. General View показывает «individual part def», «snapshot» и «timeslice» в заголовках блоков, перечисляет снимки и временные срезы блока в отдельном отсеке и рисует последовательности между блоками пунктирными стрелками; Упорядочить ▾ → Упорядочить как временную шкалу выстраивает их слева направо. В демо-проекте Hybrid Car General View 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, метки, исполнители и сроки хранятся рядом с моделью. Они не записываются в текст.

Как использовать

Смоделировать структуру

  1. В Редакторе откройте пакет (или нажмите + Новый пакет).
  2. Напишите port def для каждого вида точки соединения с направленными характеристиками (out attribute torque : TorqueValue;).
  3. Напишите part def для каждого вида компонента с его атрибутами и портами.
  4. Напишите part def для сборки с part для каждого компонента.
  5. Соедините части: connect a.p to b.q; или interface name : Def connect a.p to b.q;.
  6. Сделайте паузу. Строка состояния показывает Применено, а Браузер — новые элементы.

«Вставить ▾» (или ⌃⇧Space / Ctrl+Shift+Space) записывает каждую из этих конструкций за вас, с полями для заполнения. См. Вставить конструкцию.

Задать значения с единицами

  1. Импортируйте роды величин и единицы в начале пакета: private import ISQ::*; и private import SI::*;.
  2. Типизируйте атрибут родом величины и задайте значение: attribute mass : MassValue = 45 [kg];.
  3. В определении, которое наследует атрибут, переопределите его со своим значением: attribute redefines mass = 18 [kg];.
  4. Наведите указатель на значение. Если единица не подходит к роду величины, появится карточка ошибки.

Описать поведение

  1. Напишите action def с его параметрами in и out.
  2. Добавьте шаг для каждого использования action и упорядочьте их через first … then …; или then.
  3. Используйте fork и join для параллельных шагов, decide и merge — для альтернатив.
  4. Добавьте flow of Item from a.out to b.in; между шагами, которые передают предметы.
  5. В части, которая выполняет поведение, напишите perform action name : Def;, а в её частях — perform name.step;.
  6. Откройте действие в представлении Action Flow, чтобы увидеть его в графическом виде (см. Представления SysML v2).

Написать требование и трассировать его

  1. Напишите requirement <'ID'> name { doc /* The system shall … */ subject s : Def; }.
  2. Добавьте require constraint { … }, если требование можно проверить по значениям.
  3. Напишите satisfy name by somePart; там, где проект ему удовлетворяет.
  4. Напишите verification, цель которой верифицирует его через verify.
  5. Откройте Потребности и требования → Требования: требование указано со своим номером, а Верификация → RVTM показывает, как оно верифицируется. См. Требования и верификация в проектах SysML v2.

Отметить значение как TBD или TBR

Писать TBD вместо значения в SysML недопустимо. Используйте вместо этого метаданные Holarch.

  1. Импортируйте их: private import HolarchMetadata::*;.
  2. Добавьте префикс к атрибуту: #TBD attribute chargerPower : PowerValue; (значения ещё нет) или #TBR attribute limit : TimeValue = 0.5 [h]; (значение для пересмотра).
  3. Чтобы указать ответственного и причину, запишите полную форму в теле атрибута: @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 записывают их за вас.

Найти имя в библиотеке

  1. Откройте Стандартную библиотеку в инструментах панели навигации.
  2. Введите часть имени в поле Найти пакет или определение…, например MassValue.
  3. Нажмите Копировать имя в строке. Квалифицированное имя, здесь ISQBase::MassValue, будет скопировано.
  4. Вставьте его в Редакторе или импортируйте его пакет и используйте краткое имя.

Разобранный пример: чтение требования к седану

Этот пример прослеживает одно требование по тексту демо-проекта Hybrid Car.

  1. Откройте демо-проект и выберите VehicleRequirements в списке Пакеты Редактора.
  2. Найдите requirement def <'VR-1'> CurbMass. Его require constraint { car.curbMass <= limit } сравнивает снаряжённую массу субъекта с limit.
  3. Найдите requirement carSpec. Оно содержит requirement <'VR-1.1'> sedanMass : CurbMass { attribute :>> limit = maxCurbMass; }. Использование переопределяет limit целевым значением уровня пакета maxCurbMass = 1650 [kg].
  4. Найдите satisfy carSpec by fleet.sedan;. Щёлкните sedan с ⌘ / Ctrl: Редактор откроет Vehicles на part sedan : Car, где attribute redefines curbMass = 1580 [kg]; задаёт значение.
  5. Вернитесь в VehicleRequirements и найдите verification def CurbMassTest. Его цель verify carSpec.sedanMass; делает его вариантом верификации VR-1.1, а verification sedanWeighing : CurbMassTest { subject car = fleet.sedan; } применяет его к седану.
  6. Замените 1580 [kg] на 1700 [kg] в Vehicles и сделайте паузу. Теперь седан превышает предел 1650 кг, и Редактор показывает в 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”.
  • Единицам нужны импорты. 5 [kg] разрешается только там, где виден SI.
  • Два члена с одним именем. “x” is already used in this namespace. Переименуйте один из них; вариант вместо этого использует переопределение.
  • 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 как текст требования
Ограничения и вычисленияопределения и использования ограничений и вычислений, 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 читает и сохраняет эти конструкции точно так, как они написаны, но не придаёт им собственного смысла:

Пока недоступно

  • Импорт файлов 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, цели frameverify 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 кг; в файле выпуска указано 0,001 кг. Ваша модель ссылается на неё по имени; она не копируется в проект и не входит в экспорт .sysml.

Ограничения

  • Текстовый документ размером больше 8 МБ не проверяется: This text is larger than 8 MB and is not checked. Split it into several packages. (Этот текст больше 8 МБ и не проверяется. Разделите его на несколько пакетов)
  • Строка длиннее 64 КБ не проверяется.
  • Вложенность глубже 256 уровней не проверяется.
  • Стандартную библиотеку нельзя редактировать.

SysML® и OMG® — зарегистрированные товарные знаки Object Management Group, Inc. в США и других странах.