Skip to content

Commit ce55d8e

Browse files
committed
mw/com: migrate_umlet_to_plantuml__shared_mem_layout
Closes eclipse-score#49 Issue: SWP-208704 GIT_ORIGIN_SPP_REV_ID: d7836e315f6c4a87c04c75613c0a0cbfc73983a8
1 parent 0647a0c commit ce55d8e

File tree

6 files changed

+233
-918
lines changed

6 files changed

+233
-918
lines changed

score/mw/com/design/shared_mem_layout/README.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ within shared-memory by `Lola`. Other parts of the design documentation e.g.
77
[event and field description part](../events_fields/README.md#introduction) already describe/hint in their class
88
diagrams via the stereotype `<<SharedMemory>>` in the following form:
99

10-
![Stereotype](artifacts/stereotype.svg)
10+
![Stereotype](stereotype.svg)
1111

1212
whether some classes (instances of it) are partially placed within shared-memory. We use the same stereotype here, but
1313
give a complete overview.
@@ -36,13 +36,13 @@ The following class diagram provides an overview of the classes, whose instances
3636
also a rough indication how the provider side (in the form of `LoLa` skeleton) and the consumer side (in the form of
3737
`LoLa` proxy/proxy-event) interact with them.
3838

39-
![Class View](broken_link_k/swh/ddad_score/mw/com/design/shared_mem_layout/artifacts/shared_mem_layout_classdiagram.uxf?ref=18c835c8d7b01056dd48f257c14f435795a48b7d)
39+
![SHARED_MEM_LAYOUT_CLASSDIAGRAM](broken_link_k/swh/safe-posix-platform/score/mw/com/design/shared_mem_layout/shared_mem_layout_classdiagram.puml")
4040

4141
This object diagram below (showing a concrete instantiation of the class diagram above for some example service instance)
4242
depicts more clearly the relation between the `SharedMemoryResource` instances representing a shared-memory object and the
4343
anchor/root elements placed within shared-memory:
4444

45-
![Object View](broken_link_k/swh/ddad_score/mw/com/design/shared_mem_layout/artifacts/shared_mem_layout_objectdiagram.uxf?ref=18c835c8d7b01056dd48f257c14f435795a48b7d)
45+
![SHARED_MEM_LAYOUT_OBJECTDIAGRAM](broken_link_k/swh/safe-posix-platform/score/mw/com/design/shared_mem_layout/shared_mem_layout_objectdiagram.puml")
4646

4747
So - the first object/element created within the shared-memory object for **Data** (represented by `SharedMemoryResource`
4848
instance `shmResource_storage_SI_1`) is the instance `serviceDataStorage_SI_1` of class `ServiceDataStorage` and
@@ -70,8 +70,8 @@ This anchor element of the `SharedMemoryResource` contains two members:
7070
```
7171
are stored here as "type-erased" `score::memory::shared::OffsetPtr<void>`, because every slot-vector has a different
7272
type and only later when the skeleton events register themselves dynamically or access that storage they are cast to
73-
the effective/concrete type.
74-
73+
the effective/concrete type.
74+
7575
* `events_metainfo_`: a map for meta information of every event the service provides
7676
* `skeleton_pid_`: PID of the provider/skeleton process.
7777

@@ -83,4 +83,3 @@ created by a `LoLa` skeleton instance during `lola::Skeleton::PrepareOffer()` wi
8383
callback of the newly created shared-memory object.
8484
This anchor element of the `SharedMemoryResource` contains the member:
8585
* `event_data_control_`: a map containing the control slots of every event the service provides.
86-

0 commit comments

Comments
 (0)