Holarch

Руководство · SysML v2

Перенос модели SysML v1 на SysML v2: пошаговая миграция

Модель SysML v1 можно автоматически преобразовать в SysML v2, но миграция — это больше, чем преобразование файла: кто-то должен решить, как должна выглядеть преобразованная модель, и проверить, что она по-прежнему говорит то же, что модель v1. Это руководство проводит миграцию за восемь шагов, от инвентаризации модели v1 до перехода, с небольшой моделью, преобразованной и прочитанной строка за строкой.

На этой странице
  1. Прежде чем начать: перевод, а не обновление
  2. 1. Проведите инвентаризацию модели v1
  3. 2. Экспортируйте модель из инструмента SysML v1
  4. 3. Преобразуйте пилотный пакет
  5. 4. Прочитайте отчёт о преобразовании
  6. Рабочий пример: небольшая модель марсохода
  7. 5. Доработайте приближённое или пропущенное
  8. 6. Перестройте важные представления
  9. 7. Проверьте модель v2 и проведите её рецензирование
  10. 8. Преобразуйте остальное и перейдите
  11. Чек-лист миграции
  12. Что дальше

Прежде чем начать: перевод, а не обновление

SysML v2 — новый язык, а не новая версия формата файлов SysML v1. Блоки становятся определениями частей, порты типизируются определениями портов, требования несут условия, а диаграммы становятся представлениями, которые определяет модель. SysML v1 и v2 объясняет различия одно за другим.

Конвертер выполняет механическую часть: каждый элемент, у которого есть аналог в SysML v2, записывается на SysML v2, а об остальных сообщается. Чего конвертер сделать не может, так это решить, как ваша команда хочет использовать новый язык. Планируйте миграцию как задачу моделирования с ответственным, рецензированием и моментом, когда модель v2 становится эталонной.

В этом руководстве используется конвертер Holarch, который импортирует модель SysML 1.x в проект SysML v2 и отмечает каждый элемент как преобразованный, приближённый или пропущенный. Шаги планирования применимы к любому конвертеру.

1. Проведите инвентаризацию модели v1

Прежде чем что-либо экспортировать, выясните, что содержит модель и кто от неё зависит. Короткая инвентаризация избавит от переделок позже.

  • Пакеты и ответственные. Перечислите пакеты верхнего уровня, кто сопровождает каждый и на какие ссылаются другие модели или документы. Пакеты — это единица, которую вы будете преобразовывать и рецензировать.
  • Важные диаграммы. Отметьте диаграммы, которыми действительно пользуются на рецензированиях и в документах. Компоновка диаграмм не переносится в SysML v2, поэтому они становятся представлениями, которые вы перестраиваете.
  • Профили и стереотипы. Перечислите собственные стереотипы и их помеченные значения. Они становятся определениями метаданных, и их смысл в новой модели нужно согласовать заново.
  • Поведение, записанное кодом. Непрозрачные поведения, охранные условия и ограничения на OCL, языке действий или языке сценариев инструмента сохраняются как текст на исходном языке; они не переводятся.
  • Безымянные элементы. Связи, указывающие на элементы без имени, нельзя записать в тексте SysML v2, который ссылается на элементы по имени. Дайте имена элементам, к которым вы трассируете, сейчас, в инструменте v1.
  • Размер. Holarch преобразует за раз один файл размером до 64 MB и до 250 000 элементов. Более крупные модели экспортируются по одному пакету.

2. Экспортируйте модель из инструмента SysML v1

Конвертер читает модель из XMI — формата обмена, который записывают инструменты SysML v1. Каждый инструмент экспортирует его немного по-своему:

ИнструментЧто импортировать
Cameo Systems Modeler, MagicDrawФайл проекта .mdzip или File → Export To → Eclipse UML2 (v5.x) XMI File и файл .xmi
Enterprise ArchitectВыберите пакет, Publish → Export XML, выберите XMI 2.1 и импортируйте файл .xml. Файлы проектов (.eap, .qea) напрямую не читаются.
IBM RhapsodyЭкспорт XMI 2.x из набора инструментов XMI
Eclipse PapyrusФайл модели .uml

