-
Notifications
You must be signed in to change notification settings - Fork 6
UML Code Generation ‐ Convention
The SysML2.NET libraries are generated from the MOF XMI for the SysML v2 Abstract Syntax. We make use of convention and template based code generation to convert the information that is stored in this UML model to various C# classes such as DTO's, POCO's, JSON serializers and much more. The Starion Group uml4net library is used to read the UML model. Handlebars templates are used to generate code using the Handlebars.Net library.
The code-generators are executed from the Unit test project called SysML2.NET.CodeGenerator.Tests. The generated code is verified (compared) against so-called expected classes. These are hand-coded and are used to implement a pattern that needs to be generated. An analysis of the SysML2 UML model has been performed to check that all the variations in data-types, multiplicity, inheritance etc. is covered. A number of classes have been selected for which expected classes need to be in place such that the generated code is properly covered.
he following lists provides an overview of the various kinds of features which classes cover these features, hence which class needs to be included in the expected classes:
MORE INFORMATION COMING SOON
The MOF XMI for the SysML v2 Abstract Syntax UML model contains Classes organized in Packages. The UML model makes use of multiple inheritance of UML classes which is not supported by C#. The following structure is used to implement the MOF XMI for the SysML v2 Abstract Syntax in C#:
- All UML classes are generated as a C# Interface, where each C# Interface contains the defined properties on the UML class as well as the Generalization of the UML class as super interfaces
- Only concrete UML classes are generated as a C# class implementing the corresponding C# Interface. Each property defined on the C# interface, inlcuding the properties on the general C# interfaces, will find their way into the C# class. See below for property mappings for more details.
The following Data Types can be found into the UML model:
- Boolean: translates to C# bool
- UnlimitedNatural: translates to C# string
- String: translates to C# string
- Integer: translates to C# int
- Real: translates to C# double
- Enumeration: translate to correspondant C# enum
Translates to a reference to the Interface definition of the specified type
Translates to a Guid
- [0..1]: Translates to nullable (Except for string, which is nullable by definition)
- [1..]/[n..]: Translates to List{T}
- [0..1]: Not a nullable since a reference type is nullable by definition
- [1..*]/[n..*]: Translates to List{T}
- [0..1]: Translates to
Guid? - [1..*]/[n..*]: Translates to List{Guid}
For all non-derived properties, property name starts with an uppercase.
For all derived properties, property name starts with a lowercase.
When a property has been redefined on the current context, this property has to be discarded by the class since it does not have any meaning due to the redefinition of it. To discard it, we declares it with an explicit interface definition.
- Nominal Case: translates to
{ get; set; } - ReadOnly: translates to
{ get; } - Derived or DerivedUnion: Translates to
=> this.Compute$PROPERTYNAME$();. This method is hand-coded to implement derive-computation logic
- Nominal Case: translates to
{ get; set; } - ReadOnly: translates to
{ get; } - Derived or DerivedUnion: translates to
{ get; }on interface definition,{ get; internal set; }on class implementation
Not implemented for now
To make sure that no exception or incorrect values are thrown in case of interface usage (like a collection of super interface), it is important to be able to not throw exception or irrelevant values. To make it possible, getter and setter have to return/set values of the property that redefines it.
Following section explains implementation principle. Each case are explain in terms of multiplicity, where the first multiplicity is the one of the redefined property and the second one is for the redefinition
- [n..*] -> [n..*] : Returns a newly initialized collection to allow safe cast and to not allow direct modification of the redefinition collection via a redefined property
- [n..*] -> [1..1] : Returns a newly initialized collection that contains only one element, the value of the redefinition
- [n..*] -> [0..1] : Returns a newly initialized collection that contains only zero element if the value of the redefinition is null, one otherwise
- [1..1] -> [1..1]/[0..1] -> [0..1] : Returns the value for the redefinition one
- [1..1] -> [0..1] : Returns the value of the redefinition if not null, the default value otherwise
If the redefinition is a derived property, the setter does not do anything
- [n..*] -> [n..*] : Assigns the collection to the redefinition. For POCO, gets only elements of the correct type
- [n..*] -> [0/1..1] : Assigns the value based on the first value of the collection. For POCO, based on the first value of the collection that matches the target type
- [0/1..1] -> [0/1..1] : Assigns the value if type matches the target one.
- Property name follows the CamelCase format
- @type (string) property required (value is the name of the serialized)
- @id (uuid) property (optional)
- Boolean: translates to json bool
- UnlimitedNatural: translates to json string
- String: translates to json string
- Integer: translates to json numeric
- Real: translates to json numeric
- Enumeration: translate to full lowercase string
A refence is represented through a JSON object which that contains one property @id with the value of the reference Guid
- [0..1]: Always serialized, null in case of null, the value otherwise
- [1..*]/[n..*]: Serialized through a JSON array
The serialization of derived property is possible. Deserialization action can also assign derived properties into DTOs if present inside the JSON payload.
Redefined property are discarded from the serialization.
copyright @ Starion Group S.A.