Holarch

SysML v2

Notacja tekstowa SysML v2

Język SysML v2 w zakresie obsługiwanym przez Holarch, z przykładami z projektu demonstracyjnego Hybrid Car, wykonywanymi kontrolami i Biblioteką standardową tylko do odczytu.

Jak z niego korzystać →

Na tej stronie
  1. Przegląd
  2. Pojęcia
    1. Elementy, właściciele i nazwy kwalifikowane
    2. Pakiety
    3. Importy i widoczność
    4. Definicje i użycia
    5. Typowanie, specjalizacja i redefinicja
    6. Krotności
    7. Wartości i jednostki
    8. Struktura: porty, połączenia, interfejsy, wiązania i przepływy
    9. Zachowanie: akcje
    10. Zachowanie: stany
    11. Wymagania, ograniczenia i weryfikacja
    12. Przypadki użycia
    13. Widoki
    14. Komentarze, dokumentacja i metadane
    15. Indywidua, migawki i wycinki czasowe
    16. Zmienności, warianty i konfiguracje
    17. Reprezentacje tekstowe
  3. Jak z niego korzystać
    1. Modelowanie struktury
    2. Podawanie wartości z jednostkami
    3. Opisywanie zachowania
    4. Pisanie wymagania i jego śledzenie
    5. Oznaczanie wartości jako TBD lub TBR
    6. Znajdowanie nazwy w bibliotece
  4. Przykład: odczytanie wymagania sedana
  5. Wskazówki i typowe błędy
  6. Co obsługuje Holarch
    1. Zachowane tak, jak zapisano, bez interpretacji
    2. Jeszcze niedostępne
  7. Kontrole
  8. Biblioteka standardowa
  9. Limity
  10. Powiązane strony

Przegląd

SysML v2 opisuje system jako drzewo nazwanych elementów zapisane w postaci tekstu. Holarch obsługuje notację tekstową SysML v2 opartą na specyfikacji OMG SysML v2. Tekst pisze się w Edytorze, a Holarch pokazuje te same elementy w Przeglądarce, widokach, tabelach i na stronach cyklu życia.

Ta strona uczy notacji na przykładach z projektu demonstracyjnego Hybrid Car (SysML v2). Następnie wymienia, co Holarch obsługuje, jakie kontrole wykonuje na tekście, oraz opisuje Biblioteka standardowa.

Pojęcia

Elementy, właściciele i nazwy kwalifikowane

Każdy element ma jednego właściciela, z wyjątkiem pakietów najwyższego poziomu. Nazwa kwalifikowana elementu to ciąg nazw jego właścicieli połączonych znakami ::. W projekcie demonstracyjnym akumulator definicji układu napędowego to Vehicles::Powertrain::battery.

Nazwę ze spacjami lub innymi znakami specjalnymi zapisuje się w apostrofach: 'Fuel Tank'. Nazwa skrócona w nawiasach ostrych nadaje elementowi drugi, krótki identyfikator: requirement def <'VR-1'> CurbMass. Holarch używa nazwy skróconej wymagania jako jego numeru.

Pakiety

Pakiet grupuje elementy, podobnie jak folder. Pakiety można zagnieżdżać. Każdy pakiet najwyższego poziomu jest jednym dokumentem w Edytorze.

package Vehicles {
    doc /* A hybrid passenger car: structure, interfaces and variants. */

    private import ScalarValues::*;
    private import ISQ::*;
    private import SI::*;
}

Importy i widoczność

Import udostępnia składowe innego pakietu pod ich krótkimi nazwami.

  • import ISQ::*; importuje składowe ISQ.
  • import VehicleRequirements::**; importuje także składowe elementów zagnieżdżonych (rekurencyjnie).
  • import Vehicles::Car; importuje jeden element.
  • import Vehicles::*[@SysML::PartDefinition]; importuje tylko składowe jednego rodzaju (import filtrowany).

private, protected i public określają, kto jeszcze widzi składową lub import. Projekt demonstracyjny używa private import, aby importy nie przechodziły dalej do pakietów, które z kolei importują dany pakiet.

Bez importu należy napisać nazwę kwalifikowaną: ISQ::MassValue jest rozpoznawana wszędzie, a MassValue tylko tam, gdzie zaimportowano ISQ.

alias nadaje elementowi drugą nazwę: alias Hybrid for Car;.

Definicje i użycia

Definicja opisuje rodzaj rzeczy. Użycie to jedno zastosowanie definicji wewnątrz innego elementu. Większość słów kluczowych występuje w obu formach:

DefinicjaUżycieCo to jest
part def Battery;part battery : Battery;System, podsystem lub komponent
attribute def TirePressure;attribute mass : MassValue = 45 [kg];Wartość, często z jednostkami
item def Fuel;item fuel : Fuel;Coś, co przepływa lub jest obsługiwane
port def FuelPort { … }port fuelOut : FuelPort;Punkt połączenia na części
connection def … / interface def FuelLine { … }interface fuel : FuelLine connect …;Połączenie między częściami lub portami
action def ProduceTorque { … }action produce : ProduceTorque;Zachowanie: krok, który przyjmuje wejścia i daje wyjścia
state def PowertrainStates { … }state off;Zachowanie: stan i jego przejścia
constraint def MassLimit { … }constraint …;Warunek logiczny na wartościach
calc def PowerToWeight { … }calc …;Obliczenie z wartością return
requirement def <'VR-1'> CurbMass { … }requirement <'VR-1.1'> sedanMass : CurbMass;Wymaganie
use case def DriveToWork { … }use case commute : DriveToWork;Przypadek użycia
analysis def PowerToWeightAnalysis { … }analysis sedanPowerToWeight : …;Przypadek analizy
verification def CurbMassTest { … }verification sedanWeighing : CurbMassTest;Przypadek weryfikacji
view def RequirementsView { … }view driveCycleFlow : ActionFlowView { … }Widok modelu
enum def DriveMode { … }attribute mode : DriveMode;Stały zbiór wartości