Храните экспортированный файл вместе с записями о миграции: это именно те входные данные v1, на которые ссылается ваше рецензирование.

3. Преобразуйте пилотный пакет

Начните с одного пакета, представительного, но не самого крупного: подсистемы со структурой, интерфейсами, некоторым поведением и её требованиями. Пилот показывает, как выглядит преобразование вашей модели, прежде чем вы направите на него всю команду.

  1. Создайте проект SysML v2 или откройте тот, в который должна попасть преобразованная модель, и нажмите Модель → Импорт и экспорт.
  2. В разделе Импорт выберите для пилота В новый проект SysML v2, чтобы больше ничего не затронуть.
  3. Перетащите экспортированный файл в поле. Карточка хода выполнения показывает этапы: чтение файла XMI, преобразование в SysML v2, проверка результата.

Пока ничего не импортировано. Следующий экран — предварительный просмотр с отчётом о преобразовании.

4. Прочитайте отчёт о преобразовании

Преобразование из SysML v1 в верхней части предварительного просмотра показывает число преобразованных, приближённых и пропущенных элементов и то, проходит ли текст SysML v2 проверку без проблем. У каждого элемента модели v1 один результат:

  • Преобразовано: у элемента есть прямой аналог в SysML v2, например блок, который становится part def.
  • Приближено: элемент сохранён в изменённом виде, например переход через выбор, который становится отдельным переходом для каждого пути. Это места, где смысл может отличаться от модели v1.
  • Пропущено: в SysML v2 нет аналога, или элемент указывает на то, чего нет в файле.

Нажмите Показать, чтобы вывести список приближённых и пропущенных элементов. Каждая строка содержит элемент, его вид в SysML v1, во что он превратился с его именем в SysML v2, и причину. Откройте Показать текст SysML v2, чтобы прочитать результат, и нажмите Скачать отчёт, чтобы сохранить отчёт в файле CSV. CSV — это список работ для шага 5: отсортируйте его по причине и назначьте каждой группе ответственного.

Рабочий пример: небольшая модель марсохода

Небольшая модель SysML v1 тракта питания планетохода в трёх пакетах:

ПакетЭлементы SysML v1
TypesТип значения Power с единицей W; блок Charge; интерфейсный блок Power Interface с двумя исходящими свойствами потока, charge (Charge) и voltage (Real)
СтруктураИнкапсулированный блок Rover со свойствами частей battery и computer, свойством значения power budget в 120 W, соединителем power bus между их портами и потоком предметов power flow типа Charge на нём. Блок Battery с прокси-портом out; блок Computer с сопряжённым прокси-портом in и полным портом raw. Оба несут пользовательский стереотип «Hardware» с помеченными значениями. Ассоциация, конец которой принадлежит самой ассоциации.
ТребованияТребования R-1 Mission и R-2 Power Margin; R-2 выведено из R-1; R-2 удовлетворяется частью battery; трассировка от Computer к Battery

После преобразования она выглядит так. Листинг — вывод конвертера без изменений:

package 'Rover Model' {
  package Types {
    attribute def Power :> ISQ::PowerValue;
    part def Charge;
    port def 'Power Interface' {
      out item charge : Charge;
      out attribute voltage : ScalarValues::Real;
    }
  }
  package Structure {
    part def Rover {
      doc /* Six-wheeled science rover. */
      @SysMLv1Library::BlockData { isEncapsulated = true; }
      part battery : Battery;
      part computer : Computer;
      attribute 'power budget' : Types::Power = 120 [SI::W];
      connection 'power bus' connect battery.'out' to computer.'in';
      satisfy Requirements::'Power Margin' by battery;
      flow 'power flow' of Types::Charge from battery.'out' to computer.'in';
    }
    part def Battery {
      @'SysML v1 Profiles'::rov::Hardware { qualified = "true"; vendor = "Acme Cells"; }
      port 'out' : Types::'Power Interface';
      attribute capacity : Types::Power;
    }
    part def Computer {
      @'SysML v1 Profiles'::rov::Hardware { vendor = "Orbital Logic"; }
      port 'in' : ~Types::'Power Interface';
      part raw : Types::Charge {
        @SysMLv1Library::PortData { isFullPort = true; }
      }
    }
  }
  package Requirements {
    requirement <'R-1'> Mission {
      doc /* The rover shall explore the landing site. */
    }
    requirement <'R-2'> 'Power Margin' {
      doc /* Keep a 50 % power margin. */
    }
    connection : DerivationConnections::Derivation connect 'Power Margin' to Mission;
    dependency from Structure::Computer to Structure::Battery {
      @SysMLv1Library::TraceData { isTrace = true; }
    }
  }
}

