SysML v2
Samouczki SysML v2
Dziewięć samouczków z przewodnikiem dla projektów SysML v2, od pierwszego pakietu po porty, czynności, stany, wymagania, weryfikację, ograniczenia i warianty, z panelem kroków, który sprawdza pracę.
Na tej stronie
Holarch ma ścieżkę samouczków z przewodnikiem dla projektów SysML v2. Każdy z nich tworzy mały projekt startowy SysML v2 i otwiera panel kroków obok strony. Panel sprawdza model na bieżąco: krok zmienia kolor na zielony, gdy model zawiera to, czego krok wymaga. Ta strona wymienia każdy krok jako tekst, więc można też postępować według niej.
Pierwszy samouczek korzysta ze stacji pogodowej WS-1 Weather Station, tak jak samouczki LML. Pozostałe budują części samochodu hybrydowego, czyli modelu z projektu demonstracyjnego Hybrid Car: typy wartości i komponenty, porty i interfejsy układu napędowego, cykl jazdy, stany układu napędowego, wymagania samochodu, ich weryfikację, kontrole wartości sedana oraz linię produktów. Każdy samouczek ma własny projekt startowy, więc można je przechodzić w dowolnej kolejności. Każdy projekt startowy i każdy ukończony samouczek przechodzi kontrolę z 0 problemami.
| Samouczek | Czas | Czego się nauczysz |
|---|---|---|
| Getting Started | 15 min | pisanie tekstu SysML v2, oglądanie go jako drzewa i widoku, rysowanie w widoku i dodawanie wymagania |
| Definicje i atrybuty | 20 min | pisanie wyliczeń, typów wartości i definicji abstrakcyjnych, specjalizacja z wartościami i jednostkami oraz korzystanie z uzupełniania, wstawiania i zmiany nazwy |
| Porty i interfejsy | 20 min | definiowanie portów i interfejsów, sprzęganie portów, łączenie części i rysowanie interfejsu w widoku połączeń |
| Akcje i przepływy | 20 min | pisanie definicji akcji i cyklu jazdy z rozwidleniem, przepływami i złączeniem, dodawanie torów i budowanie kroków w FFBD |
| Stany i przejścia | 20 min | pisanie sygnałów i maszyny stanów z wyzwalaczami, warunkami dozoru i akcjami stanów oraz rysowanie przejścia czasowego |
| Wymagania | 20 min | pisanie limitów, definicji i użyć wymagań, ich spełnianie i oglądanie wymagania, które nie jest spełnione |
| Weryfikacja i identyfikowalność | 15 min | pisanie przypadku weryfikacji, śledzenie kroku w macierzy identyfikowalności i wyprowadzanie wymagania |
| Ograniczenia i obliczenia | 20 min | pisanie ograniczeń i obliczeń, wiązanie wartości w widoku parametrycznym, uruchamianie przypadku analizy i oznaczanie wartości TBD i TBR |
| Warianty i konfiguracje | 15 min | pisanie zmienności i wariantów, linii produktów z regułą, konfiguracji i własnego słowa kluczowego |
Jak z niego korzystać
Rozpocznij samouczek SysML v2
- Otwórz Pomoc → Samouczki na pasku nawigacji albo naciśnij ⌘K / Ctrl+K i wpisz
tutorial. Poza projektem strona Samouczki wymienia najpierw samouczki LML, a potem Samouczki dla projektów SysML v2. W projekcie SysML v2 wymienia tylko samouczki SysML v2. - Kliknij Rozpocznij na karcie. Holarch tworzy projekt, na przykład Tutorial: SysML v2 Ports and Interfaces (Hybrid Car), i otwiera go z panelem kroków po prawej stronie.
Panel kroków działa tak jak w samouczkach LML: Pokaż obrysowuje kontrolkę potrzebną w kroku, Przejdź tam otwiera stronę, Więcej informacji otwiera temat Pomocy, a Zacznij od nowa…, Oznacz jako gotowe i × działają tak samo. Zobacz Samouczki.
Wpisz tekst kroku
Większość kroków podaje tekst SysML do wpisania w Model → Edytor. Krok mówi, gdzie umieścić wiersze, na przykład “przed ostatnim nawiasem zamykającym pakietu”. Tekst jest stosowany do modelu, gdy następuje przerwa w pisaniu; informuje o tym stan pod edytorem, a krok zmienia kolor na zielony.
- Wpisz wiersze tak, jak pokazano. Wcięcia nie mają znaczenia dla modelu; Edytor zachowuje wcięcia użytkownika.
- Czerwone podkreślenie oznacza błąd: wskaż je, aby przeczytać komunikat. Tekst z błędem składni pozostaje wersją roboczą i nie jest stosowany, dopóki błąd nie zostanie poprawiony.
- ⌘Z / Ctrl+Z cofa ostatnią zastosowaną zmianę.
Wskazówki
- Za pierwszym razem przechodź samouczki po kolei: każdy objaśnia używany tekst, a późniejsze zakładają znajomość wcześniejszych idei (definicje i użycia,
:>i:>>). - Krok, który pozostaje otwarty, zwykle zawiera literówkę w nazwie. Porównaj swój tekst z wierszami kroku; w SysML v2 wielkość liter w nazwach ma znaczenie.
- Samouczki uczą tego samego języka co Podstawy SysML v2; szczegóły zawiera strona Notacja tekstowa.
Getting Started
Napisz pierwszy model stacji pogodowej: otwórz tekst, dodaj definicję części z wartością i jednostką, użyj jej w innej definicji, zobacz model w Przeglądarce i w widoku ogólnym, narysuj część w widoku i zobacz, jak pojawia się w tekście, dodaj wymaganie z satisfy i wyeksportuj model jako plik .sysml. Kroki są opisane na stronie Pierwsze kroki z projektami SysML v2.
Definicje i atrybuty
Projekt startowy zawiera pakiet Vehicles z jedną definicją części, Car.
- Otwórz pakiet. Kliknij Model → Edytor. Każda deklaracja to słowo kluczowe i nazwa, a następnie treść w nawiasach klamrowych lub średnik.
- Napisz wyliczenie. Nad
part def Car {dodajenum def DriveMode { enum economy; enum normal; enum sport; }(jedna wartość w wierszu). - Zdefiniuj typ wartości. Pod nim dodaj
attribute def TirePressure :> ScalarValue;.:>oznacza specjalizację. - Napisz definicję abstrakcyjną. Dodaj
abstract part def Componentz komentarzemdoci atrybutamimass : MassValue,partNumber : Stringipower : PowerValue.//rozpoczyna notatkę, która pozostaje tylko w tekście. - Pozwól mechanizmowi sprawdzającemu znaleźć błąd. Dodaj
part def Battery :> Componentzattribute redefines mass = 45 [kg];i celowoattribute redefines power = 60 [kg];. Mechanizm sprawdzający podkreśla jednostkę: kilogramy nie są mocą. - Popraw jednostkę. Zmień ją na
60 [W]. - Uzupełnij nazwę. W akumulatorze wpisz
attribute capacity : Ener, przyjmijEnergyValuez listy uzupełniania klawiszem Enter i zakończ znakiem;. - Sprawdź w Bibliotece standardowej. Kliknij Ustawienia → Biblioteka standardowa na dole paska nawigacji i wpisz
EnergyValuew polu wyszukiwania. - Wstaw definicję. W Edytorze naciśnij ⌃⇧Space / Ctrl+Shift+Space (lub kliknij Wstaw ▾) w pustym wierszu, wybierz Definicja części i uzupełnij
part def Engine :> Componentoattribute redefines mass = 110 [kg];iattribute cylinders : Integer;. - Użyj definicji. W
Cardodajattribute mode : DriveMode;,part battery : Battery;ipart engine : Engine;. - Zmień nazwę wszędzie. Umieść kursor na
cylinders, naciśnij F2 i zmień nazwę nacylinderCount.
Porty i interfejsy
Projekt startowy zawiera komponenty układu napędowego z portami momentu obrotowego i mocy, definicje portów TorquePort i PowerPort oraz definicje interfejsów Shaft i HighVoltageBus.
- Zdefiniuj port. Nad
port def TorquePortdodajport def FuelPortzout attribute flowRate : Real;iattribute kind : FuelKind;.outoznacza, że wartość opuszcza część, do której należy port. - Daj częściom porty. Dodaj
port fuelOut : FuelPort;doFuelTankiport fuelIn : ~FuelPort;doEngine.~sprzęga port: wejście i wyjście są zamienione. - Zdefiniuj interfejs. Dodaj
interface def FuelLine { end supply : FuelPort; end consumer : ~FuelPort; }. - Zbuduj układ napędowy. Na końcu pakietu dodaj
part def Powertrainz częściamitank,engine,motor,batteryitransmission, portemoutput : TorquePortorazbind output = transmission.output;. - Połącz dwie części. W układzie napędowym dodaj
interface fuel : FuelLine connect tank.fuelOut to engine.fuelIn;. - Dodaj wały. Dodaj
interface engineShaft : Shaft connect engine.output to transmission.engineIn;iinterface motorShaft : Shaft connect motor.output to transmission.motorIn;. - Utwórz widok połączeń. Kliknij Architektura → Widoki połączeń, a następnie + Nowy diagram. Wybierz
Powertrainw polu Pokazuje i kliknij Utwórz. - Narysuj interfejs. Przeciągnij od uchwytu portu akumulatora
powerOutdo portu silnika elektrycznegopowerIni upuść na Interface : HighVoltageBus. - Nazwij interfejs. Zaznacz nową linię i wpisz
hvBusjako jej Nazwa w inspektorze. - Zobacz go w tekście. Kliknij Model → Edytor: interfejs znajduje się w układzie napędowym, z nazwą, typem i końcami.
Akcje i przepływy
Projekt startowy zawiera pakiet VehicleBehavior z obiektami Fuel i Torque, funkcjami ProduceTorque (F.2) i DriveWheels (F.3) oraz trzema definicjami części.
- Zdefiniuj funkcję. Dodaj
action def <'F.1'> SupplyFuelzin attribute fuelDemand : Real;iout item fuel : Fuel;. Nazwa skrócona w nawiasach ostrych to numer funkcji. - Napisz cykl jazdy. Dodaj
action def <'F'> DriveCyclezfirst start then split;,fork split;,then supply;,then produce;i krokamiaction supply : SupplyFuelorazaction produce : ProduceTorque, każdy zduration. - Dodaj przepływ. W cyklu jazdy dodaj
flow of Fuel from supply.fuel to produce.fuel;. - Złącz gałęzie. Dodaj
first supply then ready;,first produce then ready;,join ready;,then action drive : DriveWheels { … },then done;iflow produce.torque to drive.torque;. - Utwórz widok przepływu akcji. Kliknij Zachowanie → Przepływy akcji, a następnie + Nowy diagram, i wybierz
DriveCyclew polu Pokazuje. - Określ, kto wykonuje każdy krok. Dodaj
part def DrivenCarzperform action trip : DriveCycle;i częściamitank,engineitransmission, każdą zperform trip.supply;,perform trip.produce;lubperform trip.drive;. Widok otrzymuje tor dla każdej części. - Otwórz Analizę funkcjonalną. Kliknij Zachowanie → Analiza funkcjonalna, kliknij Wybierz… i wybierz
DriveCycle. - Zadeklaruj kolejną akcję. Dodaj
action def EmergencyShutdown;. - Zbuduj kroki w FFBD. Kliknij Zachowanie → FFBD, a następnie + Nowy diagram, i wybierz
EmergencyShutdown. W panelu Dodaj wpiszOpen Contactorsi naciśnij Enter, a potemCut Fuel. - Zobacz kroki w tekście. Kliknij Model → Edytor: FFBD zapisał kroki i ich następstwa.
Stany i przejścia
Projekt startowy zawiera pakiet PowertrainBehavior z pustym part def Car.
- Zdefiniuj sygnały. Dodaj
attribute def StartRequest;, a w ten sam sposóbStopRequest,PlugIniUnplug. - Napisz definicję stanu. Dodaj
state def PowertrainStateszin attribute charge : Real;,entry; then off;i stanamioff,electricihybrid. - Dodaj przejścia. Po
state off;dodajaccept StartRequest if charge > 20 then electric;iaccept StartRequest then hybrid;. - Daj stanowi akcje. Zastąp
state electric;treścią zawierającąentry action spinUpMotor;,do action driveElectric;iexit action holdMotor;. - Opuść stan elektryczny. Za nim dodaj
if charge < 15 then hybrid;iaccept StopRequest then off;; dodaj teżaccept StopRequest then off;postate hybrid;. - Dodaj stan z nazwanymi przejściami. Dodaj
state charging { do action chargeBattery; },transition plugIn first off accept PlugIn then charging;itransition unplugged first charging accept Unplug then off;. - Utwórz widok przejść stanów. Kliknij Zachowanie → Maszyny stanów, a następnie + Nowy diagram, i wybierz
PowertrainStatesw polu Pokazuje. - Narysuj przejście czasowe. Przeciągnij od uchwytu
chargingdooffi upuść na Przejście. W panelu przejścia wpisz Nazwachargedi Wyzwalaczafter 30 [min]. - Zobacz je w tekście. Kliknij Model → Edytor: przejście jest zapisane jako nazwane przejście.
- Niech samochód wykazuje stany. W
Cardodajexhibit state powertrainStates : PowertrainStates;.
Wymagania
Projekt startowy zawiera pakiet VehicleRequirements z małą kopią projektu: Battery, Car i sedan floty z masą własną 1580 kg.
- Nazwij limity. Dodaj
attribute maxCurbMass : MassValue = 1650 [kg];iattribute minBatteryCapacity : EnergyValue = 1.2 [kW*h];. - Napisz definicję wymagania. Dodaj
requirement def <'VR-1'> CurbMassz instrukcjądoc,subject car : Car;,attribute limit : MassValue;irequire constraint { car.curbMass <= limit }. - Wstaw wymaganie. Naciśnij ⌃⇧Space / Ctrl+Shift+Space w pustym wierszu, wybierz Definicja wymagania i napisz
VR-3 BatteryCapacityz podmiotembattery : Batteryirequire constraint { battery.capacity >= minBatteryCapacity }. - Zagnieźdź wymagania w specyfikacji. Dodaj
requirement carSpeczsubject car : Car;irequirement <'VR-1.1'> sedanMass : CurbMass { attribute :>> limit = maxCurbMass; }. - Określ, co je spełnia. Dodaj
satisfy carSpec by fleet.sedan;isatisfy requirement batterySpec : BatteryCapacity by fleet.sedan.battery;. - Naruś wymaganie. Zmień masę własną sedana na
1700 [kg]. Edytor oznacza spełnienie: sedan nie spełnia już VR-1.1. - Spełnij je ponownie. Naciśnij ⌘Z / Ctrl+Z lub zmień ją z powrotem na
1580 [kg]. - Zobacz tabelę wymagań. Kliknij Potrzeby i wymagania → Wymagania.
- Utwórz widok wymagań. Na stronie Diagramy kliknij + Nowy diagram, wybierz Widok wymagań i
carSpecw polu Pokazuje. - Sprawdź treść wymagań. Kliknij Potrzeby i wymagania → Jakość i kliknij Sprawdź jakość.
Weryfikacja i identyfikowalność
Projekt startowy zawiera wymaganie masy własnej i specyfikację samochodu, cykl jazdy z krokami cruise i brake, VR-6 batteryMassLimit oraz VR-7 stopFromCruise.
- Napisz przypadek weryfikacji. Dodaj
verification def <'VC-1'> CurbMassTestzsubject car : Car;,objective massObjective { verify carSpec.sedanMass; }ireturn verdict : Boolean = car.curbMass <= maxCurbMass;. - Zastosuj go do sedana. Dodaj
verification <'VC-1.1'> sedanWeighing : CurbMassTest { subject car = fleet.sedan; }. - Otwórz przypadki weryfikacji. Kliknij Weryfikacja → Przypadki weryfikacji. Kroki, wyniki i stan to dane Holarch przechowywane obok modelu. W wierszu Sedan Weighing kliknij + Kroki, a następnie + Dodaj krok, wpisz
Weigh the carw kolumnie Akcja i kliknij Zastosuj. Następnie kliknij Zaliczone wśród przycisków stanu. - Przeczytaj RVTM. Kliknij Weryfikacja → RVTM.
- Powiąż krok z wymaganiem. Kliknij Weryfikacja → Macierz identyfikowalności, pokaż wymagania jako wiersze, a akcje jako kolumny, kliknij komórkę
stopFromCruiseibrakei wybierz satisfied by. - Wyprowadź wymaganie. Dodaj
private import RequirementDerivation::*;iconnection batteryMassDerivation : Derivation connect carSpec.sedanMass to batteryMassLimit;. - Uruchom kontrole modelu. Kliknij Weryfikacja → Kontrole modelu.
Ograniczenia i obliczenia
Projekt startowy zawiera pakiet VehicleAnalysis z silnikiem, akumulatorem, samochodem i wartościami sedana oraz wartości docelowe maxCurbMass i minPowerToWeight.
- Napisz definicję ograniczenia. Dodaj
constraint def MassLimitzin mass : MassValue;,in limit : MassValue;i wyrażeniemmass <= limit. - Napisz obliczenie. Dodaj
calc def PowerToWeightz parametramipowerimassorazreturn ratio = power / mass;. - Powiąż wartości sedana. Dodaj
constraint sedanMassCheck : MassLimit { in mass = fleet.sedan.curbMass; in limit = maxCurbMass; }. - Utwórz widok parametryczny. Na stronie Diagramy kliknij + Nowy diagram, wybierz Widok parametryczny i
VehicleAnalysisw polu Pokazuje. Kontrola przechodzi: 1580 kg mieści się w 1650 kg. - Spraw, by kontrola nie przeszła. Zmień masę własną sedana na
1700 [kg]; widok pokazuje niespełnioną kontrolę. - Spraw, by znów przeszła. Cofnij zmianę lub zmień wartość z powrotem na
1580 [kg]. Rozwiąż wszystko ponownie sprawdza każde ograniczenie. - Uruchom przypadek analizy. Dodaj
analysis def PowerToWeightAnalysisz celem wymagającymratio >= minPowerToWeightorazanalysis sedanPowerToWeight : PowerToWeightAnalysis { subject car = fleet.sedan; }. - Oznacz otwarte wartości. Dodaj
private import HolarchMetadata::*;oraz wymaganie VR-5ChargeTimez#TBRprzy limicie czasu i@TBDz właścicielem, terminem i uzasadnieniem przy mocy ładowarki.TBDiTBRpochodzą z biblioteki HolarchHolarchMetadata, a nie z biblioteki standardowej SysML v2; specjalizują standardowe metadaneStatusInfo. - Otwórz rejestr TBD/TBR. Kliknij Potrzeby i wymagania → TBD/TBR. Czas ładowania jest wymieniony z właścicielem i terminem z metadanych
@TBD. Rejestr jest tylko do odczytu: właściciela lub datę zmienia się w metadanych w Edytorze. - Zsumuj masę. Kliknij Architektura → Budżety i TPM i wybierz część główną
sedan.
Warianty i konfiguracje
Projekt startowy zawiera Component, Battery, Controller, Car i Powertrain.
- Zaimportuj pakiet zmienności. Dodaj
private import HolarchVariability::*;. - Napisz zmienność. W pustym wierszu naciśnij ⌃⇧Space / Ctrl+Shift+Space (lub kliknij Wstaw ▾), wybierz Zmienność i uzupełnij
variation part def BatteryPack :> Batteryo wariantystandardPack(1.4 kWh) ilargePack(12 kWh, 120 kg). - Napisz linię produktów. Dodaj
part def CarLine :> Carzpart pack : BatteryPack;,variation part chargerz wariantaminoChargeriwallboxorazassert constraint wallboxNeedsLargePack { charger == charger::wallbox implies pack == BatteryPack::largePack }. - Rozpocznij konfigurację. Wybierz Wstaw ▾ → Konfiguracja i uzupełnij
part plugInHybrid : CarLine { @HolarchConfiguration; }. Edytor wskazuje punkty zmienności, które są nadal otwarte. - Wybierz warianty. W
plugInHybridwybierz Wstaw ▾ → Wybór wariantu dla każdego punktu i uzupełnijpart :>> pack = BatteryPack::largePack;orazpart :>> charger = charger::wallbox;. - Dodaj drugą konfigurację. W ten sam sposób dodaj
selfChargingHybridze standardowym pakietem akumulatorów i bez ładowarki. - Zdefiniuj własne słowo kluczowe. Dodaj
metadata def <safetyCritical> SafetyCritical. - Użyj słowa kluczowego. W
Powertrainnapisz#safetyCritical part controller : Controller;. - Zobacz linię produktów. Utwórz widok ogólny pakietu
Vehicles: pakiet akumulatorów jest oznaczony jako zmienność.
Projekty samouczków
Projekty samouczków SysML v2 podlegają tym samym zasadom co inne projekty samouczków: nie wliczają się do aktywnych projektów planu, mieszczą do 300 elementów i można mieć jeden na samouczek. Zobacz Samouczki.
Powiązane
- Samouczki
- Pierwsze kroki z projektami SysML v2
- Edytor tekstu i Przeglądarka
- Notacja tekstowa
- Widoki
- Wymagania w projektach SysML v2
SysML® i OMG® są zastrzeżonymi znakami towarowymi Object Management Group, Inc. w Stanach Zjednoczonych i innych krajach.