Składowe zagnieżdżone w definicji należą do każdego jej użycia. part frontAxle : Axle; ma differential, leftWheel i rightWheel z Axle bez ich powtarzania.

Typowanie, specjalizacja i redefinicja

Cztery operatory wiążą definicje i użycia. Każdy ma też formę słowa kluczowego.

OperatorSłowo kluczoweZnaczeniePrzykład
:defined byTypuje użycie definicjąpart engine : Engine;
:> przy definicjispecializesDefinicja jest rodzajem drugiej definicji i dziedziczy jej składowepart def FuelTank :> Component
:> przy użyciusubsetsUżycie jest podzbiorem innego użyciapart spareWheel :> wheels;
:>>redefinesZastępuje odziedziczone użycie, na przykład aby nadać mu wartośćattribute redefines mass = 18 [kg];
~Sprzęga port: jego cechy in i out zamieniają się miejscamiport fuelIn : ~FuelPort;

Redefinicja to sposób, w jaki wariant lub skonfigurowana część zmienia to, co dziedziczy. W projekcie demonstracyjnym SportCar usuwa koło zapasowe przez redefinicję:

part def SportCar :> Car {
    attribute topSpeed : SpeedValue = 210 [km/h];
    part redefines spare [0];
}

abstract oznacza definicję, która nie ma bezpośrednich instancji (abstract part def Component). ref oznacza odwołanie, które nie jest posiadane. in, out i inout określają kierunek cechy lub parametru. end oznacza końce definicji połączenia lub interfejsu.

Krotności

Krotność w nawiasach kwadratowych określa, ile jest egzemplarzy.

  • [2]: dokładnie dwa. part runabout : CityCar [2];
  • [0..1]: opcjonalny. part spare : Wheel [0..1];
  • [1..*] i [*]: jeden lub więcej, dowolna liczba.
  • [0]: żaden; używane do usunięcia odziedziczonej części.
  • Granice mogą być wyrażeniami. ordered i nonunique następują po nawiasach.

Wartości i jednostki

= wiąże wartość. := nadaje wartość początkową, która może się zmienić. default nadaje wartość domyślną, którą redefinicja może zastąpić.

attribute maxCurbMass : MassValue = 1650 [kg];
attribute minBatteryCapacity : EnergyValue = 1.2 [kW*h];
attribute minPowerToWeight = 40 [W/kg];
attribute topSpeed : SpeedValue = 210 [km/h];

Wielkość to liczba z jednostką w nawiasach kwadratowych. Jednostki łączy się za pomocą *, / i ^ ([m/s^2]). Rodzaje wielkości, takie jak MassValue, pochodzą z ISQ, a jednostki, takie jak kg, z SI (lub USCustomaryUnits). Holarch sprawdza wymiary: przypisanie 5 [s] do MassValue jest błędem.

Wyrażenia korzystają z arytmetyki, porównań (<=, ==), operatorów logicznych (and, or, not, implies), wyrażenia warunkowego if c ? a else b, łańcuchów cech (car.powertrain.battery.capacity), wywołań obliczeń (PowerToWeight(power, mass)) i operacji na sekwencjach, takich jak ->sum, ->size, ->select i ->collect. Holarch oblicza je z jednostkami na potrzeby wartości, ograniczeń, widoków i stron analizy.

Struktura: porty, połączenia, interfejsy, wiązania i przepływy

Części łączą się przez swoje porty.

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; łączy dwie części lub dwa porty.
  • Interfejs to typowane połączenie między portami. Jego definicja nazywa jego końce: interface def FuelLine { end supply : FuelPort; end consumer : ~FuelPort; }.
  • Każdy koniec połączenia lub interfejsu może mieć nazwę i krotność: interface motorShaft : Shaft connect [1] driver ::> motor.output to [1] driven ::> transmission.motorIn;. Nazwany koniec jest cechą połączenia, więc motorShaft.driver się do niego odwołuje.
  • bind a = b; oznacza, że dwie cechy są tym samym (łącznik wiążący).
  • flow of Fuel from supply.fuel to produce.fuel; przenosi obiekt z jednej cechy do drugiej. message wysyła obiekt między częściami jako zdarzenie.

Zachowanie: akcje

Definicja akcji zawiera swoje kroki (użycia akcji), parametry i kolejność kroków.

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;
}
  • Następstwa porządkują kroki: first a then b; lub then b; bezpośrednio po a. start i done to początek i koniec.
  • Węzły sterujące: fork i join dla ścieżek równoległych; decide i merge dla alternatyw. Następstwo z warunkiem po decyzji ma postać if speed > 30 then cruise;, a else brake; to gałąź domyślna.
  • Zakończenie: terminate; natychmiast kończy akcję nadrzędną wraz ze wszystkimi jej krokami, które nadal trwają; then terminate; umieszcza je po poprzednim kroku. terminate x; kończy wystąpienie x.
  • Inne akcje: accept czeka na sygnał, send wysyła sygnał, assign x := expr; zmienia wartość, if wykonuje blok lub go pomija, a while … { … } until …; i for v in seq { … } powtarzają blok.
  • Alokacja zachowania: część wykonuje akcję słowem kluczowym perform (perform action trip : DriveCycle;, perform trip.supply;), a allocate a to b; alokuje jeden element do drugiego.

