SysML v2
SysML v2-Textnotation
Die Sprache SysML v2, wie Holarch sie unterstützt, mit Beispielen aus der Hybrid-Car-Demo, den ausgeführten Prüfungen und der schreibgeschützten Standardbibliothek.
Auf dieser Seite
- Überblick
- Konzepte
- Elemente, Eigentümer und qualifizierte Namen
- Packages
- Imports und Sichtbarkeit
- Definitionen und Verwendungen
- Typisierung, Spezialisierung und Redefinition
- Multiplizitäten
- Werte und Einheiten
- Struktur: Ports, Connections, Interfaces, Bindings und Flows
- Verhalten: Actions
- Verhalten: States
- Anforderungen, Constraints und Verifikation
- Anwendungsfälle
- Views
- Kommentare, Dokumentation und Metadaten
- Individuals, Snapshots und Time Slices
- Variationen, Varianten und Konfigurationen
- Textuelle Repräsentationen
- So setzen Sie es ein
- Ausgeführtes Beispiel: die Anforderung an die Limousine lesen
- Tipps und häufige Fehler
- Was Holarch unterstützt
- Prüfungen
- Die Standardbibliothek
- Grenzen
- Verwandte Seiten
Überblick
SysML v2 beschreibt ein System als Baum benannter Elemente, geschrieben als Text. Holarch unterstützt die SysML v2-Textnotation auf Grundlage der OMG-Spezifikation SysML v2. Sie schreiben den Text im Editor, und Holarch zeigt dieselben Elemente im Browser, in den Ansichten, in den Tabellen und auf den Lebenszyklusseiten.
Diese Seite vermittelt die Notation mit Beispielen aus der Demo Hybridauto (SysML v2). Anschließend listet sie auf, was Holarch unterstützt, welche Prüfungen es auf Ihren Text anwendet, und die Standardbibliothek.
Konzepte
Elemente, Eigentümer und qualifizierte Namen
Jedes Element hat genau einen Eigentümer, mit Ausnahme der Packages der obersten Ebene. Der qualifizierte Name eines Elements ist die Kette der Namen seiner Eigentümer, verbunden durch ::. In der Demo ist die Batterie der Antriebsstrang-Definition Vehicles::Powertrain::battery.
Ein Name mit Leerzeichen oder anderen Sonderzeichen steht in einfachen Anführungszeichen: 'Fuel Tank'. Ein Kurzname in spitzen Klammern gibt einem Element einen zweiten, kurzen Bezeichner: requirement def <'VR-1'> CurbMass. Holarch verwendet den Kurznamen einer Anforderung als ihre Nummer.
Packages
Ein Package gruppiert Elemente wie ein Ordner. Packages können verschachtelt werden. Jedes Package der obersten Ebene ist ein Dokument im Editor.
package Vehicles {
doc /* A hybrid passenger car: structure, interfaces and variants. */
private import ScalarValues::*;
private import ISQ::*;
private import SI::*;
}
Imports und Sichtbarkeit
Ein Import macht die Mitglieder eines anderen Packages unter ihren kurzen Namen sichtbar.
import ISQ::*;importiert die Mitglieder vonISQ.import VehicleRequirements::**;importiert auch die Mitglieder verschachtelter Elemente (rekursiv).import Vehicles::Car;importiert ein einzelnes Element.import Vehicles::*[@SysML::PartDefinition];importiert nur die Mitglieder einer Art (ein gefilterter Import).
private, protected und public legen fest, wer ein Mitglied oder einen Import außerdem sieht. Die Demo schreibt private import, damit Imports nicht an Packages weitergegeben werden, die ihrerseits dieses Package importieren.
Ohne Import schreiben Sie den qualifizierten Namen: ISQ::MassValue wird überall aufgelöst, MassValue nur dort, wo ISQ importiert ist.
Ein alias gibt einem Element einen zweiten Namen: alias Hybrid for Car;.
Definitionen und Verwendungen
Eine Definition beschreibt eine Art von Ding. Eine Verwendung ist ein Einsatz einer Definition innerhalb eines anderen Elements. Die meisten Schlüsselwörter gibt es in beiden Formen:
| Definition | Verwendung | Bedeutung |
|---|---|---|
part def Battery; | part battery : Battery; | Ein System, Subsystem oder eine Komponente |
attribute def TirePressure; | attribute mass : MassValue = 45 [kg]; | Ein Wert, oft mit Einheiten |
item def Fuel; | item fuel : Fuel; | Etwas, das fließt oder gehandhabt wird |
port def FuelPort { … } | port fuelOut : FuelPort; | Ein Verbindungspunkt an einem Part |
connection def … / interface def FuelLine { … } | interface fuel : FuelLine connect …; | Eine Verbindung zwischen Parts oder Ports |
action def ProduceTorque { … } | action produce : ProduceTorque; | Verhalten: ein Schritt, der Eingaben nimmt und Ausgaben liefert |
state def PowertrainStates { … } | state off; | Verhalten: ein Zustand und seine Übergänge |
constraint def MassLimit { … } | constraint …; | Eine boolesche Bedingung über Werte |
calc def PowerToWeight { … } | calc …; | Eine Berechnung mit einem return-Wert |
requirement def <'VR-1'> CurbMass { … } | requirement <'VR-1.1'> sedanMass : CurbMass; | Eine Anforderung |
use case def DriveToWork { … } | use case commute : DriveToWork; | Ein Anwendungsfall |
analysis def PowerToWeightAnalysis { … } | analysis sedanPowerToWeight : …; | Ein Analysefall |
verification def CurbMassTest { … } | verification sedanWeighing : CurbMassTest; | Ein Verifikationsfall |
view def RequirementsView { … } | view driveCycleFlow : ActionFlowView { … } | Eine Ansicht des Modells |
enum def DriveMode { … } | attribute mode : DriveMode; | Eine feste Menge von Werten |
In einer Definition verschachtelte Mitglieder gehören zu jeder ihrer Verwendungen. part frontAxle : Axle; hat differential, leftWheel und rightWheel von Axle, ohne sie zu wiederholen.
Typisierung, Spezialisierung und Redefinition
Vier Operatoren verbinden Definitionen und Verwendungen. Jeder hat auch eine Schlüsselwortform.
| Operator | Schlüsselwort | Bedeutung | Beispiel |
|---|---|---|---|
: | defined by | Typisiert eine Verwendung durch eine Definition | part engine : Engine; |
:> an einer Definition | specializes | Die Definition ist eine Art der anderen und erbt deren Mitglieder | part def FuelTank :> Component |
:> an einer Verwendung | subsets | Die Verwendung ist eine Teilmenge einer anderen Verwendung | part spareWheel :> wheels; |
:>> | redefines | Ersetzt eine geerbte Verwendung, zum Beispiel um ihr einen Wert zu geben | attribute redefines mass = 18 [kg]; |
~ | Konjugiert einen Port: Seine in- und out-Features werden vertauscht | port fuelIn : ~FuelPort; |
Über Redefinition ändert eine Variante oder ein konfigurierter Part, was er erbt. In der Demo entfernt SportCar das Ersatzrad per Redefinition:
part def SportCar :> Car {
attribute topSpeed : SpeedValue = 210 [km/h];
part redefines spare [0];
}
abstract markiert eine Definition, die keine direkten Instanzen hat (abstract part def Component). ref markiert eine Referenz, die nicht im Besitz ist. in, out und inout legen die Richtung eines Features oder Parameters fest. end markiert die Enden einer Connection- oder Interface-Definition.
Multiplizitäten
Eine Multiplizität in eckigen Klammern gibt an, wie viele es gibt.
[2]: genau zwei.part runabout : CityCar [2];[0..1]: optional.part spare : Wheel [0..1];[1..*]und[*]: eins oder mehr, beliebig viele.[0]: keines; wird verwendet, um einen geerbten Part zu entfernen.- Grenzen können Ausdrücke sein.
orderedundnonuniquefolgen auf die Klammern.
Werte und Einheiten
= bindet einen Wert. := gibt einen Anfangswert an, der sich ändern kann. default gibt einen Standardwert an, den eine Redefinition ersetzen kann.
attribute maxCurbMass : MassValue = 1650 [kg];
attribute minBatteryCapacity : EnergyValue = 1.2 [kW*h];
attribute minPowerToWeight = 40 [W/kg];
attribute topSpeed : SpeedValue = 210 [km/h];
Eine Größe ist eine Zahl mit einer Einheit in eckigen Klammern. Einheiten werden mit *, / und ^ kombiniert ([m/s^2]). Größenarten wie MassValue stammen aus ISQ, Einheiten wie kg aus SI (oder USCustomaryUnits). Holarch prüft Dimensionen: 5 [s] einem MassValue zuzuweisen ist ein Fehler.
Ausdrücke verwenden Arithmetik, Vergleiche (<=, ==), logische Operatoren (and, or, not, implies), die Bedingung if c ? a else b, Feature-Ketten (car.powertrain.battery.capacity), Aufrufe von Berechnungen (PowerToWeight(power, mass)) und Sequenzoperationen wie ->sum, ->size, ->select und ->collect. Holarch wertet sie für Werte, Constraints, Ansichten und Analyseseiten mit Einheiten aus.
Struktur: Ports, Connections, Interfaces, Bindings und Flows
Parts werden über ihre Ports verbunden.
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;verbindet zwei Parts oder Ports.- Ein Interface ist eine typisierte Verbindung zwischen Ports. Seine Definition benennt seine Enden:
interface def FuelLine { end supply : FuelPort; end consumer : ~FuelPort; }. - Jedes Ende einer Connection oder eines Interface kann einen Namen und eine Multiplizität haben:
interface motorShaft : Shaft connect [1] driver ::> motor.output to [1] driven ::> transmission.motorIn;. Ein benanntes Ende ist ein Feature der Connection, sodassmotorShaft.driverdarauf verweist. bind a = b;besagt, dass zwei Features dasselbe sind (ein Binding-Konnektor).flow of Fuel from supply.fuel to produce.fuel;überträgt ein Item von einem Feature zu einem anderen.messagesendet ein Item als Ereignis zwischen Parts.
Verhalten: Actions
Eine Action-Definition enthält ihre Schritte (Action-Verwendungen), ihre Parameter und die Reihenfolge der Schritte.
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;
}
- Successions ordnen die Schritte:
first a then b;oderthen b;direkt nacha.startunddonesind Anfang und Ende. - Steuerknoten:
forkundjoinfür parallele Pfade;decideundmergefür Alternativen. Eine bewachte Succession nach einer Entscheidung lautetif speed > 30 then cruise;, undelse brake;ist der Standardzweig. - Terminate:
terminate;beendet die umschließende Action sofort, samt allen ihren Schritten, die noch laufen;then terminate;setzt es hinter den vorherigen Schritt.terminate x;beendet das Occurrencex. - Weitere Actions:
acceptwartet auf ein Signal,sendsendet eines,assign x := expr;ändert einen Wert,ifführt einen Block aus oder überspringt ihn,while … { … } until …;undfor v in seq { … }wiederholen einen Block. - Zuordnung von Verhalten: Ein Part führt eine Action mit
performaus (perform action trip : DriveCycle;,perform trip.supply;), undallocate a to b;ordnet ein Element einem anderen zu.
Verhalten: States
Eine Zustandsdefinition enthält Zustände und die Übergänge zwischen ihnen.
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;legt den Anfangszustand fest.- Übergänge haben einen Auslöser (
accept StartRequest), einen optionalen Guard (if charge > 20) und einen optionalen Effekt (do …). Die Kurzform folgt dem Quellzustand; die Langform lautettransition name first a … then b;. - Im Modell sind Auslöser und Effekt eines Übergangs eigene Elemente: eine Accept-Action und eine Action (
send,assign,perform,terminateoder eine benannte Action). Der Browser zeigt sie als trigger und effect unter dem Übergang. Sie sind der eigeneaccepterundeffectdes Übergangs, sodass andere Teile des Modells sie benennen können:chargerStates.plugIn.effect.sentMessageist die Nachricht, die der Effekt sendet, so wie ein Sequenzmodell sie bindet. - Ein Auslöser über einen Port muss etwas akzeptieren, das der Port überträgt: Im
ChargeManagerder Demo passtaccept connectCharger : ChargerConnected via chargePortzumin connected : ChargerConnecteddes Ports. Der Effektsend new ChargeRequest() to controllersendet an einen Part; ein Wert wie ein Attribut kann keine Nachricht empfangen. entry-,do- undexit-Actions laufen beim Betreten, während des Verweilens und beim Verlassen des Zustands.parallel-Zustände haben Regionen, die alle gleichzeitig aktiv sind.- Ein Part weist mit
exhibiteinen Zustand auf:exhibit state powertrainStates : PowertrainStates;.
Anforderungen, Constraints und Verifikation
Eine Anforderung enthält ihre Aussage in doc, das Element, für das sie gilt, als subject und eine prüfbare Bedingung als 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 constraintnennt eine Bedingung, die die Anforderung voraussetzt. Gilt sie nicht, zählen diese Anforderung und die darin verschachtelten Anforderungen als erfüllt; die umgebende Anforderung und die anderen verschachtelten Anforderungen werden weiterhin geprüft.actor,stakeholderundframe concernbenennen, für wen und wofür die Anforderung gilt.satisfy R by part;besagt, dass ein Part eine Anforderung erfüllt.- Ein Verifikationsfall verifiziert Anforderungen in seinem Ziel:
objective { verify carSpec.sedanMass; }. Er kannreturn verdict : Boolean = …;angeben. - Ein Analysefall hat ein Subjekt, ein Ziel und ein
return-Ergebnis, das Holarch auswertet, sobald jede Eingabe einen Wert hat. Attribute des Falls ohne Wert werden aus den==-Gleichungen seines Ziels gelöst (Analysefälle mit Unbekannten). connection : Derivation connect original to derived;hält eine abgeleitete Anforderung fest.#refinement dependency x to R;hält eine Verfeinerung fest.dependency from a to b;hält eine allgemeine Trace-Beziehung fest.
Anwendungsfälle
use case def DriveToWork { subject car : Car; actor driver : Driver; objective { … } include use case startCar : StartCar; }. Eine Anwendungsfall-Verwendung übernimmt Subjekt und Akteure ihrer Definition.
Views
Eine Ansicht zeigt einen Teil des Modells. Sie ist durch eine Standard-Ansichtsdefinition typisiert und legt mit expose offen, was sie zeigt:
view driveCycleFlow : StandardViewDefinitions::ActionFlowView {
expose DriveCycle;
}
filter grenzt die Elemente ein (filter @SysML::RequirementUsage;). render wählt eine Darstellung. Ein viewpoint umreißt die Anliegen, die eine Ansicht behandeln muss. SysML v2-Ansichten erklärt jede Ansichtsart.
Kommentare, Dokumentation und Metadaten
doc /* text */dokumentiert seinen Eigentümer. Es ist Teil des Modells; bei einer Anforderung ist es der Anforderungstext.comment about x /* text */ist eine Notiz im Modell über ein anderes Element.// textund//* text */sind Notizen nur im Text. Holarch behält sie im Text, aber sie sind keine Modellelemente.- Metadaten annotieren ein Element:
@TBD { owner = "Powertrain lead"; }in einem Rumpf,#TBR attribute limit …als Präfix odermetadata Capability about Vehicles::Car;von außen. - Benutzerdefinierte Schlüsselwörter: Jede Metadatendefinition funktioniert als Schlüsselwort:
#safetyCritical part controller : Controller;markiert den Controller mit den MetadatenSafetyCritical(Kurzname<safetyCritical>). Eine Metadatendefinition kann einschränken, was sie markiert::>> annotatedElement : SysML::PartDefinition;erlaubt nur Part-Definitionen. - Semantische Metadaten: Eine Metadatendefinition, die
SemanticMetadataspezialisiert, legt einen Basistyp fest,:>> baseType = faults meta SysML::Usage;. Jedes Element, das sie markiert, spezialisiert dann die Basis: Eine Verwendung bildet eine Teilmenge einer Basisverwendung, eine Definition spezialisiert eine Basisdefinition oder die Definitionen einer Basisverwendung. So sind#fault def BatteryOverheat;und#fault overheat : BatteryOverheat;Faults und haben die Features vonFault. Mit semantischen Metadaten kann das Sprachschlüsselwort entfallen, wie in diesen beiden Zeilen; der Browser zeigt sie mit ihrem Schlüsselwort (#fault def). Von außen geschrieben machtmetadata Fault about x;xnicht zu einem Fault: Die Prüfung warnt und schlägt vor,xselbst mit#faultzu markieren. - Metadaten mit eigener Bedeutung: Die Features einer Metadatendefinition sind das, was jede ihrer Verwendungen angeben muss, und ihre Constraints müssen für diese gelten. Mit
metadata def SafetyRating { attribute level : Natural; assert constraint { level >= 1 and level <= 4 } }meldet die Prüfung@SafetyRating;(keine Stufe) und@SafetyRating { level = 7; }(außerhalb des Bereichs);@SafetyRating { level = 4; }ist in Ordnung. Ein Feature mit einem Wert oderdefaultin der Definition oder mit der Deklaration[0..1]darf entfallen. Jeder Wert muss zum Typ seines Features passen:trueoderfalsefür einen Boolean, Text in Anführungszeichen für einen String, eine ganze Zahl für einen Integer (0 oder mehr für einen Natural, über 0 für einen Positive) und für eine Enumeration einer ihrer Werte, etwaHazardAnalysis::fmea; die Prüfung meldet jeden anderen Wert sowie einen Standardwert in der Definition, der nicht passt. Ein Metadatenrumpf gibt nur den Features der Definition Werte (level = 4;), und eineabstract metadata defkann nicht angewendet werden. Die Hybrid-Car-Demo bewertet ihren Controller mit@SafetyRating { level = 4; }und hält die Prüfung der Batterie als@SafetyReview { method = HazardAnalysis::fmea; closed = true; }fest. Im Editor beginnt Einfügen ▾ → Metadatendefinition eine Definition mit einem Feature und einer Regel, und Metadaten anwenden wendet eine innerhalb eines Rumpfs an. Ohne Text zu schreiben: Wählen Sie eine Definition oder Verwendung aus und verwenden Sie den Abschnitt Metadaten des Inspektors. Metadaten hinzufügen wendet eine der Metadatendefinitionen des Projekts an; jedes Feature hat dann ein Feld (eine Liste der Werte für eine Enumeration oder einen Boolean, einfacher Text für einen String, den Holarch in Anführungszeichen schreibt; der Standardwert der Definition erscheint als Hinweis, und ein Feature ohne Standardwert ist als erforderlich markiert); die Befunde der Prüfung zu diesen Metadaten erscheinen darunter; Entfernen nimmt sie wieder ab. Jede Änderung lässt sich mit einem einzigen Rückgängigmachen zurücknehmen. Metadaten aus der Standardbibliothek und die eigenen von Holarch (Simulation, Ziele, Variabilität) behalten ihre eigenen Bedienelemente und werden dort nicht aufgeführt.
Individuals, Snapshots und Time Slices
Ein Individual ist ein bestimmtes Ding über sein ganzes Leben, etwa ein Auto mit seiner Seriennummer, statt einer Art von Ding. Ein Snapshot ist dieses Ding zu einem Zeitpunkt; ein Time Slice ist ein Zeitraum seines Lebens. Beide gehören zum Occurrence, das sie besitzt, und haben dessen Features, sodass sie diesen Features eigene Werte geben können.
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 }
}
individualsteht vor dem Art-Schlüsselwort (individual part def,individual item def) oder allein (individual def Plate_77;). Eine mitindividualgeschriebene Verwendung ist durch genau eine Individual-Definition typisiert:individual car1 : Car_VIN1234;.snapshotundtimeslicestehen vor einem Art-Schlüsselwort oder allein, innerhalb eines Part, Item, einer Action oder eines anderen Occurrence.then timeslice secondOwner;ordnet einen Time Slice nach dem vorangehenden Mitglied ein.- Ein Wert innerhalb eines Snapshots oder Time Slice wird zuerst dort gelesen, dann im Individual, dann in seiner Definition. Im Beispiel beträgt
atService.mileage15.000 km, und der Constraint gilt. - Nur Occurrences können Individuals, Snapshots oder Time Slices sein: Attribute und Enumerationen sind Werte.
- In Architektur → Parts, den Ansichten Datenbank und Raster, listet die Spalte Instanzen die Individuals der Definition jedes Parts auf (für
part sedan : Car:Car_VIN1234): Individual-Definitionen, die sie spezialisieren, und Individual-Verwendungen, die sie typisiert. Individual (Ja) und Anteil (Momentaufnahme oder Zeitscheibe) sind ebenfalls Spalten (Spalten ▾ → SysML v2). Parts zeigt Instanzen standardmäßig, sobald das Modell ein Individual hat, und der Export Tabelle (CSV) enthält dann die drei Spalten; der Export Definitionen listet sie für jedes Element auf, das sie hat. - Im Inspektor legt Vorkommen unter Features Individual fest und bei Verwendungen Ganzes Leben, Zeitscheibe oder Momentaufnahme. Der Art-Filter des Browsers enthält Individuals, und das Menü ⋯ einer Zeile enthält Neuer Schnappschuss… und Neue Zeitscheibe…. Die General View zeigt «individual part def», «snapshot» und «timeslice» in den Kästchenköpfen, listet die Snapshots und Time Slices eines Kästchens in einem eigenen Abschnitt auf und zeichnet Successions zwischen Kästchen als gestrichelte Pfeile; Anordnen ▾ → Als Zeitleiste anordnen reiht sie von links nach rechts auf. In der Hybrid-Car-Demo zeigt die General View
carLifelinedie Snapshots und den Time Slice vonCar_VIN1234.
Variationen, Varianten und Konfigurationen
Eine Variation listet die an einem Punkt eines Entwurfs zulässigen Wahlmöglichkeiten auf; jede Wahlmöglichkeit ist eine Variante. Eine Variationsdefinition (variation part def) ist eine wiederverwendbare Menge von Wahlmöglichkeiten; eine Variationsverwendung (variation part charger) ist ein Punkt innerhalb eines Entwurfs. Eine Konfiguration wählt für jeden Punkt eine Variante.
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;
}
- Eine Variante hat die Features ihrer Variation und kann sie redefinieren:
largePackhat einecapacity, weilBatteryPackeineBatteryist. variant x;ohne Art-Schlüsselwort macht die vorhandene Verwendungxzu einer der Wahlmöglichkeiten; sie wird nachxbenannt.- Eine Variation besitzt nur Varianten (sowie Definitionen, Kommentare, Metadaten und Imports). Eine Variation ist bereits abstrakt, daher wird
abstractan ihr als überflüssig vermerkt. - Wählen Sie eine Variante mit einem Wert:
part :>> pack = BatteryPack::largePack;. Eine Wahl, die keine Variante dieses Punkts ist, ist ein Fehler. - Solange ein Punkt keine Wahl hat, ist sein Wert unbekannt, sodass eine Assertion darüber weder erfüllt noch verletzt ist. In einer Konfiguration werden die Werte der gewählten Varianten verwendet.
- Markieren Sie eine Konfiguration mit
@HolarchConfiguration(PackageHolarchVariability, in der Standardbibliothek unter Holarch): Der Editor vermerkt dann jeden Punkt, den sie noch nicht gewählt hat. - Im Editor schreibt Einfügen ▾ jedes davon: Variation (eine Definition auf Package-Ebene, ein Punkt innerhalb eines Parts), Variante (innerhalb einer Variation), Konfiguration und Variantenwahl (innerhalb einer Konfiguration).
- In der Hybrid-Car-Demo hat
CarLinezwei Punkte (packundcharger), undselfChargingHybridundplugInHybridsind Konfigurationen davon; die Assertion schließt eine Wallbox mit dem Standard-Pack aus.
Textuelle Repräsentationen
Eine textuelle Darstellung schreibt ein Element in einer anderen Sprache: rep language "Python" /* … */ im Rumpf des Elements. Der Rumpf wird als Text beibehalten. Das Modell ist das, was das umgebende SysML deklariert; Holarch führt einen Rumpf nie aus.
- In der Hybrid-Car-Demo trägt
DriveWheelsseine Berechnung in Python:rep language "Python" /* wheel_speed = torque.value * GEAR_RATIOS[gear] / WHEEL_RADIUS */. - Ein Rumpf in
"sysml"oder"kerml"wird geprüft.SpeedLimitist alsrep language "sysml" /* speed <= limit */geschrieben, und Holarch wertet es wie einen direkt geschriebenen Constraint aus. - Der Editor hebt SysML- und KerML-Rümpfe als Code auf getöntem Hintergrund hervor. Andere Sprachen erscheinen als Kommentartext.
- Der Abschnitt Darstellung des Inspektors listet jede Darstellung mit ihrer Sprache und ihrem Rumpf auf. Klicken Sie bei einer Definition oder Verwendung auf Darstellung hinzufügen, um eine hinzuzufügen, und auf Entfernen, um eine zu löschen.
- Die Action Flow View markiert eine Action, deren Definition eine Darstellung hat, mit deren Sprache in geschweiften Klammern, etwa {Python}.
- Bekannte Sprachen: SysML, KerML, OCL, Alf, Python, JavaScript, MATLAB, Modelica, C, natürliche Sprache (
naturalLanguage,English,text). Eine Version nach dem Namen wird ignoriert (OCL2.0,Python 3). - Ein Rumpf darf
*/nicht enthalten, da dies den Kommentar beenden würde.
Die eigenen Diskussionskommentare, Labels, Zuständigen und Fälligkeitsdaten von Holarch werden neben dem Modell gespeichert. Sie werden nicht in den Text geschrieben.
So setzen Sie es ein
Eine Struktur modellieren
- Öffnen Sie im Editor ein Package (oder klicken Sie auf + Neues Package).
- Schreiben Sie für jede Art von Verbindungspunkt eine
port defmit gerichteten Features (out attribute torque : TorqueValue;). - Schreiben Sie für jede Art von Komponente eine
part defmit ihren Attributen und Ports. - Schreiben Sie eine
part deffür die Baugruppe, mit einempartfür jede Komponente. - Verbinden Sie die Parts:
connect a.p to b.q;oderinterface name : Def connect a.p to b.q;. - Halten Sie inne. Die Statuszeile meldet Angewendet, und der Browser zeigt die neuen Elemente.
Einfügen ▾ (oder ⌃⇧Space / Ctrl+Shift+Space) schreibt jedes dieser Konstrukte für Sie, mit Feldern zum Ausfüllen. Siehe Ein Konstrukt einfügen.
Werte mit Einheiten angeben
- Importieren Sie die Größenarten und Einheiten am Anfang des Packages:
private import ISQ::*;undprivate import SI::*;. - Typisieren Sie das Attribut durch eine Größenart und geben Sie einen Wert an:
attribute mass : MassValue = 45 [kg];. - Redefinieren Sie das Attribut in einer Definition, die es erbt, mit einem eigenen Wert:
attribute redefines mass = 18 [kg];. - Zeigen Sie auf den Wert. Eine Fehlerkarte erscheint, wenn die Einheit nicht zur Größenart passt.
Verhalten beschreiben
- Schreiben Sie eine
action defmit ihrenin- undout-Parametern. - Fügen Sie pro
action-Verwendung einen Schritt hinzu und ordnen Sie sie mitfirst … then …;oderthen. - Verwenden Sie
forkundjoinfür parallele Schritte,decideundmergefür Alternativen. - Fügen Sie zwischen den Schritten, die Items weitergeben,
flow of Item from a.out to b.in;hinzu. - Schreiben Sie in dem Part, der das Verhalten ausführt,
perform action name : Def;und in seinen Partsperform name.step;. - Öffnen Sie die Action in einer Action Flow View, um sie gezeichnet zu sehen (siehe SysML v2-Ansichten).
Eine Anforderung schreiben und verfolgen
- Schreiben Sie
requirement <'ID'> name { doc /* The system shall … */ subject s : Def; }. - Fügen Sie
require constraint { … }hinzu, wenn die Anforderung gegen Werte geprüft werden kann. - Schreiben Sie
satisfy name by somePart;dort, wo der Entwurf sie erfüllt. - Schreiben Sie eine
verification, deren Ziel sie mitverifyverifiziert. - Öffnen Sie Bedarfe & Anforderungen → Anforderungen: Die Anforderung ist mit ihrer Nummer aufgeführt, und Verifikation → RVTM zeigt, wie sie verifiziert wird. Siehe Anforderungen und Verifikation in SysML v2-Projekten.
Einen Wert als TBD oder TBR markieren
TBD anstelle eines Werts zu schreiben ist kein gültiges SysML. Verwenden Sie stattdessen die Metadaten von Holarch.
- Importieren Sie sie:
private import HolarchMetadata::*;. - Stellen Sie dem Attribut ein Präfix voran:
#TBD attribute chargerPower : PowerValue;(noch kein Wert) oder#TBR attribute limit : TimeValue = 0.5 [h];(ein zu überprüfender Wert). - Um einen Verantwortlichen und eine Begründung festzuhalten, schreiben Sie die Langform in den Rumpf des Attributs:
@TBD { owner = "Powertrain lead"; rationale = "The charging standard is not chosen yet."; due = "2026-12-01"; }.
Das TBD/TBR-Register listet diese Werte auf. TBD und TBR spezialisieren ModelingMetadata::StatusInfo, sodass andere SysML v2-Werkzeuge sie als Statusannotationen lesen. Einfügen ▾ → TBD-Wert und TBR-Wert schreiben sie für Sie.
Einen Bibliotheksnamen finden
- Öffnen Sie Standardbibliothek über die Werkzeuge der Leiste.
- Geben Sie einen Teil des Namens in Package oder Definition suchen… ein, zum Beispiel
MassValue. - Klicken Sie in der Zeile auf Namen kopieren. Der qualifizierte Name, hier
ISQBase::MassValue, wird kopiert. - Fügen Sie ihn im Editor ein, oder importieren Sie sein Package und verwenden Sie den kurzen Namen.
Ausgeführtes Beispiel: die Anforderung an die Limousine lesen
Dieses Beispiel verfolgt eine Anforderung durch den Text der Hybrid-Car-Demo.
- Öffnen Sie die Demo und wählen Sie in der Liste Packages des Editors VehicleRequirements.
- Suchen Sie
requirement def <'VR-1'> CurbMass. Seinrequire constraint { car.curbMass <= limit }vergleicht die Leermasse des Subjekts mitlimit. - Suchen Sie
requirement carSpec. Es enthältrequirement <'VR-1.1'> sedanMass : CurbMass { attribute :>> limit = maxCurbMass; }. Die Verwendung redefiniertlimitmit dem ZielwertmaxCurbMass = 1650 [kg]auf Package-Ebene. - Suchen Sie
satisfy carSpec by fleet.sedan;. Klicken Sie mit ⌘ / Ctrl aufsedan: Der Editor öffnet Vehicles beipart sedan : Car, woattribute redefines curbMass = 1580 [kg];den Wert angibt. - Suchen Sie zurück in VehicleRequirements
verification def CurbMassTest. Sein Zielverify carSpec.sedanMass;macht es zu einem Verifikationsfall von VR-1.1, undverification sedanWeighing : CurbMassTest { subject car = fleet.sedan; }wendet es auf die Limousine an. - Ändern Sie in Vehicles
1580 [kg]in1700 [kg]und halten Sie inne. Die Limousine überschreitet nun die Grenze von 1650 kg, und der Editor zeigt in VehicleRequirements eine Warnung, dasssedandie Anforderung nicht erfüllt, mit dem falschen Constraint und seinen Werten. Machen Sie die Änderung mit ⌘Z / Ctrl+Z rückgängig.
Tipps und häufige Fehler
- „…“ ist hier nicht definiert. Der Name ist falsch geschrieben oder sein Package ist nicht importiert. Fügen Sie
private import Package::*;hinzu oder schreiben Sie den qualifizierten Namen. - Ein fehlendes
;. Jede Deklaration endet mit;oder einem Rumpf{ … }. The declaration does not end. Add ; or a { … } body. (Die Deklaration endet nicht. Fügen Sie ; oder einen Rumpf { … } hinzu) :>oder:>>. Verwenden Sie:>zum Spezialisieren oder für Teilmengen; verwenden Sie:>>, um ein geerbtes Feature zu ersetzen. Ein Feature zu redefinieren, das nicht geerbt ist, ergibt „x“ wird von „y“ nicht geerbt.- Einheiten brauchen Imports.
5 [kg]wird nur aufgelöst, woSIsichtbar ist. - Zwei Mitglieder mit einem Namen. „x“ wird in diesem Namensraum bereits verwendet. Benennen Sie eines um; eine Variante redefiniert stattdessen.
verifyaußerhalb eines Ziels. Setzen Sie es inobjective { verify R; }eines Verifikationsfalls.- Schlüsselwörter als Namen. Wörter wie
part,stateoderactionsind reserviert. Setzen Sie sie in Anführungszeichen ('state') oder wählen Sie einen anderen Namen.
Was Holarch unterstützt
Holarch unterstützt die folgenden Teile der SysML v2-Textnotation. Der Editor prüft alle, und das Modell behält sie bei.
| Bereich | Unterstützt |
|---|---|
| Pakete und Namensräume | package, verschachtelte Packages, library package (schreibgeschützt), doc, comment … about, Notizen // und //* */, alias … for …, public/private/protected, Kurznamen <'1.2'>, Namen in Anführungszeichen |
| Importe | Membership- und Namespace-Imports, ::*, rekursiv ::**, gefilterte Imports [@Kind] |
| Definitionen und Verwendungen | part, 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 |
| Spezialisierung | :>/specializes, :/defined by, :>/subsets, :>>/redefines, Konjugation ~, disjoint, Feature-Ketten a.b.c |
| Multiplizitäten | [n], [n..m], [*], [0..*], ordered, nonunique, Ausdrücke als Grenzen |
| Werte und Einheiten | =, :=, default, Größen 5 [kg], Einheitenausdrücke [m/s^2], die ISQ-Größenarten sowie die SI- und US-üblichen Einheiten der Standardbibliothek, Dimensionsprüfungen |
| Struktur | Ports und konjugierte Ports, connect, Interfaces mit Enden, benannte Konnektorenden mit Multiplizitäten, bind, flow of T from … to …, message |
| Actions | Parameter, perform, Successions (first … then …, then), fork, join, decide, merge, Guards, accept, send, assign, if, while, for, loop, start, done, terminate |
| States | entry/do/exit, Übergänge mit Auslöser, Guard und Effekt, parallel-Zustände, verschachtelte Zustände, exhibit |
| Anforderungen | subject, actor, stakeholder, require constraint, assume constraint, frame concern, satisfy … by …, verify, Kurznamen als IDs, doc als Anforderungstext |
| Constraints und Berechnungen | Constraint- und Calc-Definitionen und -Verwendungen, return, assert constraint, Aufrufe, KerML-Ausdrücke mit Arithmetik, Vergleich, Logik, if ? else und Sequenzoperationen, Auswertung mit Einheiten |
| Anwendungsfälle, Analyse und Verifikation | subject, actor, objective, include use case, Analysefälle mit einem return-Ergebnis, Verifikationsfälle mit verify und einem Urteil |
| Views | view, view def, expose (mit ::*, ::** und Filtern), filter, viewpoint, frame, render, die Standard-Ansichtsdefinitionen |
| Zuordnung und Traces | allocate a to b, Allocation-Definitionen, dependency from … to … |
| Individuals | individual-Definitionen und -Verwendungen, snapshot und timeslice (auch nach then), ihre Werte und Successions |
| Variabilität | variation-Definitionen und -Verwendungen, variant-Mitglieder und Variantenreferenzen (variant x;), Wahl über Werte, mit @HolarchConfiguration markierte Konfigurationen (HolarchVariability) |
| Metadaten | @Name { … }, das Präfix #Name, metadata Name about …, die Holarch-Packages HolarchMetadata (TBD, TBR) und HolarchFrameworks; benutzerdefinierte metadata def; benutzerdefinierte Schlüsselwörter und semantische Metadaten (#fault def …) |
Unverändert übernommen, nicht interpretiert
Holarch liest diese Konstrukte und behält sie genau so bei, wie sie geschrieben sind, gibt ihnen aber keine eigene Bedeutung:
- textuelle Darstellungen in anderen Sprachen als SysML und KerML (als Text beibehalten; siehe Textuelle Darstellungen).
Noch nicht verfügbar
- Importieren von KerML-Dateien (
.kerml). - Commits auf
main, Tags und Merges über die Systems Modeling API: Andere Werkzeuge committen in Branches von Änderungsanträgen, die ein Genehmiger in Holarch anwendet (siehe Die API und MCP in SysML v2-Projekten). - Spracherweiterungen über benutzerdefinierte Schlüsselwörter und semantische Metadaten hinaus.
Prüfungen
Holarch prüft den Text während der Eingabe. Jedes Problem wird in der Randleiste des Editors markiert und unterstrichen; die Meldung nennt das Problem und dann die Lösung. Fehler verhindern, dass ein Mitglied angewendet wird; Warnungen nicht.
| Bereich | Was geprüft wird | Beispielmeldung |
|---|---|---|
| Syntax | Zeichen, Kommentare, Zeichenketten, geschweifte Klammern, ;, erwartete Namen und Token | Diese Klammer hat kein Gegenstück. Fügen Sie die passende { oder } hinzu oder löschen Sie diese. |
| Namen | Nicht aufgelöste, mehrdeutige, ungültige, doppelte (Warnung) und private Namen | „Batery“ ist hier nicht definiert. Prüfen Sie die Schreibweise oder importieren Sie sein Package. |
| Typisierung und Spezialisierung | Zyklen; Typisierung und Spezialisierung durch eine Definition der richtigen Art; Teilmengenbildung und Redefinition von Features; Redefinition nur geerbter Features | „capacity“ wird von „Car“ nicht geerbt. Spezialisieren Sie seinen Typ oder bilden Sie stattdessen mit :> eine Teilmenge. |
| Multiplizitäten | Gültige und ganzzahlige Grenzen; eine Redefinition nicht breiter als das Redefinierte | Die Multiplizität [3..1] ist ungültig. Verwenden Sie eine untere Grenze von 0 bis zur oberen Grenze. |
| Einheiten und Werte | Passende Dimensionen, fehlende Einheiten, Einheitennamen, Zahlentypen | Die Einheiten passen nicht zusammen: kg und s. Rechnen Sie eine Seite in eine kompatible Einheit um. |
| Ausdrücke | Syntax, Operandentypen, Argumente von Berechnungen, boolesche Bedingungen | Die Bedingung muss wahr oder falsch sein; sie ist eine Zahl. Schreiben Sie einen Vergleich wie x > 0. |
| Struktur | Connection-Enden sind Features, Interfaces verbinden Ports, Richtungen von Ports, Flows und Messages, Item-Typen von Flows, Binding-Typen | Diese Port-Richtungen passen nicht zusammen. Konjugieren Sie einen Port (~) oder ändern Sie eine Richtung. |
| Actions | Successions zwischen Actions desselben Rumpfs, Ein-/Ausgangszahlen von Steuerknoten, Guards von Entscheidungen und else, start und done, Zuweisungen, Ziele von perform, die Werte, über die eine for-Schleife iteriert, gegenüber dem Typ der Schleifenvariablen | then benötigt eine vorherige Action. Fügen Sie eine Action oder first … then … hinzu. |
| States | Übergänge zwischen Zuständen desselben Rumpfs, je ein entry/do/exit, Anfangsübergänge, parallele Regionen, Ziele von exhibit, der do-Effekt eines Übergangs (send an etwas, das empfangen kann, assign, accept, action oder eine benannte Action), die Nutzlast eines Auslösers gegenüber den Items seines Ports, ein Auslöser auf einem bloßen Bibliothekswert wie Real (Warnung), at-Auslöser, die eine Zeit nennen | „electric“ hat Unterzustände, aber keinen Anfangsübergang, daher wird keiner von ihnen betreten. Fügen Sie entry; then <first state>; hinzu. |
| Anforderungen, Fälle und Ansichten | Mitglieder an der richtigen Stelle, ein Subjekt, Ziele von satisfy/verify/require, Subjekttypen, Ziele von expose und import, Ziele von frame | verify gehört in das Ziel eines Verifikationsfalls. Verschieben Sie es in objective { … }. |
| Textuelle Repräsentationen | SysML- und KerML-Rümpfe werden geparst und deklarieren das Element, das sie darstellen; unbekannte Sprachen werden vermerkt | Die Darstellung von „SpeedLimit“ deklariert eine Part-Definition, keine Constraint-Definition. Lassen Sie den Rumpf „SpeedLimit“ selbst deklarieren. |
| Individuals, Snapshots und Time Slices | individual nur bei Occurrences und mit genau einer Individual-Definition; snapshot/timeslice nur bei Occurrence-Verwendungen innerhalb eines Occurrence; ein Time Slice innerhalb eines Snapshots (Warnung) | „parked“ ist individual, aber keine seiner Definitionen ist es. Typisieren Sie es durch eine Individual-Definition oder entfernen Sie individual. |
| Variabilität | Eine Variation besitzt nur Varianten; eine Variante steht in einer Variation und ist von deren Art; eine Wahl ist eine Variante ihres Punkts; abstract an einer Variation ist überflüssig (Hinweis); die offenen Punkte einer Konfiguration (Hinweis) | „compact“ ist keine Variante von „pack“. Wählen Sie eine von: standardPack, largePack. |
| Benutzerdefinierte Schlüsselwörter | #Name benennt eine Metadatendefinition; eine Deklaration ohne Sprachschlüsselwort verwendet semantische Metadaten (Warnung); Metadaten markieren nur die Arten, die ihr annotatedElement erlaubt; ein semantischer Basistyp ist eine Definition oder Verwendung, passt zu dem Element, das er markiert (Warnung), und bildet keinen Zyklus | „safetyCritical“ gilt für PartDefinition, nicht für „invert“ (ActionUsage). Verschieben oder entfernen Sie es. |
| Metadatenwerte | Jedes erforderliche Feature einer benutzerdefinierten Metadatendefinition erhält einen Wert (Warnung); jeder Wert und Standardwert passt zum Typ seines Features (Boolean, String, ganze Zahlen, Enumerationen); die Constraints der Definition gelten für die angegebenen Werte; ein Metadatenrumpf redefiniert nur die Features der Definition; abstrakte Metadatendefinitionen werden nicht angewendet; mit about geschriebene semantische Metadaten (Warnung) | Die Werte von „SafetyRating“ verletzen seinen Constraint levelRange: level >= 1 and level <= 4. Ändern Sie die Werte. |
| Auswertung | Constraints, Anforderungen und Ziele, die für die aktuellen Werte nicht gelten | „sedanMass“ wird von „sedan“ nicht erfüllt: … ist falsch (…). Ändern Sie die Entwurfswerte oder die Anforderung. |
Die Standardbibliothek
Die Seite Standardbibliothek listet die Packages und Definitionen auf, die jedes SysML v2-Projekt verwenden kann: Werte und Einheiten, Größen, Parts, Ports, Actions, Zustände, Anforderungen, Analyse und mehr. Sie ist schreibgeschützt.
- Öffnen Sie sie über Einstellungen → Standardbibliothek in den Werkzeugen der Leiste. LML-Projekte haben sie nicht.
- Ordner. Die linke Seite listet die Bibliotheksdateien nach Ordner auf: Kernel Libraries, Systems Library, Domain Libraries (Analysis, Cause and Effect, Geometry, Metadata, Quantities and Units, Requirement Derivation) und Holarch (das Package
HolarchMetadatamit TBD und TBR,HolarchVariabilitymitHolarchConfigurationundHolarchRequirementsmitObjective). - Eine Datei. Wählen Sie eine Datei aus, um ihre Packages zu sehen, jedes mit seiner Dokumentation und einer Tabelle seiner Definitionen: Name, Art und Dokumentation.
- Suchen. Geben Sie in Package oder Definition suchen… etwas ein, um die Namen und die Dokumentation aller Dateien zu durchsuchen. Die Ergebnisse zeigen die Datei; klicken Sie darauf, um diese Datei zu öffnen. Drücken Sie Esc, um die Suche zu leeren.
- Namen kopieren kopiert den qualifizierten Namen eines Elements, etwa
ISQ::MassValue, zur Verwendung im Editor. - Text anzeigen zeigt die Bibliotheksdatei, wie sie geschrieben ist; Definitionen anzeigen kehrt zu den Tabellen zurück.
Die Bibliothek ist die Release-Bibliothek von SysML v2 mit einer Korrektur: Eine tonne (Alias 'metric ton') entspricht 1000 kg; die Release-Datei nennt 0,001 kg. Ihr Modell verweist über den Namen auf sie; sie wird nicht in das Projekt kopiert und ist nicht Teil eines .sysml-Exports.
Grenzen
- Ein Textdokument über 8 MB wird nicht geprüft: This text is larger than 8 MB and is not checked. Split it into several packages. (Dieser Text ist größer als 8 MB und wird nicht geprüft. Teilen Sie ihn auf mehrere Packages auf)
- Eine Zeile über 64 KB wird nicht geprüft.
- Eine Verschachtelung tiefer als 256 Ebenen wird nicht geprüft.
- Die Standardbibliothek kann nicht bearbeitet werden.
Verwandte Seiten
- Erste Schritte mit SysML v2-Projekten
- Texteditor und Browser
- SysML v2-Ansichten
- Anforderungen und Verifikation in SysML v2-Projekten
- SysML v2-Modelle austauschen
SysML® und OMG® sind eingetragene Marken der Object Management Group, Inc. in den Vereinigten Staaten und anderen Ländern.