Skip to content

mw/com: migrate_umlet_to_plantuml__shared_mem_layout #49

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
kalu-an wants to merge 1 commit into from
Closed

mw/com: migrate_umlet_to_plantuml__shared_mem_layout #49

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions score/mw/com/design/shared_mem_layout/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ within shared-memory by `Lola`. Other parts of the design documentation e.g.
[event and field description part](../events_fields/README.md#introduction) already describe/hint in their class
diagrams via the stereotype `<<SharedMemory>>` in the following form:

![Stereotype](artifacts/stereotype.svg)
![Stereotype](stereotype.svg)

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

![Class View](broken_link_k/swh/ddad_score/mw/com/design/shared_mem_layout/artifacts/shared_mem_layout_classdiagram.uxf?ref=18c835c8d7b01056dd48f257c14f435795a48b7d)
<img src="https://www.plantuml.com/plantuml/proxy?src=https://raw.githubusercontent.com/eclipse-score/communication/refs/heads/main/score/mw/com/design/shared_mem_layout/shared_mem_layout_classdiagram.puml" />

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

![Object View](broken_link_k/swh/ddad_score/mw/com/design/shared_mem_layout/artifacts/shared_mem_layout_objectdiagram.uxf?ref=18c835c8d7b01056dd48f257c14f435795a48b7d)
<img src="https://www.plantuml.com/plantuml/proxy?src=https://raw.githubusercontent.com/eclipse-score/communication/refs/heads/main/score/mw/com/design/shared_mem_layout/shared_mem_layout_objectdiagram.puml" />

So - the first object/element created within the shared-memory object for **Data** (represented by `SharedMemoryResource`
instance `shmResource_storage_SI_1`) is the instance `serviceDataStorage_SI_1` of class `ServiceDataStorage` and
Expand Down
Loading