Zachowanie: stany

Definicja stanu zawiera stany i przejścia między nimi.

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; ustala stan początkowy.
  • Przejścia mają wyzwalacz (accept StartRequest), opcjonalny warunek dozoru (if charge > 20) i opcjonalny efekt (do …). Forma krótka następuje po stanie źródłowym; forma długa to transition name first a … then b;.
  • W modelu wyzwalacz i efekt przejścia są osobnymi elementami: akcją przyjęcia i akcją (send, assign, perform, terminate lub akcja nazwana). Przeglądarka pokazuje je jako trigger i effect pod przejściem. Są własnymi accepter i effect przejścia, więc inne części modelu mogą się do nich odwoływać: chargerStates.plugIn.effect.sentMessage to komunikat wysyłany przez efekt, tak jak wiąże go model sekwencji.
  • Wyzwalacz przez port musi przyjmować coś, co port przenosi: w ChargeManager z projektu demonstracyjnego accept connectCharger : ChargerConnected via chargePort pasuje do in connected : ChargerConnected portu. Efekt send new ChargeRequest() to controller wysyła komunikat do części; wartość, taka jak atrybut, nie może odebrać komunikatu.
  • Akcje entry, do i exit są wykonywane przy wejściu do stanu, w trakcie przebywania w nim i przy jego opuszczaniu. Stany parallel mają regiony, które są aktywne jednocześnie.
  • Część wykazuje stan słowem kluczowym exhibit: exhibit state powertrainStates : PowertrainStates;.

Wymagania, ograniczenia i weryfikacja

Wymaganie przechowuje swoją treść w doc, element, którego dotyczy, jako subject, a sprawdzalny warunek jako 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 określa warunek, który wymaganie zakłada. Gdy nie jest on spełniony, to wymaganie i zagnieżdżone w nim wymagania są liczone jako spełnione; otaczające je wymaganie i pozostałe zagnieżdżone wymagania są nadal sprawdzane. actor, stakeholder i frame concern określają, dla kogo i czego jest wymaganie.
  • satisfy R by part; oznacza, że część spełnia wymaganie.
  • Przypadek weryfikacji weryfikuje wymagania w swoim celu: objective { verify carSpec.sedanMass; }. Może zawierać return verdict : Boolean = …;.
  • Przypadek analizy ma podmiot, cel i wynik return, który Holarch oblicza, gdy każde wejście ma wartość. Atrybuty przypadku bez wartości są wyznaczane z równań == jego celu (Przypadki analizy z niewiadomymi).
  • connection : Derivation connect original to derived; zapisuje wymaganie wyprowadzone. #refinement dependency x to R; zapisuje uszczegółowienie.
  • dependency from a to b; zapisuje ogólne powiązanie śledzenia.

Przypadki użycia

use case def DriveToWork { subject car : Car; actor driver : Driver; objective { … } include use case startCar : StartCar; }. Użycie przypadku użycia przejmuje podmiot i aktorów swojej definicji.

Widoki

Widok pokazuje część modelu. Jest typowany standardową definicją widoku i udostępnia słowem kluczowym expose to, co pokazuje:

view driveCycleFlow : StandardViewDefinitions::ActionFlowView {
    expose DriveCycle;
}

filter zawęża elementy (filter @SysML::RequirementUsage;). render wybiera sposób renderowania. viewpoint określa zagadnienia, którymi widok musi się zająć. Strona Widoki SysML v2 objaśnia każdy rodzaj widoku.