package 'SysML v1 Profiles' {
  package rov {
    metadata def Hardware {
      attribute qualified : ScalarValues::String;
      attribute vendor : ScalarValues::String;
    }
  }
}

Что произошло с каждой частью модели v1:

  • Тип значения с единицей. Power в ваттах специализирует ISQ::PowerValue из стандартной библиотеки, а значение по умолчанию записано с единицей: 120 [SI::W]. Тип значения, единица которого не является сопоставленной единицей SI, остаётся вещественным числом с единицей в документации и отмечается как приближённый.
  • Блоки и свойства. Блоки становятся part def, а свойства частей — part. Для isEncapsulated блока в SysML v2 нет ключевого слова, поэтому оно сохраняется как метаданные SysMLv1Library::BlockData.
  • Интерфейсный блок и порты. Интерфейсный блок становится port def, свойства потока которого — направленные признаки: out item для типизированного блоком и out attribute для значения. Сопряжённый прокси-порт получает тип ~Types::'Power Interface'. Полный порт становится частью с метаданными SysMLv1Library::PortData, потому что порт в SysML v2 типизируется определением порта.
  • Соединитель и поток предметов. Соединитель становится connection между двумя портами, а поток предметов на нём — flow типа Charge между теми же портами.
  • Требования. Каждое требование сохраняет свой идентификатор как краткое имя, <'R-1'>, а свой текст — как doc. Отношение satisfy находится в блоке, которому принадлежит удовлетворяющая часть; отношение derive становится соединением вывода; трассировка становится зависимостью с SysMLv1Library::TraceData.
  • Пользовательский стереотип. «Hardware» становится metadata def в пакете 'SysML v1 Profiles', применённым к каждому блоку с его помеченными значениями. Два его применения отмечены как приближённые: значения тегов стали текстовыми атрибутами, каким бы ни был их тип в профиле.
  • Ассоциация. У ассоциации без класса здесь нет аналога в SysML v2, и её конец, принадлежащий ассоциации, тоже не преобразуется. Оба отмечены как пропущенные; структуру несут свойства в блоках.

Отчёт для этой модели: 31 элемент, 27 преобразовано, 2 приближено, 2 пропущено, а текст проходит проверку без ошибок и предупреждений. Имена, не являющиеся простыми идентификаторами, такие как 'power budget' или 'out' (ключевое слово SysML v2), заключаются в кавычки, чтобы сохранить написание v1.

5. Доработайте приближённое или пропущенное

Пройдите по приближённым и пропущенным строкам отчёта, группируя их по причине. Большинство причин требуют одного из немногих решений:

Что говорит отчётЧто решить
Порт типизирован блоком, который не является интерфейсным; он стал портом без типаОпределите определение порта с признаками, пересекающими границу, и типизируйте им порт.
Переходы через выбор, соединение, разветвление или слияние; каждый путь стал отдельным переходомПроверьте, что объединённые охранные условия по-прежнему говорят то, что имела в виду диаграмма v1; упростите там, где пути теперь читаются легче.
Триггер сохранён как документацияПерепишите триггеры изменения и времени как триггеры SysML v2 там, где смысл ясен, например accept after с длительностью.
Единица не входит в число единиц SI, которые сопоставляет Holarch; тип значения — вещественное числоРешите, подходит ли стандартная величина, или оставьте вещественное число и задокументированную единицу.
Вид действия, отличный от вызова, непрозрачного действия или действия приёма, стал простым действиемПерепишите отправки и другие специальные действия действием SysML v2, которое делает то же самое.
Разделы деятельности не преобразуютсяУказывайте, какая часть что делает, с помощью perform в части, а не дорожкой.
Указывает на элемент без имениДайте имя цели в инструменте v1 и преобразуйте снова или добавьте отношение в модели v2.
Имя используется дважды в одном месте; переименовано с суффиксомДайте каждому элементу имя, которое говорит, что это такое.
Помеченные значения стали текстовыми атрибутами метаданныхДайте атрибутам метаданных нужные типы и согласуйте, что теперь означает каждый стереотип.

Два вида текста требуют внимания, даже если преобразовались без замечаний. Непрозрачные тела сохраняются как текстовые представления на исходном языке, например language "OCL" /* … */; Holarch проверяет только тела, написанные на SysML или KerML, поэтому перепишите охранное условие или ограничение как выражение SysML там, где модель должна его вычислять. Кроме того, буквальный перевод сохраняет обходные решения v1, например типы для конкретных свойств, созданные только для задания значения: в SysML v2 это простые переопределения в использованиях. Раздел Что нужно переосмыслить перечисляет типичные случаи.

6. Перестройте важные представления

Диаграммы и их компоновка не преобразуются. Возьмите список диаграмм из шага 1 и создайте представление для каждой, которая ещё нужна: общее представление для структуры и требований, представление взаимосвязей для частей и соединений, представление потока действий для деятельностей, представление переходов состояний для конечных автоматов. Перестраивайте только то, чем пользуются; модель в любом случае содержит всё остальное. См. справочник по представлениям.

7. Проверьте модель v2 и проведите её рецензирование

  • Текст проходит проверку. Импорт показывает проверку преобразованного текста до каких-либо изменений; после доработки редактор отмечает любые новые проблемы по мере ввода.
  • Количества совпадают. Сравните несколько чисел в модели v1 и модели v2: требования, части, порты, соединения, отношения верификации. Расхождение, которое нельзя объяснить по отчёту, стоит изучить.
  • Модель рецензируют те, кто ею пользуется. Пройдите по пилотному пакету с его ответственными, начиная с приближённых элементов и перестроенных представлений.
  • Записывайте решения. Запишите шаблоны моделирования, о которых вы договорились для портов, триггеров, единиц и стереотипов, чтобы остальная миграция им следовала.

8. Преобразуйте остальное и перейдите

Преобразуйте оставшиеся пакеты по одному в тот же проект SysML v2. Каждый импорт показывает тот же предварительный просмотр: пакет, который уже есть в проекте, отображается как Изменено или Без изменений, новый — как Новый, и вы выбираете, какие пакеты импортировать. Каждый импорт — один шаг отмены.

Держите модель v1 в качестве эталона, пока модель v2 не пройдёт рецензирование, затем заморозьте её и сделайте проект SysML v2 официальной моделью. С этого момента изменения вносятся только в модель v2.

Чек-лист миграции

  • Пакеты, ответственные и важные диаграммы перечислены.
  • У элементов, на которые указывают отношения, есть имена.
  • Экспортированный файл XMI хранится вместе с записями о миграции.
  • Пилотный пакет преобразован, его отчёт скачан, и по каждой приближённой и пропущенной строке принято решение.
  • Шаблоны моделирования для портов, триггеров, единиц и стереотипов записаны.
  • Нужные представления перестроены; текст проходит проверку.
  • Пользователи модели провели рецензирование пилота.
  • Оставшиеся пакеты преобразованы тем же способом, а модель v1 заморожена.

Что дальше

Cameo Systems Modeler, MagicDraw, Enterprise Architect, Rhapsody и Eclipse Papyrus являются товарными знаками соответствующих владельцев. Holarch не связан с ними и не одобрен ими.