Releases: Systems-Modeling/SysML-v2-Pilot-Implementation
2022-11 - SysML v2 Pilot Implementation
This is an incremental update to the 2022-10 release. It corresponds to Eclipse plugin version 0.30.0.
Language Features
-
Membership and namespace import. The abstract syntax for
Import
has been revised so that it is now abstract with two concrete subclasses,MembershipImport
andNamespaceImport
. The textual and graphical notations are unchanged, but their parsing is different.- An import declaration of the form
import
qualifiedName
;
now parses to aMembershipImport
with itsimportedMembership
given by the resolution of thequalifiedName
. If thequalifiedName
is suffixed by::**
, thenisRecursive = true
. - An import declaration of the form
import
qualifiedName
::*;
now parses to aNamespaceImport
with itsimportedNamespace
given by the resolution of thequalifiedName
. If::**
is also added, thenisRecursive = true
.
[PR #426]
- An import declaration of the form
-
Membership and namespace expose. In the SysML abstract syntax,
Expose
is a kind ofImport
. Parallel to the abstract syntax change forImport
,Expose
is now abstract with two concrete subclassesMembershipExpose
andNamespaceExpose
.ViewUsage
has also been updated to replace theexposedNamespace
andviewedElement
properties with a singleexposedElement
. As a result of these changes, it is now possible for aViewUsage
to haveMembershipExpose
relationships to theMemberships
for individual elements, even if those elements are not named.
[PR #426]
Model Libraries
- KerML and SysML. The reflective syntax models
KerML
andSysML
have been updated to reflect the changes in the abstract syntax forImport
andExpose
.
[PR #426] - Interchange data.
.project
and.meta
files have been added to each of the model library directories in thesysml.library
project, conformant with the format required in subclause 10.2 of the latest KerML Specification. As a result, compressing each of these directories into a ZIP archive results in a legal project interchange (.kpar
) file, having model interchange files using the textual notation (.sysml
).
[PR #437]
Backward Incompatibilities
There are no changes to the concrete syntax, so all existing valid models will continue to be valid. However, the abstract syntax for Import
and Expose
relationships has changed, so import
and expose
declarations will parse differently than before, as described above.
Jupyter
None.
Visualization
- PlantUML
See bug fixes - Tom Sawyer
None.
Technical Updates
-
Eclipse version. The minimum required version for Eclipse installation has been updated to 2022-09.
[PR #425] -
JSON schema. The following JSON Schema files have been added to the
org.omg.sysml
project under a newjson-schema
directory:KerML.json
– KerML abstract syntax (also to be used for API payload validation)SysML.json
– SysML abstract syntax (also to be used for API payload validation)ModelInterchange.json
– Interchange project information (.project
) and interchange project file metadata (.meta
)
[PR #433]
Bug Fixes
- RequirementDerivation. Corrected the
baseTypes
forOriginalRequirementMetadata
tooriginalRequirements
andDerivedRequirementMetadata
toderivedRequirements
. These had been switched.
[PR #432] - Feature chain evaluation. Corrected the evaluation of feature chains with intermediate features that are redefined.
[PR #435] - Rendering of subjects (PlantUML). Rendered requirement and case subjects as distinct nodes in order to render subjects with bindings or subsettings.
[PR #428] - Start/done and entry/exit action rendering (PlantUML). Properly rendered start and done in actions and entry and exit actions in states.
[PR #429] - Variant visualization (PlantUML). Revised visualization of variants to align with specification.
[PR #431] - Short name rendering (PlantUML). Fixed an er...
2022-10 - SysML v2 Pilot Implementation
This is an incremental update to the 2022-09 release. It corresponds to Eclipse plugin version 0.29.0.
Language Features
- User-defined keywords.
- User-defined keyword notation (
#
keyword
) is now available in KerML. - In both KerML and SysML, multiple user-defined keywords can now be used in a single declaration.
- User-defined keyword notation (
- Binding connectors and successions. In KerML only, it is now possible to declare the ends of a binding connector or succession using end feature declarations in the connector body, rather than using the special notation
... = ...
orfirst ... then ...
. - Cast operators. The parsing of the cast operators
as
andmeta
has been changed to make the target type directly the type of the result parameter of the operator expression. (This is a backward compatible change.) - Flow payloads. Previously, the textual notation only allowed limited declaration of the name and type of the payload feature (
of
...
) of an item flow (in KerML) or a flow connection usage (in SysML). Now, payload features can have full declarations, including subsetting and redefinition specializations and feature value bindings. This is useful for modeling e.g., a message in SysML with a specific value for its payload.message of fuelCommand : FuelCommand = engineController.engineControlPort.incomingFuelCommand from engineController to engine;
[PR #420]
Model Libraries
- BaseFunctions. The functions in the Kernel Semantic Library package
BaseFunctions
corresponding to the cast operators have been updated consistent with the change noted above.
[PR #420] - Connections. See Bug Fixes below.
Backward Incompatibilities
None.
Jupyter
None
Visualization
-
PlantUML
- Updated PlantUML to 1.2022.7.
Important Note: To work with this release, existing Eclipse installations will need to have their PlantUML installation updated from the update sitehttps://https://github.com/himi/p2-update-puml-sysmlv2/raw/main/updates
. - Updated compartment title style to be centered and italic.
[PR #419]
- Updated PlantUML to 1.2022.7.
-
Tom Sawyer
None.
Technical Updates
There were a number of changes to clean up the abstract syntax, which should not effect user models.
- Implementation-specific metaclasses. The abstract syntax as implemented previously contained five metaclasses that were specific to the pilot implementation but not considered part of the normative abstract syntax model documented in the specifications. Two of these (
ItemFeature
andItemFlowEnd
) have now been made normative, while three others (ItemFlowFeature
,SourceEnd
andTargetEnd
) have been removed, with the pilot implementation updated to not need them. - Multiplicity lower bounds. Previously, the
Feature::type
property had a multiplicity lower bound of 1. This has now been changed to 0, as has the multiplicity lower bound for all properties that (directly or indirectly) subset this property. This allows models to be peristed and interchanged without explicit typing, with semanticly necessary types ultimately provided via implied relationships added by tooling. - Ecore. Previously, during preprocessing of the exported MOF model, the property
Feature::isNonunique
was added toSysML.uml
for use as an workaround in parsing thenonunique
keyword. In addition, theOperatorExpressions::operand
property was included in the abstract syntax model as an implementation workaround for parsing operator expressions. Now, these two features are added toSysML.ecore
by the custom UML to Ecore converter and are not included in theSysML.uml
model.
[PR #420]
Bug Fixes
- Flow connections. In the Systems Library model
Connections
, correctedMessageConnection
to specializeActions::Action
andmessageConnections
to specializeActions::actions
.
[PR #421]
2022-09 - SysML v2 Pilot Implementation
This is an incremental update to the 2022-08 release. It corresponds to Eclipse plugin version 0.28.1.
Language Features
KerML and SysML
-
Library packages. The keyword
library
can be used to identify a package as a library package, e.g.,library package
DynamicsModelLibrary { ... }
. Further prefixing a library package declaration with the keywordstandard
identifies it as a standard library package. However,standard
should only be used to identify library packages that are part of the standard KerML and SysML model libraries (i.e., those in thesysml.library
project in the pilot implementation), or other accepted standard model libraries in the future.
[PR #416] -
Metadata access. A metadata access expression has the form
elementName
.
metadata
, whereelementName
is a qualified name for any kind of element. Such an expression evaluates to a sequence of instances of the reflective metaclassKerML::Metaclass
representing the owned metadata feature annotations of the named element, in order. In addition, the last element of the sequence is always an instance of the reflective abstract syntax metaclass for the named element representing the instantiation of the element in the model.For example, given the model
import RiskMetadata::*; part def SystemDesign { metadata Risk { totalRisk = RiskLevelEnum::medium; } }
The expression
SystemDesign.
metadata
evaluates to a sequence of two values, the first of which is an instance of the metadata definitionRiskMetadata::Risk
, and the second of which is an instance ofSysML::PartDefinition
. The following operators are convenient for operating on such sequences of metadata:elementName
@@
Metaclass
is a shorthand forelementName
.
metadata
@
Metaclass
. It tests whether any of the metadata of the named element is a direct or indirect instance ofMetaclass
. For example, given the above sample model, the expressionsSystemModel @@ Risk
andSystemModel @@ SysML::Definition
both evaluate to true.elementName
meta
Metaclass
is a shorthand forelementName
.
metadata as
Metaclass
. It filters the metadata of the named element for only those that are instances ofMetaclass
. This is useful for accessing the values of features of the metadata. For example, given the above sample model,(SystemDesign
meta
Risk).totalRisk.probability
evaluates toLevelEnum::medium
and(SystemDesign
meta
KerML::Element).name
evaluates to"SystemDesign"
(note that the parentheses are required, due tometa
having the operator precedence of a binary operator).
[PR #416]
-
"Same" operator. The
===
operator checks if two occurrences are portions of the same life (i.e., have the same "identity"). The operator!==
is the inverse of===
. For example, given the modelpart car { timeslice drivenByAlice; then timeslice drivenByBob; }
the expression
car.drivenByAlice == car.drivenByBob
evaluates to false, because the two timeslices are different occurrences, butcar.drivenByAlice === car.drivenByBob
evaluates to true, because the two timeslices are both portions of the life of the samecar
. For data values (i.e., non-occurrences), the===
operator is the same as==
.Implementation Note: Expression evaluation in the pilot implementation currently does not implement the functionality of
===
and!==
and simply treats them the same as==
and!=
.
[PR #417]
SysML Only
-
Conjugated port typing. While the notation for conjugated port typing has not changed, the way the conjugated port definition is resolved has changed. Previously, in a declaration such as
port
p : ~P;
, the conjugated port typing was a relationship between the port usagep
and the port definitionP
, with the actual conjugated port definition being derived as the one owned byP
. Now, the conjugated port typing relationship is instead between the port usage and the actual conjugated port definition, which is found by resolving the constructed qualified nameP::'~P'
. The corresponding port definitionP
is now a derived property of the conjugated port typing, determined as the owning port definition of the conjugated port definition.
[PR #416] -
Send action. Send action syntax has been extended to include a new
via
clause:send
payload
via
sender
to
receiver
;
. This allows for arguments for both thesender
(via
) andreceiver
(to
) parameters ofSendAction
(see also the model library update description below). While having bothvia
andto
is allowed, it is expected that generally only one or the other will be used, withvia
being used to send "out" through a port (parallel to the use ofvia
on an accept action for accept "in" through a port).
[PRs #410, #416] -
Messages. The parsing of message declarations has changed. A declaration of the form
message from
sourceEvent
to
targetEvent
;
still parses to a connection usage, but without connection ends. Instead, it redefinesTransfer::sourceEvent
andTransfer::targetEvent
to reference the givensourceEvent
andtargetEvent
, respectively (see also model library update description below). This allows such a message to be realized by either a message connection in which thesourceEvent
is a send action and thetargetEvent
is an accept action, or a flow connection, such as between two ports, in which case thesource
andtarget
ports are also thesourceEvent
andtargetEvent
.
[PR #410]
Model Libraries
General
-
Library packages. All standard model library packages are now declared as
standard library package
.
[PR #416] -
Reflection. The reflective abstract syntax models
KerML
andSysML
now include all navigable properties from the normative MOF abstract syntax model as features of the corresponding metaclasses/metadata definitions.
[PR #408]
Kernel Semantic Library
- Event handling. Updated the models
Occurrences
,Performances
,Transfers
,TransitionPerformances
andStatePerformances
to capture semantics related to event handling, including prioritized dispatch, accept matching and run-to-completion.
[PR #410]
Kernel Functions Library
-
Base and data functions.
- Added the abstract function
'==='
toBaseFunctions
, for use as the function invoked by the===
operator. Added the function'!=='
as the opposite of'==='
and the function invoked by the!==
operator. - Added a specialization of
BaseFunctions::'==='
for data values toDataFunctions
, for which it is the same as'=='
.
[PR #417]
- Added the abstract function
-
Sequence functions. Added the following new functions to
SequenceFunctions
.same
compares whether two sequences are the same using===
(as opposed toequals
, which uses==
).includingAt
returns a sequence of values constructed from two input sequences by adding the second sequence at a given index in the first sequence.excludingAt
returns a sequence of values containing all the values from an input sequence except those within a given range of indices (inclusive).
Added the following behaviors for convenient "standalone" modification of a sequence given with an
inout
parameter:add
adds a sequence of values to the end of the input sequence (usingincluding
).addAt
adds a sequence of values at a given index of the input sequence (usingincludingAt
).remove
removes a set of values from the input sequence (usingexcluding
).removeAt
removes the values within a given range of indexes (inclusive) of the input sequence (usingexcludingAt
).
[PR #417]
-
Occurrence functions. Added a new
OccurrenceFunctions
package that defines functions that operate on occurrences, primarily related to the time during which those occurrences exist.'==='
specializesBaseFunctions::'==='
for occurrences. It tests whether two occurrences are portions of the same life. That is, whether they represent different portions of the same entity (colloquially, whether they have the same "identity").isDuring
tests whether a performance of the function happens during the input occurrence.create
ensures that the start of a given occurrence happens during a performance of this function. The occurrence is also returned from the function.destroy
ensures that the end of a given occurrence happens during a performance of this function. The occurrence is also returned from the function.addNew
adds a newly created occurrence to the given group of occurrences and returns the new occurrence.addNewAt
adds a newly created occurrence to the given ordered group of occurrences at the given index and returns the new occurrence.removeOld
removes a given occurrence from a group of occurrences and destroys it.removeOldAt
removes the occurrence at a given index in an ordered group of occurrences and destroys it.
[PR #417]
Systems Library
- Connections.
- Added
MessageConnection
as the most general base type for connection definitions and usages, withFlowConnection
as specialization ofMessageConnection
. - Added the features
sourceEvent
andtargetEvent
toMessageConnection
to identify the events occurrences within thesource
andtarget
of the connection that create and accept the connection as a transfer, e.g., a source send action and a target accept action. For non-message flow connection usages,sourceEvent
andtargetEvent
default tosource
andtarget
.
- Added
...
2022-08 - SysML v2 Pilot Implementation
This is an incremental update to the 2022-07 release. It corresponds to Eclipse plugin version 0.27.0.
Language Features
KerML
-
Unioning, intersecting and differencing. New relationships have been added for the unioning, intersecting and differencing of types. They are notated using new clauses that can be used in any kind of type declaration (including classifiers, features, connectors, etc.), included in the set of clauses that appear after the specialization part of the declaration.
unions
A, B, ...
– Specifies that the declared type has unioning relationships with each of the typesA, B, ...
, meaning that the declared type classifies everything that is classified by any of the listed types.intersects
A, B, ...
– Specifies that the declared type has intersecting relationships with each of the typesA, B, ...
, meaning that the declared type classifies everything that is classified by all of the listed types.differences
A, B, ...
– Specifies that the declared type has differencing relationships with each of the typesA, B, ...
, meaning that the declared type classifies everything that is classified by the first type but is not classified by any of the remaining types.
class Adult; class Child; class Person unions Adult, Child { feature dependents : Child[*]; feature offspring : Person[*]; feature grownOffspring : Adult[*] :> offspring; feature dependentOffspring : Child[*] :> dependents, offspring differences offspring, grownOffspring intersects dependents, offspring; }
[PR #396]
-
Reference subsetting. Previously, the related feature of a connector was related to a connector end using a regular subsetting relationship. Now a special referencing subsetting relationship is used instead, syntactically distinguishing the related feature from other subsetting features the connector end might have. Notationally, this means that, in the named connector end notation, the new keyword
references
or the equivalent symbol::>
must be used.connector :A from a1 ::> f to a2 ::> g; connector :B (b1 ::> f, b2 ::> g, b3 ::> h); connector :B { end b1 references f subsets x; end b2 subsets y references g; end b3 references h; }
[PR #394]
SysML
-
Flow connection definition. Previously, flow connection usages were typed by regular connection definitions specializing the base type
FlowConnection
. Now flow connection definitions have been added, and flow connection usages must (implicitly or explicitly) be typed by flow connection definitions. The notation is the same as for regular connection definitions, but using the keywordflow def
instead ofconnection def
. A flow connection definition is a connection definition, an action definition and a kernel interaction. A flow connection usage is now also an action usage, in addition to being a connection usage and a kernel item flow.
[PR #390] -
Reference subsetting. Reference subsetting is also used in the following places in SysML.
- Connections. To identify the related features of connections, as for KerML connectors (see above).
connection :A connect a1 ::> f to a2 ::> g; connection :B connect (b1 ::> f, b2 ::> g, b3 ::> h); connection :B { end b1 references f subsets x; end b2 subsets y references g; end b3 references h; }
- Usages. To identify the features referenced by certain kinds of usages.
- The asserted constraint of an assert constraint usage.
- The satisfied requirement of a satisfy requirement usage.
- The event occurrence of an event occurrence usage.
- The performed action of a perform action usage.
- The exhibited state of an exhibit state usage.
- The included use case of an include use case usage.
perform a; // This is equivalent to the following action. perform action references a; // The performed action is "a" in both of the following. perform action a1 references a subsets b; perform action a2 :> b ::> a; satisfy r by p; // This is equivalent to the following satisfy. satisfy requirement references r by p;
- Relationships. To identify the features referenced by certain kinds of membership relationships.
- The constraint referenced by a requirement constraint membership (
assume
orrequire
). - The concern referenced by a framed concern membership (
frame
). - The requirement referenced by a requirement verification membership (
verify
). - The rendering referenced by a view rendering membership (
render
).
requirement r { require c; // This is equivalent to the following required constraint. require constraint references c; // The referenced constraint is "c" in both of the following. assume constraint ac1 references c subsets d; assume constraint ac2 :> d ::> c; }
- The constraint referenced by a requirement constraint membership (
- Variants. The notation
variant
referenced-usage
now parses to a reference usage with a reference subsetting to thereferenced-usage
. However, there is no surface notational change, and there is no requirement to use reference subsetting otherwise in variant declarations.part p; variation part q { variant p; // This is equivalent to the following. variant ref p1 references p; variant part p2 subsets p; // But this is also still acceptable. }
[PR #394]
- Connections. To identify the related features of connections, as for KerML connectors (see above).
-
User-defined keywords. The notation has been updated to allow user-defined keywords in the following additional places.
assume
#keyword
constraint
constraint-usage
require
#keyword
constraint
constraint-usage
frame
#keyword
concern
concern-usage
verify
#keyword
requirement
requirement-usage
actor
#keyword
usage
stakeholder
#keyword
usage
subject
#keyword
usage
objective
#keyword
requirement-usage
Note. In items 1–4, the
constraint
,concern
, orrequirement
keyword is optional when a user-defined keyword is included. However, if neither keyword is included, then the declaration is a reference, rather than the declaration of a named usage. For example,require
aGoal;
is equivalent torequire constraint references
aGoal;
, whilerequire #goal
aGoal;
is equivalent torequire #goal constraint
aGoal;
, whereaGoal
is a name of the required constraint usage, not a reference to another constraint usage.
[PR #397]
Model Libraries
Systems Library
- Connections.
FlowConnection
andSuccessionFlowConnection
have been made flow connection definitions.flowConnections
andsuccessionFlowConnections
have been made messages (that is, flow connection usages without target output or source input features declared).
[PR #390]
Backward Incompatibilities
- Reserved words.
- KerML:
differences intersects references unions
- SysML:
references
- KerML:
- Reference subsetting. The reference subsetting must now be used in the named notation for the related features of a connector or connection end. In other cases in SysML, reference subsetting should be used to retain the same meaning as previously. For example, in
perform action
pa
subsets
a;
(orperform action
pa :> a;
),a
is no longer the performed action, it is simply a subsetted action. Instead, useperform action
pa
references
a;
(orperform action
pa ::> a;
).
[PR #394] - Prefix comments. Prefix comments (i.e, comments starting with
/**
) will no longer generate a warning. They will simply be parsed as regular comments about the namespace they are a member of (not about the following member). For example, inthe comment parses as being about packagepackage P { /** This is a comment */ attribute x; }
P
(notx
) with the body text* This is a comment
.
[PR #390]
Jupyter
None.
Visualization
-
PlantUML
- Updated to visualize language extensions with <<#...>> in the title. In addition, two new styles have been added:
HIDEMETADATA
– Do not render callouts to show metadata.SHOWMETACLASS
– Always show metaclasses for types as well as metadata usages.
[PR #385]
- Updated to visualize language extensions with <<#...>> in the title. In addition, two new styles have been added:
-
Tom Sawyer
None.
Technical Updates
None
Bug Fixes
- ItemFlow::itemType Fixed an error in the implementation of the derivation of
itemType
that caused anIndexOutOfBoundsException
.
[PR #386] - Message ends. Corrected bugs related to the parsing of
message
declarations.
[PR #387] - Conditional succession. Corrected the computation of the featuring type of an implicit connector/connection.
[PR #388] - Usage::isComposite. Fixed the default for the
isComposite
property of a usage.
[PR #389] - Conjugate port types (PlantUML). Fixed the rendering of conjugate port types (by using the effective name).
[PR #391] - State actions (PlantUML). Removed the slash from the rendering of state actions.
[PR #392] - Anonymous packages (PlantUML). Fixed the rendering of packages without names.
[PR #393] - Cyclic types (PlantUML). Prevented a
StackOverflowException
when rendering cyclic types.
[PR #395]
2022-07 - SysML v2 Pilot Implementation
This is an incremental update to the 2022-06 release. It corresponds to Eclipse plugin version 0.26.0.
Language Features
The notation for a number of kinds of elements has been extended to allow them to have bodies ({
...}
).
[PR #381]
KerML
-
Relationships. The
relationship
notation has be extended to allow any kind of element to be declared as an owned related element of a relationship, not justelement
declarations and annotations. In addition, the following relationship notations have also been extended to allow similar relationship bodies.- import
- alias
- specialization (including subclassification, subsetting and redefinition)
- conjugation
- disjoining
- inverting
- featuring
-
Multiplicities. The
multiplicity
declaration notation can now have a full feature body.
SysML
-
Relationships. The import, alias and dependency notations have been extended to allow bodies, but these bodies can only contain annotations (comments, documentation, textual representation or metadata).
-
Action body elements. The following notations (used within action definitions and actions usages) can now have full usage bodies.
- Guarded successions (
first
sourceName
if
condition
then
targetName
;
) - Target successions (
then
targetName
;
andif
condition
then
targetName
;
) - Control nodes (
fork
,join
,decision
,merge
)
- Guarded successions (
-
Transition usages. Within state definition and usage bodies, transition usages can now have full action bodies.
Model Libraries
Kernel Libraries
-
Subdirectories. The Kernel Libraries directory has been reorganized into three subdirectories:
- Kernel Semantic Library – Library models that provide the base types for required implicit specializations in KerML user model constructs, plus additional semantic models for more advanced capabilities (such as state-based behavior, etc.).
- Kernel Data Type Library – Library models of standard data types that can be used in user models.
- Kernel Function Library – Library models of standard functions that can be used in user models, including functions corresponding to all the operators in the KerML expression syntax.
[PR #384]
-
Local clocks.
- Clocks. The singleton
defaultClock
feature has been renamed touniversalClock
. The defaults for theclock
parameters of theTimeOf
andDurationOf
functions have been changed fromdefaultClock
tolocalClock
(see below). - Occurrences. A
localClock
feature has been added toOccurrence
that defaults toClocks::universalClock
. ThelocalClock
of anOccurrence
is passed down as the default for each of its composite suboccurrences. - SpatialFrames. The defaults for the
clock
parameters of various functions in this package have been changed fromdefaultClock
toframe.localClock
. - Triggers. The defaults for the
clock
parameters ofTriggerAt
andTriggerWhen
have been changed fromdefaultClock
tolocalClock
.
[PR #382]
- Clocks. The singleton
Domain Libraries
-
Local clocks.
- Time. The singleton
defaultClock
part has been renamed touniversalClock
. The defaults for theclock
parameters of theTimeOf
andDurationOf
calculation definitions have been changed fromdefaultClock
tolocalClock
. - SpatialItems. The existing declaration of
localClock
forSpatialItem
has been updated to redefineOccurrences::localClock
and default toTime::universalClock
.
[PR #382]
- Time. The singleton
The above updates for local clocks allow, for example, the following:
part context {
// This defines a local clock used by default within the “context” part.
part :>> localClock = Time::Clock();
state behavior {
entry; then S1;
state S1;
transition
first S1
// The time instant in the trigger is, by default,
// relative to context::localClock.
accept at Time::Iso8601DateTime("22-05-12T00:00:00")
then S2;
state S2;
}
}
Backward Incompatibilities
The following textual notations have been removed, because they are considered to have become redundant or unnecessary as the notation has evolved.
[PR #381]
-
Logical operators. For certain Boolean operators, the expression notation currently includes both operator symbols (adapted from C/Java expression syntax) and equivalent operator keywords (introduced later). This release removes the operator symbols in favor of the keywords.
Removed Retained !
not
&&
and
||
or
^^
xor
=>
implies
... ? ... : ...
if
... ? ...
else
...
Note that the pure logical operators
&
and|
have also been retained. -
Parameter declaration. The textual syntax previously allowed for a parenthesized functional notation for declaring the parameters of a behavioral element (e.g., behaviors and steps in KerML and action definitions and usages in SysML), similarly to how parameters are declared in many programming languages. However, in KerML and SysML, parameters are simply directed features of behavioral elements which can also be declared in the body of a behavioral element. This release removes the parenthesized notation in favor of consistently using the same directed feature declaration syntax used for structural elements (e.g., ports).
Previously allowed
action def A ( x : T1, out y : T2 ); calc def B ( x : T1; ) return : T2;
Alternative using directed features
action def A { in x : T1, out y : T2 } calc def C { in x : T1; return : T2; }
Note that the direction must be provided when declaring a parameter as a directed feature (unlike the special parameter notation, in which
in
was the default), otherwise the feature will not be directed and not considered a parameter. Parenthesized functional notation is can still be used for invoking a function or calculation in an expression, e.g.,C(t1)
. -
flow from
shorthand. The textual notation previously allowed for aflow from
shorthand on a usage declaration, for a flow connection into that usage, similar to the feature value shorthand for a binding. This has been eliminated. -
Prefix comments. Previously, a comment starting with
/**
(i.e., with two stars instead of one) was parsed as a "prefix comment", which was automatically about the lexically following element in a namespace body. This notation has been eliminated in favor of using a documentation (doc
) comment nested in the body of the element being annotated. In order to allow this more generally, the textual syntax has also been extended to allow bodies on elements that where not able to have them before (see "Language Features" above).(For this release only, the previous prefix comment notation will generate a warning that the notation is no longer supported. This warning will be removed in the next release, at which point the notation will simply parse as a regular comment without any warning.)
Jupyter
None.
Visualization
- PlantUML
- Feature values whose value expression is a feature reference or a feature chain are now visualized as binding connectors on interconnection and action views.
[PR #379]
- Feature values whose value expression is a feature reference or a feature chain are now visualized as binding connectors on interconnection and action views.
- Tom Sawyer
- Fixed the visualization of connectors on structural interconnection diagrams.
Technical Updates
- Derived properties. The implementation for all derived properties has been moved from handwritten, in-line method code in metamodel
Impl
classes into separate delegate classes, using the Eclipse "setting delegate" mechanism.
[PR #380]
Bug Fixes
- State and state transition performances. Errors in the Kernel Library models for
StatePerformance
andStateTransitionPerformance
have been corrected.
[PR #383]
2022-06 - SysML v2 Pilot Implementation
This is an incremental update to the 2022-05 release. It corresponds to Eclipse plugin version 0.25.0.
Language Features
None.
Model Library
Metadata Domain Library
-
Refinement. A metadata definition for
Refinement
(short namerefinement
) has been added to the existingModelingMetadata
package. This can be applied to a dependency declaration to model a refinement relationship in which the source elements refine the target elements. No formal semantics is provided for this relationship at this time. For example:part def DesignModel; package Specification; requirement def SystemRequirements; #refinement dependency DesignModel to Specification, SystemRequirements;
[PR #377]
-
Parameters of Interest. The new
ParametersOfInterestMetadata
package contains two metadata definitions for marking attribute usages that as aMeasureOfEffectiveness
(short namemoe
) or aMeasureOfPerformance
(short namemop
).
[PR #375] -
Images. The new
ImageMetadata
package includes the following.-
Image
attribute definition, which captures the data necessary for the physical definition of a graphical image. This can be used directly withinIcon
annotations (see below), or it can be used to create library models of image usages that can be referenced fromIcon
annotations. Alternatively, the images themselves can be physically stored in separate resources from the SysML model and referenced by URI. -
Icon
metadata definition, which can be used to annotate a model element with an image to be used to show render the element on a diagram and/or a small image to be used as an adornment on a graphical or textual rendering. Alternatively, another metadata definition can be annotated with anIcon
to indicate that any model element annotated by the containing metadata can be rendered according to theIcon
.
[PR #373]
-
Requirements Derivation Domain Library
This new model library contains two packages to address the modeling of derived requirements.
-
DerivationsConnections
package.Derivation
is an abstract connection definition with no ends, but having two non-end requirement usages, one for anoriginalRequirement
and one for all correspondingderivedRequirements
. This connection definition also asserts that theoriginalRequirement
value is not one of thederivedRequirements
values and, if the check of theoriginalRequirement
is true, then the checks for all thederivedRequirements
are true.
-
RequirementDerivation
package.DerivationMetadata
(short namederivation
) is semantic metadata for declaringDerivation
connections.OriginalRequirementMetadata
andDerivedRequirementMetadata
(short namesoriginal
andderived
– note that "derived" is already a reserved word) are semantic metadata for marking usages representing original and derived requirements, particularly on the end features ofDerivation
connections.
A connection definition or usage specializing Derivation
can add one end feature for the desired original requirement, subsetting originalRequirement
, and one or more end features for the derived requirements, subsetting derivedRequirements
. This can be modeled succinctly using the metadata from the RequirementDerivation
package (which also publicly reexports the content of the DerivationsConnection
package).
For example:
requirement req1;
requirement req1_1;
requirement req1_2;
#derivation connection {
end #original :> req1;
end #derive :> req1_1;
end #derive :> req1_2;
}
[PR #378]
Cause and Effect Domain Library
This new model library contains two packages to address cause-and-effect modeling.
-
CausationConnections
package.Multicausation
is an abstract connection definition with no ends, but having two non-end features that collect cause occurrences and effect occurrences. This connection definition also asserts constraints that the the intersection of causes and effects is empty and that all causes exist (i.e, have at least started) before all effects.Causation
as a binary connection definition that specializesMulticausation
for the simple case of a binary relationship between one cause and one effect.
-
CauseAndEffect
package.CausationMetadata
is a metadata definition that can be used to annotate whether a causationisNecessary
and/orisSufficient
, and what itsprobability
is.MulticausationSemanticMetadata
andCausationSemanticMetadata
(short namesmulticausation
andcausation
) are semantic metadata for declaring (respectively)Multicausation
andCausation
connection definitions and usages.CauseMetadata
andEffectMetadata
(short namescause
andeffect
) are semantic metadata for marking usages as representing causes or effects in causations (particularly on the end features of multicausation connections).
A connection usage typed by Multicausation
can add end features to relate the desired causes and effects. Each such end feature should subset one of the desired causes or effects and subset either the causes
(for a cause) or effects
(for an effect) feature of Mulitcausation
. A binary causation can be modeled by a connection usage typed by Causation
, in which case the first related element is the cause and the second one is the effect.
This modeling approach is simplified by use of the semantic metadata from the CauseAndEffect
package (which also publicly reexports the content of the CausationConnections
package).
// Causes and effects can be any kinds of occurrences.
occurrence a;
item b;
part c;
action d;
// The #multicausation keyword identifies this as a Multicausation connection.
// The ends tagged #cause are the causes, and the ends tagged #effect are the effects.
#multicausation connection {
end #cause :> a;
end #cause :> b;
end #effect :> c;
end #effect :> d;
}
Instead of tagging the ends of the connection, the connected usages can instead be identified as causes and effects, allowing for a more compact connector syntax. Note that each such usage can be a cause or an effect, but not both.
#cause causeA :> a;
#cause causeB :> b;
#effect effectC :> c;
#effect effectD :> d;
#multicausation connect ( causeA, causeB, effectC, effectD );
For a binary causation, it is not necessary to use the #cause
and #effect
keywords, because the first related element is always the cause and the second related element is always the effect.
#causation connect a to c;
CausationMetadata
includes isNecessary
, isSufficient
and probability
attributes that can be used with causation and multicausation connections. (No further formal semantic model has been provided for these attributes at this time.)
#causation connect b to d {
@CausationMetadata {
isNecessary = true;
probability = 0.1;
}
}
[PR #376]
Backward Incompatibilities
None.
Jupyter
None.
Visualization
- PlantUML
None. - Tom Sawyer
None.
Technical Updates
None.
Bug Fixes
2022-05 - SysML v2 Pilot Implementation
This is an incremental update to the 2022-04 release. It corresponds to Eclipse plugin version 0.24.0.
Language Features
-
Feature inverses (KerML only). A new feature inverting relationship has been added. The basic notation for this relationship is
inverting
name
inverse
featureInverted
of
invertingFeature
;
The
inverting
name
part may be omitted.A feature inverting that is owned by its
featureInverted
may be specified in the declaration of that Feature:feature
featureInverted
inverse of
invertingFeature
;
The
inverse of
invertingFeature
part must come after any specialization or conjugation part in the Feature declaration. However, it is now allowable to specify the chaining, disjoining, inverting and featuring parts of a Feature declaration in any order.Two features related by a feature inverting relationship are asserted to be inverses of each other. The features can be arbitrarily nested. So, for example, given
classifier A { feature b1 :B { feature c1 : C; } }
and
classifier C { feature b2 : B { feature a2 : A inverse of A::b1::c1; } }
then it must always be the case that, for any
a1 : A
,a1.b1.c1.b2.a2 == a1
.
[PR #361] [PR #366]
Model Library
Kernel Library
-
Base. A new
that
feature has been added as a nested feature ofthings
, the base for all features. It is constrained inAnything
(the base type of everything) such that thethat
reference for all values reached by navigating through any nested feature of anything is the nesting thing.For example, given
classifier Example { feature f; } feature x : Example[1];
the value of
x.f.that
isx
.
[PR #365] -
Occurrences. Space modeling additions:
- inner and outer space boundaries. In
Occurrence
,inner
andouter
occurrence references have been added, nested underspaceBoundary
. These are space slices that also have nospaceBoundary,
where theouter
one surrounds theinner
ones (seeSurroundedBy
below). - OutsideOf associations. The following new associations from Occurrence to itself (indirectly) specialize the existing association
OutsideOf
:JustOutsideOf
, linking occurrences that have space slices with no space between them (MatesWith
).MatesWith
, specializingJustOutsideOf
, linking occurrences that have no space between them.InnerSpaceOf
, linking an occurrence to another that completely occupies the space surrounded by aninner
space boundary of the first occurrence. AddedOccurrence::innerSpaceOccurrences
as the cross-navigation feature for this.SurroundedBy
, linking an occurrence that is included in space by aninnerSpaceOccurrence
of the other. Types additional connectors inOccurrence
that ensurespaceBoundary
surroundsspaceInterior
andspaceInterior
surroundsinner
space boundaries.
[PR #360]
- inner and outer space boundaries. In
-
Performances. A new
this
feature provides a context for performances similar to the "this" pointer in object-oriented programming languages such as C++, Java and JavaScript. For all occurrences that are not performances (such as items and parts in SysML),this
defaults toself
. For performances that are owned via composite features of an object (including owned actions of a part),this
is the owning object. For performances that are owned via composite features of a performance (such as subactions in SysML),this
defaults to the same value as for the owning performance.So, for example, an action declared at "package level" will be the
this
reference for all subactions in the composition tree it roots:package Example1 { action def A { action b { action c; } } action a : A; // a.b.c.this == a }
On the other hand, an action declared within a part definition will have an instance of that part definition as the
this
reference for itself and all subactions within it:package Example2 { part def C { action a { action b; } } part c : C; // c.a.b.this == c }
[PR #365]
Systems Library
-
Items. Space modeling additions:
- Generalized
Item::envelopingShapes
to cover curves and surfaces enveloping two dimensional shapes. - Added
Item::boundingShapes
specializingenvelopingShapes
asStructuredSpaceObjects
in which every face/edge intersects the item. - Added
Item::voids
as the SysML name forinnerSpaceOccurrences
. DefinedisSolid
as having novoids
.
[PR #360]
- Generalized
-
Actions.
AcceptAction
has areceiver
parameter that references the occurrence via which anincomingTransfer
may be accepted. The declaration forAcceptAction
has been updated so that the defaultreceiver
isthis
(see description above). In the concrete syntax for accept actions, thereceiver
is specified using avia
clause. The default is used if novia
clause is given. For example, inpart def Device { state Device_Behavior { state off; transition first off accept On_Signal then on; state on; } }
the default receiver for
accept On_Signal
is the instance ofDevice
owning theDevice_Behavior
performance. (Note that this is similar to the concept of the "context object" for event pooling in UML/SysML v1.)Note. Performed actions and exhibited states are always referential, not composite. Therefore, the subactions of a performed action or exhibited state do not have the performing or exhbiiting part as their
this
reference. Instead,this
is determined by the composite structure that actually contains the action or state being performed/exhibited.
[PR #365]
Backward Incompatibilities
- Reserved words (KerML). Added:
inverting
inverse
this
andthat
. The new featurethis
is inherited by all kinds of occurrences (e.g. SysML items, parts, actions, etc.). The featurethat
is inherited by all nested features (SysML usages). Therefore, the namesthis
orthat
for features in user models.
[PR #365]- MeasurementReferences. The Quantities and Units Domain LIbrary package
UnitsAndScales
has been renamed toMeasurementReferences
, which better reflects what it contains (units and scales are kinds of measurement references). References to the package in all other library and example models in the repository have been updated to the new name.
[PR #369] - Subsetting validation. The validation of the owner of a subsetted feature has been tightened. This may cause some new warnings in existing models. This can usually be corrected using the dot notation.
[PR #368]
Jupyter
None.
Visualization
- PlantUML
- Improved the rendering of features whose types are vector quantities.
[PR #362 ]
- Improved the rendering of features whose types are vector quantities.
- Tom Sawyer
None.
Technical Updates
- Security advisories. Removed
yarn.lock
and prevented it from being recommitted for the JupyterLab extension. This eliminates security advisory notifications related to declared version dependencies.
[PR #363]
Bug Fixes
2022-04 - SysML v2 Pilot Implementation
This is an incremental update to the 2022-03.1 release. It corresponds to Eclipse plugin version 0.23.0.
Language Features
- Short names. What was previously called the "human ID" of an element is now known as its short name. However, the surface notation remains the same, e.g.,
part
<shortName> longDescriptiveName;
. Aliases can now also have short names, e.g.,alias
<shortAlias> longDescriptiveAlias
for
longDescriptiveName;
. The name resolution rules for short names are identical to those for regular names.
[PR #359] - Owning membership. The owned members of a namespace are now related to the namespace using a specialized membership relationship called an owning membership. Previously, the name of an element was derived as the member name given in the membership that owned it. Now, the element name is no longer derived and, instead, the owned member name of an owning membership is derived as the name of its owned member element. This has no effect on the surface notation, but may effect how a model is traversed, e.g., by a tool using the API.
[PR #359] - Invocation arguments. The argument expressions in an invocation expression are now parsed as feature values on the argument parameters, similarly to how parameter values would naturally be bound in a KerML
expr
or SysMLcalc
usage. For example,F(x=1, y=2)
now parses essentially equivalently to[PR #359]expr : F { in feature redefines x = 1; in feature redefines y = 2; }
Model Library
Kernel Library
- Control functions. The
expr
features on various Functions in theControlFunctions
package have now all been marked asin
parameters, which work consistently with the new parsing for invocation expressions, as described above. Previously, these features were not parameters and were handled as special cases for the invocations of these Functions.
[PR #357]
Quantities and Units Domain Library
- UnitsAndScales.
CoordinateFrame
has been added as a specialization ofVectorMeasurementReference
along with three concrete specializations ofCoordinateTransformation
, namelyCoordinateFramePlacement
,TranslationRotationSequence
andAffineTransformationMatrix3D
. Minor updates have been made to other models in theUnitsAndScales
package consistent with this.
[PR #354]
Geometry Domain Library
-
ShapeItems. The
ShapeItems
library model has been revised and significantly expanded.
[PR #357] -
SpatialItems.
SpacialItem
has been updated to use the newCoordinateFrame
type.
[PR #354]
Backward Incompatibilities
- Reserved words (KerML). Added:
chains
Removed:is
- Features (KerML only).
- The
feature
x
is
y;
notation for un-owned features is no longer supported. - The
feature
x
is
a.b.c;
notation for named feature chains has been replaced with thechains
clause in a feature declaration, e.g.,feature
x
chains
a.b.c;
. This clause may be used in conjunction with all other parts of a regular feature declaration. It comes after any specialization part and before any disjoining or type featuring part, e.g.,feature
x : T
subsets
y
chains
a.b.c
disjoint with
z;
- The
- Invocations. As part of the update to the parsing of invocation expressions, there are some additional validations that existing models could now potentially fail.
- If an invocation expression uses named argument notation, then each of the arguments must all name input parameters of the invoked function, and any parameter must be referenced at most once.
- If a body expression (i.e., one with the form
{...}
) is used as the argument of an invocation expression, then the corresponding parameter of the invoked function must have anEvaluation
type (which is the case, e.g., if the parameter is a KerMLexpr
or SysMLcalc
).
[PR #359]
- Coordinate frames.
- A general
VectorMeasurementReference
no longer has aplacement
. Instead, use aCoordinateFrame
whosetransformation
is aCoordinateFramePlacement
. - Various specializations of
VectorMeasurementReference
in the ISQ library models that previously had names of the form...CoordinateSystem
now have names of the form...CoordinateFrame
(e.g.,ISQBase::Cartesian3dSpatialCoordinateSystem
is now calledISQBase::Cartesian3dSpatialCoordinateFrame
).
[PR #354]
- A general
- Shapes. In a small number of cases, changes to the
ShapeItems
library model may not be compatible with uses of the previous version of this model. Corrections should be obvious from reviewing the latestShapeItems
model.
[PR #357]
Jupyter
None.
Visualization
- PlantUML
- Minor improvements as part of baseline update.
[PR #359]
- Minor improvements as part of baseline update.
- Tom Sawyer
- Fixed visualization of connectors on behavioral connector diagrams.
Technical Updates
None.
Bug Fixes
- Model libraries. Fixed the
SystemUtil.isModelLibrary
method so that it works correctly on Windows.
[PR #358]
2022-03.1 - SysML v2 Pilot Implementation
This release is the same as the 2022-03 release, except that it adds highlighting for user-defined keywords in Jupyter. It corresponds to Eclipse plugin version 0.22.1.
The release notes for 2022-03 are repeated below for convenience
Language Features
-
Metadata annotation.
- Definition. Previously, metadata was defined simply as a
datatype
in KerML or anattribute def
in SysML. Now it is defined using ametaclass
in KerML (which is a kind ofstruct
) or ametadata def
in SysML (which is a kind ofitem def
). - Usage. Most syntactic restrictions on a feature declared in the body of a
metadata
declaration have been removed. In particular, it is now possible for a feature defined in the body of ametadata
declaration to itself have nested subfeatures. However, some additional validation checks have also been implemented for such features (see details under "Backwards Incompatibilities" below). - Annotated elements. A metadata definition or usage now, by default, inherits an
annotatedElement
feature from the Kernel base metaclassMetaobject
. If this feature is (concretely) subsetted or redefined in a metadata definition or usage to have a more restrictive metaclass (using the reflectiveKerML
orSysML
models) than the default ofKerML::Element
, then the metadata can only annotate elements consistent with that metaclass. For example, if a metadata definition includes the redefinition:>> annotatedElement : SysML::PartUsage;
, then any usage of that definition can only annotate part usages.
[PR #347]
- Definition. Previously, metadata was defined simply as a
-
Semantic metadata. The new Kernel Library package
Metaobjects
defines the metaclassSemanticMetadata
(see below). Any metaclass or metadata definition that specializesSemanticMetadata
should bind the inheritedbaseType
feature to a reference to a feature or usage from a user library model (see "Casting" below on how to do this). When such a specialization ofSemanticMetadata
is used to annotate an appropriate type declaration, the specifiedbaseType
is used as the implicit base specialization of the annotated type.- If the annotated type is a Feature/Usage, then the annotated feature implicitly subsets the
baseType
. - If the annotated type is a Classifier/Definition, then the annotated classifier implicitly subclassifies each type of the
baseType
.
Note. It is currently only possible to specify a feature or usage as a
baseType
. This will be expanded to also allow classifiers in the future.
[PR #349] - If the annotated type is a Feature/Usage, then the annotated feature implicitly subsets the
-
Casting. The cast operator
as
has been implemented for model-level evaluable expressions. In addition, if the target type of the case is a metaclass, and the argument expression evaluates to a feature whose abstract syntax metaclass conforms to the given metaclass, then the result is a "meta-upcast" to the metaobject representation of the feature. E.g., ifvehicle
is a part usage, thenvehicle
as
KerML::Feature
evaluates, as a model-level evaluable expression, to a MetadataFeature forvehicle
with typeSysML::PartUsage
. This can be used, for example, to bindbaseType = vehicle
as
KerML::Feature;
forSemanticMetadata
.
[PR #349] -
Keywords (SysML only). A user-defined keyword is a (possibly qualified) metaclass/metadata definition name or human ID preceded by the symbol
#
. Such a keyword can be used in the SysML textual notation in package, dependency, definition and usage declarations.- The user-defined keyword is placed immediately before the language-defined (reserved) keyword for the declaration and specifies a metadata annotation of the declared element. For example, if
SafetyCritical
is a visible metadata definition, then#SafetyCritical
part
brakes;
is equivalent topart
brakes { @SafetyCritical; }
. It is not possible to specify nested features for a metadata feature annotation in the keyword notation. - If the given metaclass or metadata definition is a kind of
SemanticMetadata
, then the implicit specialization rules given above for "Semantic metadata" apply. In addition, a user-defined keyword for semantic metadata may also be used to declare a definition or usage without using any language-defined keyword. For example, ifprovider
is the human ID of a specialization ofSemanticMetadata
whosebaseType
is the featureserviceProviders : ServiceProvider
, then#provider
def
BankingService;
is a definition with an implicit subclassification ofServiceProvider
and#provider bankingService;
is a usage with an implicit subsetting ofserviceProviders
.
[PR #349]
- The user-defined keyword is placed immediately before the language-defined (reserved) keyword for the declaration and specifies a metadata annotation of the declared element. For example, if
Model Library
Kernel Library
-
Metaobjects. This is a new package with the following members.
- Metaclass
Metaobject
(subclassifiesObjects::Object
) is the implicit base type of all metaclasses. - Metaclass
SemanticMetadata
(subclassifiesMetaobject
) is used to extend the language implicit specialization mechanism for use with user-defined semantic libararies (see "Semantic metadata" above). - Feature
metaobjects
is the implicit base type of all metadata features. (This is not itself a metadata features, because a metadata feature is an annotating element, whilemetaobjects
is not.)
[PR #347]
- Metaclass
-
KerML. All
struct
declarations in theKerML
package have been changed tometaclass
(withElement
implicitly subclassifyingMetaobject
). (Note that the reflectiveKerML
abstract syntax model still does not include any features on these metaclasses.)
[PR #347]
Systems Library
-
Metadata. This is new package with the following members.
- Metadata definition
MetadataItem
(subclassifiesItems::Item
andMetaobjects::Metaobject
) is the implicit base type of all metadata definitions. - Item usage
metadataItems
is the implicit base type of all metadata usages. (This is not itself a metadata usage, because a metadata usages is an annotating element, whilemetadataItems
is not.)
[PR #347]
- Metadata definition
-
SysML. All
item def
declarations in theSysML
package have been changed tometadata def
. (Note that the reflectiveSysML
abstract syntax model still does not include any features on these metadata definitions.)
[PR #347]
Analysis and Metadata Domain Libraries
- Metadata definitions. Those attribute definitions in packages
AnalysisTooling
,ModelingMetadata
andRiskMetadata
that were intended to be used to define metadata have been changed to metadata definitions.
[PR #347]
Backward Incompatibilities
-
Keywords. KerML: added
metaclass
. SysML: removedfeature
. -
Annotations. An annotation relationship is no longer added to an annotating element that is an owned member of a namespace and does not explicitly specify any annotated elements (i.e., no
about
part). Instead, its owning namespace is simply considered to be the annotated element by default, without the need for an annotation relationship. (There is no change to the concrete syntax notation.)
[PR #347] -
Documentation. Documentation is now a special kind of comment that always has its owning element as its single annotated element, rather than a special kind of annotation association to a regular comment element. (There is no change to the
doc
notation, just a different mapping to the abstract syntax.)
[PR #347] -
Prefix Comments. The
comment
keyword is now used for a prefix comment (/**
...*/
), e.g., to give it a name, rather than thedoc
keyword. Previously, prefix comments were supposed comments owned by the following element using a documentation relationship, but it was difficult to implement them that way. They are now ordinary (non-documentation) comments that are just always about the lexically following element.
[PR #347] -
Metadata.
- The following validation checks are now performed on the declaration of a metadata feature or usage:
- It must be defined by a concrete metaclass (in KerML) or metadata definition (in SysML).
- Each of its nested features/usages (if any) must pass the following validation checks:
- It must redefine a feature (owned or inherited) of a generalization of its owning feature.
- If it has a feature value, the value expression must be model-level-evaluable.
- Each of its nested features (if any) must also pass these validation checks.
- Usages declared in the body of a metadata usage are now parsed as reference usages. The optional keyword for their declaration is therefore now
ref
instead offeature
.
[PR #347]
- The following validation checks are now performed on the declaration of a metadata feature or usage:
-
Classifier base type. A validation check has been added that a classifier or definition directly or indirectly specializes the correct library base type. This will typically only be violated for vacuous circular specializations or invalid circular conjugations.
[PR #351]
Jupyter
- Highlighting. User-defined keywords starting with
#
are highlighted like reserved words.
Visualization
-
PlantUML
- Improve rendering of connections.
- Support visualization of
- inherited feature ends or expressions.
- nested features in metadata annotations
- ports with directed features
[PR #348]
-
Tom Sawyer
None.
Technical Updates
- Vulnerability. Updated
yarn.lock
to address security alerts.
[PR #346]
Bug Fixes
2022-03 - SysML v2 Pilot Implementation
This is an incremental update to the 2022-02 release. It corresponds to Eclipse plugin version 0.22.0.
Language Features
-
Metadata annotation.
- Definition. Previously, metadata was defined simply as a
datatype
in KerML or anattribute def
in SysML. Now it is defined using ametaclass
in KerML (which is a kind ofstruct
) or ametadata def
in SysML (which is a kind ofitem def
). - Usage. Most syntactic restrictions on a feature declared in the body of a
metadata
declaration have been removed. In particular, it is now possible for a feature defined in the body of ametadata
declaration to itself have nested subfeatures. However, some additional validation checks have also been implemented for such features (see details under "Backwards Incompatibilities" below). - Annotated elements. A metadata definition or usage now, by default, inherits an
annotatedElement
feature from the Kernel base metaclassMetaobject
. If this feature is (concretely) subsetted or redefined in a metadata definition or usage to have a more restrictive metaclass (using the reflectiveKerML
orSysML
models) than the default ofKerML::Element
, then the metadata can only annotate elements consistent with that metaclass. For example, if a metadata definition includes the redefinition:>> annotatedElement : SysML::PartUsage;
, then any usage of that definition can only annotate part usages.
[PR #347]
- Definition. Previously, metadata was defined simply as a
-
Semantic metadata. The new Kernel Library package
Metaobjects
defines the metaclassSemanticMetadata
(see below). Any metaclass or metadata definition that specializesSemanticMetadata
should bind the inheritedbaseType
feature to a reference to a feature or usage from a user library model (see "Casting" below on how to do this). When such a specialization ofSemanticMetadata
is used to annotate an appropriate type declaration, the specifiedbaseType
is used as the implicit base specialization of the annotated type.- If the annotated type is a Feature/Usage, then the annotated feature implicitly subsets the
baseType
. - If the annotated type is a Classifier/Definition, then the annotated classifier implicitly subclassifies each type of the
baseType
.
Note. It is currently only possible to specify a feature or usage as a
baseType
. This will be expanded to also allow classifiers in the future.
[PR #349] - If the annotated type is a Feature/Usage, then the annotated feature implicitly subsets the
-
Casting. The cast operator
as
has been implemented for model-level evaluable expressions. In addition, if the target type of the case is a metaclass, and the argument expression evaluates to a feature whose abstract syntax metaclass conforms to the given metaclass, then the result is a "meta-upcast" to the metaobject representation of the feature. E.g., ifvehicle
is a part usage, thenvehicle
as
KerML::Feature
evaluates, as a model-level evaluable expression, to a MetadataFeature forvehicle
with typeSysML::PartUsage
. This can be used, for example, to bindbaseType = vehicle
as
KerML::Feature;
forSemanticMetadata
.
[PR #349] -
Keywords (SysML only). A user-defined keyword is a (possibly qualified) metaclass/metadata definition name or human ID preceded by the symbol
#
. Such a keyword can be used in the SysML textual notation in package, dependency, definition and usage declarations.- The user-defined keyword is placed immediately before the language-defined (reserved) keyword for the declaration and specifies a metadata annotation of the declared element. For example, if
SafetyCritical
is a visible metadata definition, then#SafetyCritical
part
brakes;
is equivalent topart
brakes { @SafetyCritical; }
. It is not possible to specify nested features for a metadata feature annotation in the keyword notation. - If the given metaclass or metadata definition is a kind of
SemanticMetadata
, then the implicit specialization rules given above for "Semantic metadata" apply. In addition, a user-defined keyword for semantic metadata may also be used to declare a definition or usage without using any language-defined keyword. For example, ifprovider
is the human ID of a specialization ofSemanticMetadata
whosebaseType
is the featureserviceProviders : ServiceProvider
, then#provider
def
BankingService;
is a definition with an implicit subclassification ofServiceProvider
and#provider bankingService;
is a usage with an implicit subsetting ofserviceProviders
.
[PR #349]
- The user-defined keyword is placed immediately before the language-defined (reserved) keyword for the declaration and specifies a metadata annotation of the declared element. For example, if
Model Library
Kernel Library
-
Metaobjects. This is a new package with the following members.
- Metaclass
Metaobject
(subclassifiesObjects::Object
) is the implicit base type of all metaclasses. - Metaclass
SemanticMetadata
(subclassifiesMetaobject
) is used to extend the language implicit specialization mechanism for use with user-defined semantic libararies (see "Semantic metadata" above). - Feature
metaobjects
is the implicit base type of all metadata features. (This is not itself a metadata features, because a metadata feature is an annotating element, whilemetaobjects
is not.)
[PR #347]
- Metaclass
-
KerML. All
struct
declarations in theKerML
package have been changed tometaclass
(withElement
implicitly subclassifyingMetaobject
). (Note that the reflectiveKerML
abstract syntax model still does not include any features on these metaclasses.)
[PR #347]
Systems Library
-
Metadata. This is new package with the following members.
- Metadata definition
MetadataItem
(subclassifiesItems::Item
andMetaobjects::Metaobject
) is the implicit base type of all metadata definitions. - Item usage
metadataItems
is the implicit base type of all metadata usages. (This is not itself a metadata usage, because a metadata usages is an annotating element, whilemetadataItems
is not.)
[PR #347]
- Metadata definition
-
SysML. All
item def
declarations in theSysML
package have been changed tometadata def
. (Note that the reflectiveSysML
abstract syntax model still does not include any features on these metadata definitions.)
[PR #347]
Analysis and Metadata Domain Libraries
- Metadata definitions. Those attribute definitions in packages
AnalysisTooling
,ModelingMetadata
andRiskMetadata
that were intended to be used to define metadata have been changed to metadata definitions.
[PR #347]
Backward Incompatibilities
-
Keywords. KerML: added
metaclass
. SysML: removedfeature
. -
Annotations. An annotation relationship is no longer added to an annotating element that is an owned member of a namespace and does not explicitly specify any annotated elements (i.e., no
about
part). Instead, its owning namespace is simply considered to be the annotated element by default, without the need for an annotation relationship. (There is no change to the concrete syntax notation.)
[PR #347] -
Documentation. Documentation is now a special kind of comment that always has its owning element as its single annotated element, rather than a special kind of annotation association to a regular comment element. (There is no change to the
doc
notation, just a different mapping to the abstract syntax.)
[PR #347] -
Prefix Comments. The
comment
keyword is now used for a prefix comment (/**
...*/
), e.g., to give it a name, rather than thedoc
keyword. Previously, prefix comments were supposed comments owned by the following element using a documentation relationship, but it was difficult to implement them that way. They are now ordinary (non-documentation) comments that are just always about the lexically following element.
[PR #347] -
Metadata.
- The following validation checks are now performed on the declaration of a metadata feature or usage:
- It must be defined by a concrete metaclass (in KerML) or metadata definition (in SysML).
- Each of its nested features/usages (if any) must pass the following validation checks:
- It must redefine a feature (owned or inherited) of a generalization of its owning feature.
- If it has a feature value, the value expression must be model-level-evaluable.
- Each of its nested features (if any) must also pass these validation checks.
- Usages declared in the body of a metadata usage are now parsed as reference usages. The optional keyword for their declaration is therefore now
ref
instead offeature
.
[PR #347]
- The following validation checks are now performed on the declaration of a metadata feature or usage:
-
Classifier base type. A validation check has been added that a classifier or definition directly or indirectly specializes the correct library base type. This will typically only be violated for vacuous circular specializations or invalid circular conjugations.
[PR #351]
Jupyter
None.
Visualization
-
PlantUML
- Improve rendering of connections.
- Support visualization of
- inherited feature ends or expressions.
- nested features in metadata annotations
- ports with directed features
[PR #348]
-
Tom Sawyer
None.
Technical Updates
- Vulnerability. Updated
yarn.lock
to address security alerts.
[PR #346]
Bug Fixes
- Multiplicity subsetting. Fixed the KerML grammar for
MultiplicitySubset
.
[PR #350] - Circular conjugation. Fixed stack overflow caused by a circular conjugation declaration.
[PR #351] - Non-ASCII characters. Revised the loading of libraries for Jupyter so that UTF-8 is always used as the character encoding (regardless of the platform default).
[PR #352] - Space modeling. Corrected errors related to space modeling in the Kernel Library
Occurrences
andObjects
models, in the Geometry Domain Library `...