Komentarze, dokumentacja i metadane

  • doc /* text */ dokumentuje swojego właściciela. Jest częścią modelu; w przypadku wymagania jest to tekst wymagania.
  • comment about x /* text */ to notatka w modelu o innym elemencie.
  • // text i //* text */ to notatki tylko w tekście. Holarch zachowuje je w tekście, ale nie są elementami modelu.
  • Metadane opisują element: @TBD { owner = "Powertrain lead"; } w treści, #TBR attribute limit … jako prefiks lub metadata Capability about Vehicles::Car; z zewnątrz.
  • Własne słowa kluczowe: każda definicja metadanych działa jako słowo kluczowe: #safetyCritical part controller : Controller; oznacza sterownik metadanymi SafetyCritical (nazwa skrócona <safetyCritical>). Definicja metadanych może ograniczać to, co oznacza: :>> annotatedElement : SysML::PartDefinition; dopuszcza tylko definicje części.
  • Metadane semantyczne: definicja metadanych specjalizująca SemanticMetadata ustala typ bazowy, :>> baseType = faults meta SysML::Usage;. Każdy oznaczony nią element specjalizuje wtedy typ bazowy: użycie jest podzbiorem użycia bazowego, a definicja specjalizuje definicję bazową lub definicje użycia bazowego. Zatem #fault def BatteryOverheat; i #fault overheat : BatteryOverheat; są usterkami i mają cechy Fault. Przy metadanych semantycznych słowo kluczowe języka można pominąć, jak w tych dwóch wierszach; Przeglądarka pokazuje je z ich słowem kluczowym (#fault def). Zapis z zewnątrz, metadata Fault about x;, nie czyni x usterką: kontrola ostrzega i proponuje oznaczenie samego x przez #fault.
  • Metadane z własnym znaczeniem: cechy definicji metadanych to to, co musi podać każde jej użycie, a jej ograniczenia muszą być dla nich spełnione. Przy metadata def SafetyRating { attribute level : Natural; assert constraint { level >= 1 and level <= 4 } } kontrola zgłasza @SafetyRating; (brak poziomu) i @SafetyRating { level = 7; } (poza zakresem); @SafetyRating { level = 4; } jest poprawne. Cechę z wartością lub default w definicji albo zadeklarowaną jako [0..1] można pominąć. Każda wartość musi pasować do typu swojej cechy: true lub false dla Boolean, tekst w cudzysłowie dla String, liczba całkowita dla Integer (0 lub więcej dla Natural, powyżej 0 dla Positive), a dla wyliczenia jedna z jego wartości, na przykład HazardAnalysis::fmea; kontrola zgłasza każdą inną wartość oraz wartość domyślną w definicji, która nie pasuje. Treść metadanych nadaje tylko wartości cechom definicji (level = 4;), a abstract metadata def nie można zastosować. Projekt demonstracyjny Hybrid Car ocenia swój sterownik jako @SafetyRating { level = 4; } i zapisuje przegląd akumulatora jako @SafetyReview { method = HazardAnalysis::fmea; closed = true; }. W Edytorze Wstaw ▾ → Definicja metadanych rozpoczyna definicję z cechą i regułą, a Zastosuj metadane stosuje metadane wewnątrz treści. Bez pisania tekstu: zaznacz definicję lub użycie i użyj sekcji Metadane inspektora. Dodaj metadane stosuje jedną z definicji metadanych projektu; każda cecha ma wtedy pole (lista wartości dla wyliczenia lub Boolean, zwykły tekst dla String, który Holarch zapisuje w cudzysłowie; wartość domyślna definicji jest pokazywana jako podpowiedź, a cecha bez niej jest oznaczona jako Wymagane); ustalenia kontroli dotyczące tych metadanych są pokazywane pod nimi; Usuń je zdejmuje. Każdą zmianę można cofnąć jednym poleceniem Cofnij. Metadane z biblioteki standardowej i własne metadane Holarch (symulacja, cele, zmienność) mają własne kontrolki i nie są tam wymienione.

Indywidua, migawki i wycinki czasowe

Indywiduum to jedna konkretna rzecz w całym okresie jej istnienia, na przykład jeden samochód z jego numerem seryjnym, a nie rodzaj rzeczy. Migawka to ta rzecz w jednej chwili; wycinek czasu to okres jej istnienia. Oba należą do wystąpienia, które je posiada, i mają jego cechy, więc mogą nadawać tym cechom własne wartości.

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 stoi przed słowem kluczowym rodzaju (individual part def, individual item def) lub samodzielnie (individual def Plate_77;). Użycie zapisane jako individual jest typowane dokładnie jedną definicją indywiduum: individual car1 : Car_VIN1234;.
  • snapshot i timeslice stoją przed słowem kluczowym rodzaju lub samodzielnie, wewnątrz części, obiektu, akcji lub innego wystąpienia. then timeslice secondOwner; umieszcza wycinek czasu po poprzedzającej go składowej.
  • Wartość wewnątrz migawki lub wycinka czasu jest odczytywana najpierw tam, potem z indywiduum, a następnie z jego definicji. W przykładzie atService.mileage wynosi 15,000 km i ograniczenie jest spełnione.
  • Indywiduami, migawkami lub wycinkami czasu mogą być tylko wystąpienia: atrybuty i wyliczenia są wartościami.
  • W Architektura → Części, w widokach bazy danych i siatki kolumna Instancje wymienia indywidua definicji każdej części (dla part sedan : Car: Car_VIN1234): definicje indywiduów, które ją specjalizują, i użycia indywiduów, które typuje. Indywidualne (Tak) i Część czasowa (Migawka lub Wycinek czasu) również są kolumnami (Kolumny ▾ → SysML v2). Gdy model ma indywiduum, strona Części domyślnie pokazuje Instancje, a eksport Tabela (CSV) zawiera wtedy te trzy kolumny; eksport Definicje wymienia je dla każdego elementu, który je ma.
  • W inspektorze Wystąpienie w sekcji Cechy ustawia Indywidualne, a dla użyć Całe istnienie, Wycinek czasu lub Migawka. Filtr rodzajów w Przeglądarce ma pozycję Indywidua, a menu ⋯ wiersza ma Nowa migawka… i Nowy wycinek czasu…. Widok ogólny pokazuje «individual part def», «snapshot» i «timeslice» w nagłówkach pól, wymienia migawki i wycinki czasu pola w osobnej sekcji i rysuje następstwa między polami jako przerywane strzałki; Rozmieść ▾ → Ułóż jako oś czasu ustawia je w linii od lewej do prawej. W projekcie demonstracyjnym Hybrid Car widok ogólny carLifeline pokazuje migawki i wycinek czasu Car_VIN1234.

Zmienności, warianty i konfiguracje

