Przewodnik · SysML v2
Przeniesienie modelu SysML v1 do SysML v2: migracja krok po kroku
Model SysML v1 można automatycznie skonwertować do SysML v2, ale migracja to coś więcej niż konwersja pliku: ktoś musi zdecydować, jak powinien wyglądać skonwertowany model, i sprawdzić, czy nadal mówi to, co mówił model v1. Ten przewodnik przeprowadza przez migrację w ośmiu krokach, od inwentaryzacji modelu v1 do przełączenia, z małym modelem skonwertowanym i przeczytanym wiersz po wierszu.
Na tej stronie
- Zanim zaczniesz: tłumaczenie, a nie aktualizacja
- 1. Zrób inwentaryzację modelu v1
- 2. Wyeksportuj model z narzędzia SysML v1
- 3. Skonwertuj pakiet pilotażowy
- 4. Przeczytaj raport z konwersji
- Przykład: mały model łazika
- 5. Popraw to, co przybliżono lub pominięto
- 6. Odbuduj ważne widoki
- 7. Sprawdź i przejrzyj model v2
- 8. Skonwertuj resztę i przełącz się
- Lista kontrolna migracji
- Co dalej
Zanim zaczniesz: tłumaczenie, a nie aktualizacja
SysML v2 to nowy język, a nie nowa wersja formatu pliku SysML v1. Bloki stają się definicjami części, porty są typowane definicjami portów, wymagania niosą warunki, a diagramy stają się widokami definiowanymi przez model. SysML v1 a v2 wyjaśnia różnice jedna po drugiej.
Konwerter wykonuje część mechaniczną: każdy element, który ma odpowiednik w SysML v2, jest zapisywany w SysML v2, a reszta jest zgłaszana. Konwerter nie może natomiast zdecydować, jak zespół chce używać nowego języka. Planuj migrację jako zadanie modelowania z właścicielem, przeglądem i momentem, w którym model v2 staje się wzorcem.
Ten przewodnik używa konwertera Holarch, który importuje model SysML 1.x do projektu SysML v2 i zgłasza każdy element jako skonwertowany, przybliżony lub pominięty. Kroki planowania obowiązują niezależnie od używanego konwertera.
1. Zrób inwentaryzację modelu v1
Zanim cokolwiek wyeksportujesz, dowiedz się, co zawiera model i kto od niego zależy. Krótka inwentaryzacja oszczędza później poprawek.
- Pakiety i właściciele. Wypisz pakiety najwyższego poziomu, kto utrzymuje każdy z nich i do których odwołują się inne modele lub dokumenty. Pakiety to jednostki, które będziesz konwertować i przeglądać.
- Ważne diagramy. Zanotuj diagramy, których ludzie faktycznie używają na przeglądach i w dokumentach. Układy diagramów nie przenoszą się do SysML v2, więc staną się widokami do odbudowania.
- Profile i stereotypy. Wypisz własne stereotypy i ich wartości oznaczone. Stają się definicjami metadanych, a ich znaczenie w nowym modelu trzeba uzgodnić na nowo.
- Zachowanie zapisane jako kod. Zachowania nieprzezroczyste, warunki dozoru i ograniczenia w OCL, w języku akcji lub w języku skryptowym narzędzia są zachowywane jako tekst w oryginalnym języku; nie są tłumaczone.
- Elementy bez nazw. Relacji wskazujących elementy bez nazwy nie da się zapisać w tekście SysML v2, który odwołuje się do elementów po nazwie. Nazwij teraz, w narzędziu v1, elementy, do których prowadzą ślady.
- Rozmiar. Holarch konwertuje naraz jeden plik o wielkości do 64 MB i do 250 000 elementów. Większe modele eksportuje się pakiet po pakiecie.
2. Wyeksportuj model z narzędzia SysML v1
Konwerter odczytuje model z XMI, formatu wymiany zapisywanego przez narzędzia SysML v1. Każde narzędzie eksportuje go nieco inaczej:
| Narzędzie | Co zaimportować |
|---|---|
| Cameo Systems Modeler, MagicDraw | Plik projektu .mdzip albo File → Export To → Eclipse UML2 (v5.x) XMI File i plik .xmi |
| Enterprise Architect | Zaznacz pakiet, wybierz Publish → Export XML, wybierz XMI 2.1 i zaimportuj plik .xml. Pliki projektu (.eap, .qea) nie są odczytywane bezpośrednio. |
| IBM Rhapsody | Eksport XMI 2.x z zestawu narzędzi XMI |
| Eclipse Papyrus | Plik .uml modelu |
Przechowuj wyeksportowany plik razem z zapisami migracji: to dokładne wejście v1, do którego odnosi się przegląd.
3. Skonwertuj pakiet pilotażowy
Zacznij od jednego pakietu, który jest reprezentatywny, ale nie największy: podsystemu ze strukturą, interfejsami, pewnym zachowaniem i jego wymaganiami. Pilotaż pokazuje, jak wygląda konwersja twojego modelu, zanim zaangażujesz w nią cały zespół.
- Utwórz projekt SysML v2 albo otwórz ten, do którego ma trafić skonwertowany model, i kliknij Model → Import i eksport.
- W sekcji Importuj wybierz dla pilotażu Do nowego projektu SysML v2, aby nic innego nie zostało naruszone.
- Upuść wyeksportowany plik na pole. Karta postępu pokazuje etapy: odczyt pliku XMI, konwersję do SysML v2, sprawdzenie wyniku.
Nic nie zostało jeszcze zaimportowane. Następny ekran to podgląd z raportem z konwersji.
4. Przeczytaj raport z konwersji
Konwersja z SysML v1 u góry podglądu podaje liczbę elementów skonwertowanych, przybliżonych i pominiętych oraz informację, czy tekst SysML v2 przechodzi sprawdzenie bez problemów. Każdy element modelu v1 ma jeden wynik:
- Skonwertowany: element ma bezpośredni odpowiednik w SysML v2, na przykład blok, który staje się
part def. - Przybliżony: element jest zachowany w zmienionej formie, na przykład przejście przez wybór, które staje się jednym przejściem na każdą ścieżkę. To miejsca, w których znaczenie może różnić się od modelu v1.
- Pominięty: SysML v2 nie ma odpowiednika albo element wskazuje coś, czego nie ma w pliku.
Użyj Pokaż, aby wyświetlić przybliżone i pominięte elementy. Każdy wiersz podaje element, jego rodzaj w SysML v1, to, czym się stał, z nazwą w SysML v2, oraz powód. Otwórz Pokaż tekst SysML v2, aby przeczytać wynik, i kliknij Pobierz raport, aby zachować raport jako plik CSV. CSV to lista zadań do kroku 5: posortuj ją według powodu i przypisz każdej grupie właściciela.
Przykład: mały model łazika
Mały model SysML v1 toru zasilania łazika planetarnego w trzech pakietach:
| Pakiet | Elementy SysML v1 |
|---|---|
| Typy | Typ wartości Power z jednostką W; blok Charge; blok interfejsu Power Interface z dwiema wychodzącymi właściwościami przepływu, charge (typu Charge) i voltage (typu Real) |
| Struktura | Hermetyzowany blok Rover z właściwościami części battery i computer, właściwością wartości power budget równą 120 W, łącznikiem power bus między ich portami i przepływem elementów power flow typu Charge na nim. Blok Battery z portem pośredniczącym out; blok Computer ze sprzężonym portem pośredniczącym in i portem pełnym raw. Oba mają stereotyp użytkownika «Hardware» z wartościami oznaczonymi. Asocjacja, której koniec należy do asocjacji. |
| Wymagania | Wymagania R-1 Mission i R-2 Power Margin; R-2 wyprowadzone z R-1; R-2 spełniane przez część battery; ślad od Computer do Battery |
Po konwersji wygląda to tak. Listing to niezmienione wyjście konwertera:
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;
}
}
}
Co stało się z każdą częścią modelu v1:
- Typ wartości z jednostką. Power w watach specjalizuje
ISQ::PowerValuez biblioteki standardowej, a wartość domyślna jest zapisana z jednostką:120 [SI::W]. Typ wartości, którego jednostka nie jest mapowaną jednostką SI, pozostaje liczbą rzeczywistą z jednostką w dokumentacji i jest zgłaszany jako przybliżony. - Bloki i właściwości. Bloki stają się
part def, a właściwości części stają siępart. Właściwość isEncapsulated bloku nie ma słowa kluczowego w SysML v2, więc jest zachowana jako metadaneSysMLv1Library::BlockData. - Blok interfejsu i porty. Blok interfejsu staje się
port def, którego właściwości przepływu są cechami kierunkowymi:out itemdla tej typowanej blokiem,out attributedla wartości. Sprzężony port pośredniczący ma typ~Types::'Power Interface'. Port pełny staje się częścią z metadanymiSysMLv1Library::PortData, ponieważ port SysML v2 jest typowany definicją portu. - Łącznik i przepływ elementów. Łącznik staje się
connectionmiędzy dwoma portami, a przepływ elementów na nimflowtypu Charge między tymi samymi portami. - Wymagania. Każde wymaganie zachowuje swój identyfikator jako nazwę skróconą,
<'R-1'>, a tekst jakodoc. Relacja satisfy znajduje się w bloku, który posiada spełniającą część; relacja derive staje się połączeniem wyprowadzenia; ślad staje się zależnością zSysMLv1Library::TraceData. - Stereotyp użytkownika. «Hardware» staje się
metadata defw pakiecie'SysML v1 Profiles', zastosowanym do każdego bloku z jego wartościami oznaczonymi. Jego dwa zastosowania są zgłaszane jako przybliżone: wartości oznaczone stały się atrybutami tekstowymi niezależnie od typu, jaki miały w profilu. - Asocjacja. Asocjacja bez klasy nie ma tu odpowiednika w SysML v2, a jej koniec należący do asocjacji też nie jest konwertowany. Oba są zgłaszane jako pominięte; strukturę niosą właściwości bloków.
Raport dla tego modelu: 31 elementów, 27 skonwertowanych, 2 przybliżone, 2 pominięte, a tekst przechodzi sprawdzenie bez błędów i ostrzeżeń. Nazwy, które nie są zwykłymi identyfikatorami, takie jak 'power budget' czy 'out' (słowo kluczowe SysML v2), są ujęte w cudzysłów, aby zachowały pisownię z v1.
5. Popraw to, co przybliżono lub pominięto
Przejdź przez przybliżone i pominięte wiersze raportu według powodu. Większość powodów wymaga jednej z kilku decyzji:
| Co mówi raport | Co zdecydować |
|---|---|
| Port jest typowany blokiem, który nie jest blokiem interfejsu; stał się portem bez typu | Zdefiniuj definicję portu z cechami, które przekraczają granicę, i nadaj nią typ portowi. |
| Przejścia przez wybór, złącze, rozwidlenie lub złączenie; każda ścieżka stała się jednym przejściem | Sprawdź, czy połączone warunki dozoru nadal mówią to, co oznaczał diagram v1; uprość tam, gdzie ścieżki są teraz łatwiejsze do odczytania. |
| Wyzwalacz jest zachowany jako dokumentacja | Przepisz wyzwalacze zmiany i czasu jako wyzwalacze SysML v2 tam, gdzie znaczenie jest jasne, na przykład accept after z czasem trwania. |
| Jednostka nie jest jednostką SI mapowaną przez Holarch; typ wartości jest liczbą rzeczywistą | Zdecyduj, czy pasuje standardowa wielkość, czy zachować liczbę rzeczywistą i udokumentowaną jednostkę. |
| Rodzaj akcji inny niż akcja wywołania, nieprzezroczysta lub akceptująca stał się zwykłą akcją | Przepisz akcje wysyłania i inne specyficzne akcje akcją SysML v2, która robi to samo. |
| Partycje aktywności nie są konwertowane | Wskaż, która część co robi, za pomocą perform w części zamiast toru. |
| Wskazuje element bez nazwy | Nazwij element docelowy w narzędziu v1 i skonwertuj ponownie albo dodaj relację w modelu v2. |
| Jego nazwa jest użyta dwukrotnie w tym samym miejscu; zmieniono ją, dodając sufiks | Nadaj każdemu elementowi nazwę, która mówi, czym jest. |
| Wartości oznaczone stały się atrybutami tekstowymi metadanych | Nadaj atrybutom metadanych potrzebne typy i uzgodnij, co każdy stereotyp teraz oznacza. |
Dwa rodzaje tekstu wymagają przejrzenia, nawet jeśli skonwertowały się bez problemów. Treści nieprzezroczyste są zachowywane jako reprezentacje tekstowe w oryginalnym języku, na przykład language "OCL" /* … */; Holarch sprawdza tylko treści zapisane w SysML lub KerML, więc przepisz warunek dozoru lub ograniczenie jako wyrażenie SysML tam, gdzie model powinien je obliczać. Ponadto dosłowne tłumaczenia zachowują obejścia z v1, na przykład typy specyficzne dla właściwości utworzone tylko po to, by ustawić wartość: w SysML v2 są to zwykłe redefinicje w użyciach. Co wymaga przemyślenia wymienia typowe przypadki.
6. Odbuduj ważne widoki
Diagramy i ich układ nie są konwertowane. Weź listę diagramów z kroku 1 i utwórz widok dla każdego, który jest nadal potrzebny: widok ogólny dla struktury i wymagań, widok połączeń dla części i połączeń, widok przepływu akcji dla aktywności, widok przejść stanów dla maszyn stanów. Odbuduj tylko to, czego ludzie używają; model i tak zawiera wszystko inne. Zob. opis widoków.
7. Sprawdź i przejrzyj model v2
- Tekst przechodzi sprawdzenie. Import pokazuje sprawdzenie skonwertowanego tekstu, zanim cokolwiek się zmieni; po twoich poprawkach Edytor oznacza nowe problemy w trakcie pisania.
- Liczby się zgadzają. Porównaj kilka liczb między modelem v1 a modelem v2: wymagania, części, porty, połączenia, relacje weryfikacji. Różnica, której nie da się wyjaśnić na podstawie raportu, jest warta sprawdzenia.
- Ludzie, którzy używają modelu, go przeglądają. Przejdź przez pakiet pilotażowy z jego właścicielami, zaczynając od elementów przybliżonych i odbudowanych widoków.
- Zapisz decyzje. Zanotuj ustalone wzorce modelowania dla portów, wyzwalaczy, jednostek i stereotypów, aby reszta migracji się do nich stosowała.
8. Skonwertuj resztę i przełącz się
Konwertuj pozostałe pakiety po jednym do tego samego projektu SysML v2. Każdy import pokazuje ten sam podgląd: pakiet już obecny w projekcie jest oznaczony jako Zmieniono lub Bez zmian, nowy jako Nowy, a ty wybierasz, które pakiety zaimportować. Każdy import to jeden krok cofania.
Zachowaj model v1 jako wzorzec, dopóki model v2 nie zostanie przejrzany, a następnie go zamroź i uczyń projekt SysML v2 modelem obowiązującym. Od tego momentu zmiany wprowadza się tylko w modelu v2.
Lista kontrolna migracji
- Pakiety, właściciele i ważne diagramy są wypisane.
- Elementy, które wskazują relacje, mają nazwy.
- Wyeksportowany plik XMI jest przechowywany razem z zapisami migracji.
- Pakiet pilotażowy jest skonwertowany, jego raport pobrany, a każdy przybliżony i pominięty wiersz ma decyzję.
- Wzorce modelowania dla portów, wyzwalaczy, jednostek i stereotypów są zapisane.
- Potrzebne widoki są odbudowane; tekst przechodzi sprawdzenie.
- Użytkownicy modelu przejrzeli pilotaż.
- Pozostałe pakiety są skonwertowane w ten sam sposób, a model v1 jest zamrożony.
Co dalej
- Z SysML v1 do SysML v2 w Holarch: co konwerter odczytuje i zapisuje oraz przykład CubeSat EO-1.
- Importowanie modeli SysML v1: każdy krok, mapowanie, ograniczenie i komunikat w dokumentacji.
- SysML v1 a v2: czym różnią się te dwa języki.
- Samouczek SysML v2: zbuduj model w notacji tekstowej.
- Pokrycie języka SysML v2: co obsługują projekty SysML v2 i znane luki.
Cameo Systems Modeler, MagicDraw, Enterprise Architect, Rhapsody i Eclipse Papyrus są znakami towarowymi ich właścicieli. Holarch nie jest z nimi powiązany ani przez nie promowany.