Skip to content

Commit

Permalink
Adjust colors in meta model elements and characteristics diagrams
Browse files Browse the repository at this point in the history
  • Loading branch information
atextor committed Mar 19, 2024
1 parent 94c448a commit 41fe85f
Show file tree
Hide file tree
Showing 7 changed files with 192 additions and 302 deletions.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,12 +75,14 @@ Diagrams are kept in the [diagrams](documentation/modules/ROOT/diagrams) folder
them into .svg, run

```sh
./mvnw clean install -pl esmf-samm-build-plugin
./mvnw generate-sources -pl documentation -Prender-diagrams
```

In order to render the diagrams and the Antora documentation in one step, run

```sh
./mvnw clean install -pl esmf-samm-build-plugin
./mvnw generate-resources -pl documentation -Prender-diagrams,antora
```

Expand Down
73 changes: 60 additions & 13 deletions documentation/modules/ROOT/diagrams/aspect-meta-model.dot
Original file line number Diff line number Diff line change
Expand Up @@ -33,19 +33,66 @@ digraph aspect_model {
outputorder="edgesfirst"
]

Aspect [label="{ «Aspect»|name : string\lpreferredName : langString [0..n]\ldescription : langString [0..n]\lsee : anyURI [0..n]\l}", pos="0,0.38!"]
Property [label="{ «Property»|name : string\lpreferredName : langString [0..n]\ldescription : langString [0..n]\lexampleValue : \<type\> [0..1]\lsee : anyURI [0..n]\l}", pos="0,-1.30!"]
Entity [label="{ «Entity»|name : string\lpreferredName : langString [0..n]\ldescription : langString [0..n]\lsee : anyURI [0..n]\l}", pos="0,-2.9!"]
AbstractEntity [label="{ «AbstractEntity»|name : string\lpreferredName : langString [0..n]\ldescription : langString [0..n]\lsee : anyURI [0..n]\l}", pos="0,-4.5!"]
Operation [label="{ «Operation»|name : string\lpreferredName : langString [0..n]\ldescription : langString [0..n]\lsee : anyURI [0..n]\l}", pos="0,-6.0!"]
Event [label="{ «Event»|name : string\lpreferredName : langString [0..n]\ldescription : langString [0..n]\lsee : anyURI [0..n]\l}", pos="0,-7.5!"]

Trait [label="{ «Trait»}", pos="5.0,-0.07!"]
Constraint [label="{ «Constraint»}", pos="5.0,0.7!"]
Characteristic [label="{ «Characteristic»|name : string\lpreferredName : langString [0..n]\ldescription : langString [0..n]\lsee : anyURI [0..n]\ldataType : \<type\>\l}", pos="5.0,-1.6!"]
Quantifiable [label="{ «Quantifiable»}", pos="5.0,-2.8!"]
Unit [label="{ «Unit»|name : string\lpreferredName : langString [0..n]\ldescription : langString [0..n]\lsee : anyURI [0..n]\lsymbol : string\lconversionFactor : string [0..1]\lnumericConversionFactor : double [0..1]\lcommonCode : string [0..1]\l}", pos="5.0,-4.2!"]
QuantityKind [label="{ «QuantityKind»|name : string\lpreferredName : langString [0..n]\ldescription : langString [0..n]\lsee : anyURI [0..n]\l}", pos="5.0,-6.3!"]
Aspect [
label="{ «Aspect»|name : string\lpreferredName : langString [0..n]\ldescription : langString [0..n]\lsee : anyURI [0..n]\l}",
pos="0,0.38!",
fillcolor="#7589c8"
]
Property [
label="{ «Property»|name : string\lpreferredName : langString [0..n]\ldescription : langString [0..n]\lexampleValue : \<type\> [0..1]\lsee : anyURI [0..n]\l}",
pos="0,-1.30!",
fillcolor="#c5c8d4"
]
Entity [
label="{ «Entity»|name : string\lpreferredName : langString [0..n]\ldescription : langString [0..n]\lsee : anyURI [0..n]\l}",
pos="0,-2.9!",
fillcolor="#aeade0"
]
AbstractEntity [
label="{ «AbstractEntity»|name : string\lpreferredName : langString [0..n]\ldescription : langString [0..n]\lsee : anyURI [0..n]\l}",
pos="0,-4.5!",
fillcolor="#aeade0"
]
Operation [
label="{ «Operation»|name : string\lpreferredName : langString [0..n]\ldescription : langString [0..n]\lsee : anyURI [0..n]\l}",
pos="0,-6.0!",
fillcolor="#d5bfda"
]
Event [
label="{ «Event»|name : string\lpreferredName : langString [0..n]\ldescription : langString [0..n]\lsee : anyURI [0..n]\l}",
pos="0,-7.5!",
fillcolor="#b9d8fa"
]
Trait [
label="{ «Trait»}",
pos="5.0,-0.07!",
fillcolor="#74aeaf"
]
Constraint [
label="{ «Constraint»}",
pos="5.0,0.7!",
fillcolor="#74aeaf"
]
Characteristic [
label="{ «Characteristic»|name : string\lpreferredName : langString [0..n]\ldescription : langString [0..n]\lsee : anyURI [0..n]\ldataType : \<type\>\l}",
pos="5.0,-1.6!",
fillcolor="#d6e2a6"
]
Quantifiable [
label="{ «Quantifiable»}",
pos="5.0,-2.8!",
fillcolor="#d6e2a6"
]
Unit [
label="{ «Unit»|name : string\lpreferredName : langString [0..n]\ldescription : langString [0..n]\lsee : anyURI [0..n]\lsymbol : string\lconversionFactor : string [0..1]\lnumericConversionFactor : double [0..1]\lcommonCode : string [0..1]\l}",
pos="5.0,-4.2!",
fillcolor="#b9ab50"
]
QuantityKind [
label="{ «QuantityKind»|name : string\lpreferredName : langString [0..n]\ldescription : langString [0..n]\lsee : anyURI [0..n]\l}",
pos="5.0,-6.3!",
fillcolor="#b9ab50"
]