Zmienność wymienia wybory dozwolone w jednym punkcie projektu; każdy wybór to wariant. Definicja zmienności (variation part def) to zbiór wyborów wielokrotnego użytku; użycie zmienności (variation part charger) to punkt wewnątrz jednego projektu. Konfiguracja wybiera jeden wariant dla każdego punktu.

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;
}
  • Wariant ma cechy swojej zmienności i może je redefiniować: largePack ma capacity, ponieważ BatteryPack jest Battery.
  • variant x; bez słowa kluczowego rodzaju czyni istniejące użycie x jednym z wyborów; wariant otrzymuje nazwę od x.
  • Zmienność posiada tylko warianty (oraz definicje, komentarze, metadane i importy). Zmienność jest już abstrakcyjna, więc abstract przy niej jest oznaczane jako zbędne.
  • Wariant wybiera się wartością: part :>> pack = BatteryPack::largePack;. Wybór, który nie jest wariantem danego punktu, jest błędem.
  • Dopóki punkt nie ma wyboru, jego wartość jest nieznana, więc asercja na nim nie jest ani spełniona, ani naruszona. W konfiguracji używane są wartości wybranych wariantów.
  • Oznacz konfigurację przez @HolarchConfiguration (pakiet HolarchVariability, w Bibliotece standardowej w folderze Holarch): Edytor wskazuje wtedy każdy punkt, który nie został jeszcze wybrany.
  • W Edytorze Wstaw ▾ zapisuje każdą z tych konstrukcji: Zmienność (definicja na poziomie pakietu, punkt wewnątrz części), Wariant (wewnątrz zmienności), Konfiguracja i Wybór wariantu (wewnątrz konfiguracji).
  • W projekcie demonstracyjnym Hybrid Car CarLine ma dwa punkty (pack i charger), a selfChargingHybrid i plugInHybrid są jego konfiguracjami; asercja wyklucza wallbox ze standardowym pakietem akumulatorów.

Reprezentacje tekstowe

Reprezentacja tekstowa zapisuje element w innym języku: rep language "Python" /* … */ w treści elementu. Treść jest przechowywana jako tekst. Model to to, co deklaruje otaczający ją kod SysML; Holarch nigdy nie wykonuje treści.

  • W projekcie demonstracyjnym Hybrid Car DriveWheels zawiera swoje obliczenie w języku Python: rep language "Python" /* wheel_speed = torque.value * GEAR_RATIOS[gear] / WHEEL_RADIUS */.
  • Treść w "sysml" lub "kerml" jest sprawdzana. SpeedLimit jest zapisane jako rep language "sysml" /* speed <= limit */, a Holarch oblicza je jak ograniczenie zapisane bezpośrednio.
  • Edytor wyróżnia treści SysML i KerML jako kod na zabarwionym tle. Inne języki są wyświetlane jako tekst komentarza.
  • Sekcja Reprezentacja inspektora wymienia każdą reprezentację z jej polami Język i treścią. Kliknij Dodaj reprezentację przy definicji lub użyciu, aby ją dodać, a Usuń, aby ją usunąć.
  • Widok przepływu akcji oznacza akcję, której definicja ma reprezentację, nazwą jej języka w nawiasach klamrowych, na przykład {Python}.
  • Znane języki: SysML, KerML, OCL, Alf, Python, JavaScript, MATLAB, Modelica, C, język naturalny (naturalLanguage, English, text). Wersja po nazwie jest ignorowana (OCL2.0, Python 3).
  • Treść nie może zawierać */, co zakończyłoby komentarz.

Własne komentarze dyskusji Holarch, etykiety, osoby przypisane i terminy są przechowywane obok modelu. Nie są zapisywane w tekście.

Jak z niego korzystać

Modelowanie struktury

  1. W Edytorze otwórz pakiet (lub kliknij + Nowy pakiet).
  2. Napisz port def dla każdego rodzaju punktu połączenia, z cechami kierunkowymi (out attribute torque : TorqueValue;).
  3. Napisz part def dla każdego rodzaju komponentu, z jego atrybutami i portami.
  4. Napisz part def dla zespołu, z part dla każdego komponentu.
  5. Połącz części: connect a.p to b.q; lub interface name : Def connect a.p to b.q;.
  6. Zrób przerwę w pisaniu. Wiersz stanu pokazuje Zastosowano, a Przeglądarka pokazuje nowe elementy.

Wstaw ▾ (lub ⌃⇧Space / Ctrl+Shift+Space) zapisuje każdą z tych konstrukcji za użytkownika, z polami do wypełnienia. Zobacz Wstawianie konstrukcji.

Podawanie wartości z jednostkami

  1. Zaimportuj rodzaje wielkości i jednostki na początku pakietu: private import ISQ::*; i private import SI::*;.
  2. Otypuj atrybut rodzajem wielkości i nadaj mu wartość: attribute mass : MassValue = 45 [kg];.
  3. W definicji, która dziedziczy atrybut, zredefiniuj go z własną wartością: attribute redefines mass = 18 [kg];.
  4. Wskaż wartość. Jeśli jednostka nie pasuje do rodzaju wielkości, pojawia się karta błędu.

Opisywanie zachowania

  1. Napisz action def z parametrami in i out.
  2. Dodaj krok dla każdego użycia action i uporządkuj je za pomocą first … then …; lub then.
  3. Użyj fork i join dla kroków równoległych, a decide i merge dla alternatyw.
  4. Dodaj flow of Item from a.out to b.in; między krokami, które przekazują obiekty.
  5. W części, która realizuje zachowanie, napisz perform action name : Def;, a w jej częściach perform name.step;.
  6. Otwórz akcję w widoku przepływu akcji, aby zobaczyć ją narysowaną (zobacz Widoki SysML v2).

