eclipse-esmf / esmf-semantic-aspect-meta-model

Formal and textual specification of the Semantic Aspect Meta Model (SAMM)
https://eclipse-esmf.github.io/samm-specification/snapshot/index.html
Mozilla Public License 2.0
47 stars 9 forks source link

[Task] Add Required Information to predefined entities #114

Open BirgitBoss opened 2 years ago

BirgitBoss commented 2 years ago

Is your task related to a problem? Please describe. When reading the specification of the predefined entities the following question came up

It is also very difficult to derive the name and the prefix of the entity because it is implicitly given (if the chapter name is "Ab Cd" the name is AbCd). The prefix bamm-e is implicitly defined because it is in the chapter "Entities". For readers who do not have all this background information it is very hard.

Describe the solution you'd like 1) Add "Required" column like for the specification for characteristics. 2) Add name and prefix of the predefined characteristic. E.g. Instead of "describes a point in [ℝ³]" write "The predefined entity bamm-e:Point3D describes a point in [ℝ³]".

Describe alternatives you've considered

Additional context

BirgitBoss commented 2 years ago

https://github.com/OpenManufacturingPlatform/sds-bamm-aspect-meta-model/issues/116 deals with the urn of elements in BAMM, so Point 2. of this issue probably solved in issue #116