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