Pisanie wymagania i jego śledzenie

  1. Napisz requirement <'ID'> name { doc /* The system shall … */ subject s : Def; }.
  2. Dodaj require constraint { … }, gdy wymaganie można sprawdzić względem wartości.
  3. Napisz satisfy name by somePart; tam, gdzie projekt je spełnia.
  4. Napisz verification, której cel je weryfikuje przez verify.
  5. Otwórz Potrzeby i wymagania → Wymagania: wymaganie jest wymienione z numerem, a Weryfikacja → RVTM pokazuje, jak jest weryfikowane. Zobacz Wymagania i weryfikacja w projektach SysML v2.

Oznaczanie wartości jako TBD lub TBR

Wpisanie TBD zamiast wartości nie jest poprawnym kodem SysML. Zamiast tego użyj metadanych Holarch.

  1. Zaimportuj je: private import HolarchMetadata::*;.
  2. Dodaj prefiks do atrybutu: #TBD attribute chargerPower : PowerValue; (jeszcze bez wartości) lub #TBR attribute limit : TimeValue = 0.5 [h]; (wartość do przeglądu).
  3. Aby zapisać właściciela i powód, napisz formę długą w treści atrybutu: @TBD { owner = "Powertrain lead"; rationale = "The charging standard is not chosen yet."; due = "2026-12-01"; }.

Rejestr TBD/TBR wymienia te wartości. TBD i TBR specjalizują ModelingMetadata::StatusInfo, więc inne narzędzia SysML v2 odczytują je jako adnotacje stanu. Wstaw ▾ → Wartość TBD i Wartość TBR zapisują je za użytkownika.

Znajdowanie nazwy w bibliotece

  1. Otwórz Biblioteka standardowa z narzędzi paska nawigacji.
  2. Wpisz część nazwy w polu Znajdź pakiet lub definicję…, na przykład MassValue.
  3. Kliknij Kopiuj nazwę w wierszu. Nazwa kwalifikowana, tutaj ISQBase::MassValue, zostaje skopiowana.
  4. Wklej ją w Edytorze albo zaimportuj jej pakiet i użyj krótkiej nazwy.

Przykład: odczytanie wymagania sedana

Ten przykład śledzi jedno wymaganie w tekście projektu demonstracyjnego Hybrid Car.

  1. Otwórz projekt demonstracyjny i wybierz VehicleRequirements z listy Pakiety w Edytorze.
  2. Znajdź requirement def <'VR-1'> CurbMass. Jego require constraint { car.curbMass <= limit } porównuje masę własną podmiotu z limit.
  3. Znajdź requirement carSpec. Zawiera requirement <'VR-1.1'> sedanMass : CurbMass { attribute :>> limit = maxCurbMass; }. Użycie redefiniuje limit wartością docelową z poziomu pakietu maxCurbMass = 1650 [kg].
  4. Znajdź satisfy carSpec by fleet.sedan;. Kliknij sedan z klawiszem ⌘ / Ctrl: Edytor otwiera Vehicles w miejscu part sedan : Car, gdzie attribute redefines curbMass = 1580 [kg]; podaje wartość.
  5. Z powrotem w VehicleRequirements znajdź verification def CurbMassTest. Jego cel verify carSpec.sedanMass; czyni go przypadkiem weryfikacji VR-1.1, a verification sedanWeighing : CurbMassTest { subject car = fleet.sedan; } stosuje go do sedana.
  6. Zmień 1580 [kg] na 1700 [kg] w Vehicles i zrób przerwę w pisaniu. Sedan przekracza teraz limit 1650 kg, a Edytor pokazuje w VehicleRequirements ostrzeżenie, że sedan nie spełnia wymagania, wraz z fałszywym ograniczeniem i jego wartościami. Cofnij za pomocą ⌘Z / Ctrl+Z.

Wskazówki i typowe błędy

  • “…” is not defined here. (nazwa nie jest tu zdefiniowana) Nazwa zawiera literówkę lub jej pakiet nie jest zaimportowany. Dodaj private import Package::*; lub napisz nazwę kwalifikowaną.
  • Brak ;. Każda deklaracja kończy się znakiem ; lub treścią { … }. The declaration does not end. Add ; or a { … } body.
  • :> a :>>. Użyj :>, aby specjalizować lub tworzyć podzbiór; użyj :>>, aby zastąpić odziedziczoną cechę. Redefinicja cechy, która nie jest odziedziczona, daje komunikat “x” is not inherited by “y”.
  • Jednostki wymagają importów. 5 [kg] jest rozpoznawane tylko tam, gdzie widoczny jest SI.
  • Dwie składowe o jednej nazwie. “x” is already used in this namespace. Zmień nazwę jednej z nich; wariant zamiast tego redefiniuje.
  • verify poza celem. Umieść go w objective { verify R; } przypadku weryfikacji.
  • Słowa kluczowe jako nazwy. Słowa takie jak part, state czy action są zastrzeżone. Ujmij je w apostrofy ('state') lub wybierz inną nazwę.

Co obsługuje Holarch

Holarch obsługuje następujące części notacji tekstowej SysML v2. Edytor sprawdza je wszystkie, a model je zachowuje.