// Quantifiable --|> Characteristic
Quantifiable -> Characteristic [arrowhead="empty"]
Expand Down
96 changes: 80 additions & 16 deletions documentation/modules/ROOT/diagrams/characteristics-classes.dot
Original file line number Diff line number Diff line change
Expand Up @@ -38,28 +38,92 @@ digraph characteristics_classes {
]

// Wide nodes
Characteristic [label="{ Characteristic|name\lpreferredName\ldescription\ldataType\l}", href="../characteristics.html#characteristic-characteristic"]
StructuredValue [label="{ StructuredValue|deconstructionRule\lelements\l}", href="../characteristics.html#structured-value-characteristic"]
Characteristic [
label="{ Characteristic|name\lpreferredName\ldescription\ldataType\l}",
href="../characteristics.html#characteristic-characteristic",
fillcolor="#d6e2a6"
]
StructuredValue [
label="{ StructuredValue|deconstructionRule\lelements\l}",
href="../characteristics.html#structured-value-characteristic",
fillcolor="#d6e2a6"
]

// Narrow nodes
node [
width = 1.2
]

Quantifiable [label="{ Quantifiable|unit\l}", href="../characteristics.html#quantifiable-characteristic"]
Either [label="{ Either|left\lright\l}", href="../characteristics.html#either-characteristic"]
Enumeration [label="{ Enumeration|values\l}", href="../characteristics.html#enumeration-characteristic"]
Collection [label="{ Collection|}", href="../characteristics.html#collection-characteristic"]
Trait [label="{ Trait|baseCharacteristic\lconstraint [1..*]\l}", href="../characteristics.html#trait-characteristic"]
State [label="{ State|defaultValue\l}", href="../characteristics.html#state-characteristic"]
Set [label="{ Set|}", href="../characteristics.html#set-characteristic"]
List [label="{ List|}", href="../characteristics.html#list-characteristic"]
TimeSeries [label="{ TimeSeries|}", href="../characteristics.html#time-series-characteristic"]
Duration [label="{ Duration|}", href="../characteristics.html#duration-characteristic"]
Measurement [label="{ Measurement|}", href="../characteristics.html#measurement-characteristic"]
Code [label="{ Code|}", href="../characteristics.html#code-characteristic"]
SingleEntity [label="{ SingleEntity|}", href="../characteristics.html#single-entity-characteristic"]
SortedSet [label="{ SortedSet|}", href="../characteristics.html#sorted-set-characteristic"]
Quantifiable [
label="{ Quantifiable|unit\l}",
href="../characteristics.html#quantifiable-characteristic",
fillcolor="#d6e2a6"
]
Either [
label="{ Either|left\lright\l}",
href="../characteristics.html#either-characteristic",
fillcolor="#d6e2a6"
]
Enumeration [
label="{ Enumeration|values\l}",
href="../characteristics.html#enumeration-characteristic",
fillcolor="#d6e2a6"
]
Collection [
label="{ Collection|}",
href="../characteristics.html#collection-characteristic",
fillcolor="#d6e2a6"
]
Trait [
label="{ Trait|baseCharacteristic\lconstraint [1..*]\l}",
href="../characteristics.html#trait-characteristic",
fillcolor="#74aeaf"
]
State [
label="{ State|defaultValue\l}",
href="../characteristics.html#state-characteristic",
fillcolor="#d6e2a6"
]
Set [
label="{ Set|}",
href="../characteristics.html#set-characteristic",
fillcolor="#d6e2a6"
]
List [
label="{ List|}",
href="../characteristics.html#list-characteristic",
fillcolor="#d6e2a6"
]
TimeSeries [
label="{ TimeSeries|}",
href="../characteristics.html#time-series-characteristic",
fillcolor="#d6e2a6"
]
Duration [
label="{ Duration|}",
href="../characteristics.html#duration-characteristic",
fillcolor="#d6e2a6"
]
Measurement [
label="{ Measurement|}",
href="../characteristics.html#measurement-characteristic",
fillcolor="#d6e2a6"
]
Code [
label="{ Code|}",
href="../characteristics.html#code-characteristic",
fillcolor="#d6e2a6"
]
SingleEntity [
label="{ SingleEntity|}",
href="../characteristics.html#single-entity-characteristic",
fillcolor="#d6e2a6"
]
SortedSet [
label="{ SortedSet|}",
href="../characteristics.html#sorted-set-characteristic",
fillcolor="#d6e2a6"
]

Either -> Characteristic
Enumeration -> Characteristic
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,13 +37,18 @@ digraph characteristics_instances {
arrowhead = empty
]

Characteristic [label="{ Characteristic|name\lpreferredName\ldescription\ldataType\l}", href="../characteristics.html#characteristic-characteristic"]
Characteristic [
label="{ Characteristic|name\lpreferredName\ldescription\ldataType\l}",
href="../characteristics.html#characteristic-characteristic",
fillcolor="#d6e2a6"
]

node [
shape = plaintext
width = 0
height = 0
margin = 0
fillcolor="#d6e2a6"
]

edge [
Expand Down
100 changes: 14 additions & 86 deletions documentation/modules/ROOT/images/aspect-meta-model.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
132 changes: 18 additions & 114 deletions documentation/modules/ROOT/images/characteristics-classes.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
84 changes: 12 additions & 72 deletions documentation/modules/ROOT/images/characteristics-instances.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 41fe85f

Please sign in to comment.