ObszarObsługiwane
Pakiety i przestrzenie nazwpackage, pakiety zagnieżdżone, library package (tylko do odczytu), doc, comment … about, notatki // i //* */, alias … for …, public/private/protected, nazwy skrócone <'1.2'>, nazwy w apostrofach
Importyimporty składowych i przestrzeni nazw, ::*, rekurencyjne ::**, importy filtrowane [@Kind]
Definicje i użyciapart, 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
Specjalizacja:>/specializes, :/defined by, :>/subsets, :>>/redefines, sprzężenie ~, disjoint, łańcuchy cech a.b.c
Krotności[n], [n..m], [*], [0..*], ordered, nonunique, wyrażenia jako granice
Wartości i jednostki=, :=, default, wielkości 5 [kg], wyrażenia jednostek [m/s^2], rodzaje wielkości ISQ oraz jednostki SI i zwyczajowe jednostki USA z biblioteki standardowej, kontrole wymiarów
Strukturaporty i porty sprzężone, connect, interfejsy z końcami, nazwane końce łączników z krotnościami, bind, flow of T from … to …, message
Akcjeparametry, perform, następstwa (first … then …, then), fork, join, decide, merge, warunki dozoru, accept, send, assign, if, while, for, loop, start, done, terminate
Stanyentry/do/exit, przejścia z wyzwalaczem, warunkiem dozoru i efektem, stany parallel, stany zagnieżdżone, exhibit
Wymaganiasubject, actor, stakeholder, require constraint, assume constraint, frame concern, satisfy … by …, verify, nazwy skrócone jako identyfikatory, doc jako tekst wymagania
Ograniczenia i obliczeniadefinicje i użycia ograniczeń i obliczeń, return, assert constraint, wywołania, wyrażenia KerML z arytmetyką, porównaniami, logiką, if ? else i operacjami na sekwencjach, obliczanie z jednostkami
Przypadki użycia, analiza i weryfikacjasubject, actor, objective, include use case, przypadki analizy z wynikiem return, przypadki weryfikacji z verify i werdyktem
Widokiview, view def, expose (z ::*, ::** i filtrami), filter, viewpoint, frame, render, standardowe definicje widoków
Alokacja i powiązania śledzeniaallocate a to b, definicje alokacji, dependency from … to …
Indywiduadefinicje i użycia individual, snapshot i timeslice (także po then), ich wartości i następstwa
Zmiennośćdefinicje i użycia variation, składowe variant i odwołania do wariantów (variant x;), wybory przez wartość, konfiguracje oznaczone @HolarchConfiguration (HolarchVariability)
Metadane@Name { … }, prefiks #Name, metadata Name about …, pakiety Holarch HolarchMetadata (TBD, TBR) i HolarchFrameworks; własne metadata def; własne słowa kluczowe i metadane semantyczne (#fault def …)

Zachowane tak, jak zapisano, bez interpretacji

Holarch odczytuje i zachowuje te konstrukcje dokładnie tak, jak zostały zapisane, ale nie nadaje im własnego znaczenia:

  • reprezentacje tekstowe w językach innych niż SysML i KerML (przechowywane jako tekst; zobacz Reprezentacje tekstowe).

Jeszcze niedostępne

  • Import plików KerML (.kerml).
  • Commity do main, tagi i scalenia przez Systems Modeling API: inne narzędzia zatwierdzają zmiany w gałęziach wniosków o zmianę, które osoba zatwierdzająca stosuje w Holarch (zobacz API i MCP w projektach SysML v2).
  • Rozszerzenia języka wykraczające poza własne słowa kluczowe i metadane semantyczne.

Kontrole

Holarch sprawdza tekst w trakcie pisania. Każdy problem jest oznaczany na marginesie Edytora i podkreślany; komunikat podaje problem, a następnie sposób poprawki. Błędy uniemożliwiają zastosowanie składowej; ostrzeżenia nie.

ObszarCo jest sprawdzanePrzykładowy komunikat
SkładniaZnaki, komentarze, ciągi znaków, nawiasy klamrowe, ;, oczekiwane nazwy i tokenyThis brace has no partner. Add the matching { or }, or delete this one.
NazwyNazwy nierozpoznane, niejednoznaczne, nieprawidłowe, zduplikowane (ostrzeżenie) i prywatne“Batery” is not defined here. Check the spelling, or import its package.
Typowanie i specjalizacjaCykle; typowanie i specjalizacja definicją właściwego rodzaju; tworzenie podzbiorów i redefinicja cech; redefinicja wyłącznie odziedziczonych cech“capacity” is not inherited by “Car”. Specialize its type, or subset it with :> instead.
KrotnościPrawidłowe i całkowite granice; redefinicja nie szersza niż to, co redefiniujeMultiplicity [3..1] is not valid. Use a lower bound from 0 up to the upper bound.
Jednostki i wartościZgodność wymiarów, brakujące jednostki, nazwy jednostek, typy liczbThe units do not match: kg and s. Convert one side to a compatible unit.
WyrażeniaSkładnia, typy operandów, argumenty obliczeń, warunki logiczneThe condition must be true or false; it is a number. Write a comparison such as x > 0.
StrukturaKońce połączeń są cechami, interfejsy łączą porty, kierunki portów, przepływów i komunikatów, typy obiektów przepływu, typy wiązańThese port directions do not fit together. Conjugate one port (~) or change a direction.
AkcjeNastępstwa między akcjami tej samej treści, liczba wejść i wyjść węzłów sterujących, warunki dozoru decyzji i else, start i done, przypisania, cele perform, wartości, po których iteruje pętla for, względem typu zmiennej pętlithen needs an earlier action. Add an action or first … then ….
StanyPrzejścia między stanami tej samej treści, po jednej akcji entry/do/exit, przejścia początkowe, regiony równoległe, cele exhibit, efekt do przejścia (send do czegoś, co może odbierać, assign, accept, action lub akcja nazwana), ładunek wyzwalacza względem obiektów jego portu, wyzwalacz na samej wartości bibliotecznej, takiej jak Real (ostrzeżenie), wyzwalacze at, które wskazują czas“electric” has substates but no initial transition, so none of them is entered. Add entry; then <first state>;.
Wymagania, przypadki i widokiSkładowe we właściwym miejscu, jeden podmiot, cele satisfy/verify/require, typy podmiotów, cele expose i import, cele frameverify belongs in the objective of a verification case. Move it into objective { … }.
Reprezentacje tekstoweTreści SysML i KerML są poprawnie analizowane i deklarują element, który reprezentują; nieznane języki są odnotowywaneThe representation of “SpeedLimit” declares a part definition, not a constraint definition. Make the body declare “SpeedLimit” itself.
Indywidua, migawki i wycinki czasoweindividual tylko przy wystąpieniach i z dokładnie jedną definicją indywiduum; snapshot/timeslice tylko przy użyciach wystąpień wewnątrz wystąpienia; wycinek czasu wewnątrz migawki (ostrzeżenie)“parked” is individual, but none of its definitions is. Type it by an individual definition, or remove individual.
ZmiennośćZmienność posiada tylko warianty; wariant znajduje się w zmienności i jest jej rodzaju; wybór jest wariantem swojego punktu; abstract przy zmienności jest zbędne (uwaga); otwarte punkty konfiguracji (uwaga)“compact” is not a variant of “pack”. Choose one of: standardPack, largePack.
Własne słowa kluczowe#Name wskazuje definicję metadanych; deklaracja bez słowa kluczowego języka używa metadanych semantycznych (ostrzeżenie); metadane oznaczają tylko rodzaje dopuszczone przez ich annotatedElement; semantyczny typ bazowy jest definicją lub użyciem, pasuje do oznaczanego elementu (ostrzeżenie) i nie tworzy cyklu“safetyCritical” applies to PartDefinition, not to “invert” (ActionUsage). Move it, or remove it.
Wartości metadanychKażda wymagana cecha własnej definicji metadanych otrzymuje wartość (ostrzeżenie); każda wartość i wartość domyślna pasuje do typu swojej cechy (Boolean, String, liczby całkowite, wyliczenia); ograniczenia definicji są spełnione dla podanych wartości; treść metadanych redefiniuje tylko cechy definicji; abstrakcyjne definicje metadanych nie są stosowane; metadane semantyczne zapisane z about (ostrzeżenie)The values of “SafetyRating” break its constraint levelRange: level >= 1 and level <= 4. Change the values.
EwaluacjaOgraniczenia, wymagania i cele, które nie są spełnione dla bieżących wartości“sedanMass” is not met by “sedan”: … is false (…). Change the design values or the requirement.

Biblioteka standardowa

Strona Biblioteka standardowa wymienia pakiety i definicje, z których może korzystać każdy projekt SysML v2: wartości i jednostki, wielkości, części, porty, akcje, stany, wymagania, analizę i inne. Jest tylko do odczytu.

  • Otwórz ją przez Ustawienia → Biblioteka standardowa w narzędziach paska nawigacji. Projekty LML jej nie mają.
  • Foldery. Lewa strona wymienia pliki biblioteki według folderów: Kernel Libraries, Systems Library, Domain Libraries (Analysis, Cause and Effect, Geometry, Metadata, Quantities and Units, Requirement Derivation) i Holarch (pakiet HolarchMetadata z TBD i TBR, HolarchVariability z HolarchConfiguration oraz HolarchRequirements z Objective).
  • Plik. Wybierz plik, aby zobaczyć jego pakiety, każdy z dokumentacją i tabelą definicji: Nazwa, Rodzaj i Dokumentacja.
  • Znajdź. Wpisz tekst w polu Znajdź pakiet lub definicję…, aby przeszukać nazwy i dokumentację każdego pliku. Wyniki pokazują plik; kliknij wynik, aby otworzyć ten plik. Naciśnij Esc, aby wyczyścić.
  • Kopiuj nazwę kopiuje nazwę kwalifikowaną elementu, na przykład ISQ::MassValue, do użycia w Edytorze.
  • Pokaż tekst pokazuje plik biblioteki w oryginalnym zapisie; Pokaż definicje wraca do tabel.

Biblioteka to biblioteka wydania SysML v2 z jedną poprawką: tonne (alias 'metric ton') jest przeliczana na 1000 kg; plik wydania podaje 0.001 kg. Model odwołuje się do niej przez nazwę; nie jest kopiowana do projektu i nie jest częścią eksportu .sysml.

Limity

  • Dokument tekstowy większy niż 8 MB nie jest sprawdzany: This text is larger than 8 MB and is not checked. Split it into several packages.
  • Wiersz dłuższy niż 64 KB nie jest sprawdzany.
  • Zagnieżdżenie głębsze niż 256 poziomów nie jest sprawdzane.
  • Biblioteki standardowej nie można edytować.

SysML® i OMG® są zastrzeżonymi znakami towarowymi Object Management Group, Inc. w Stanach Zjednoczonych i innych krajach.