Skip to content
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

feat: Diagram auto layout accessor #171

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open

feat: Diagram auto layout accessor #171

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
c106357
test: Raise Capella version to 7.0
ewuerger Dec 9, 2024
d3224b5
test: Remove unnecessary module
ewuerger Dec 9, 2024
0b3f281
feat: Add Capella diagram layouter
ewuerger Dec 9, 2024
3e9920e
fix: Handle functions and ports correctly
ewuerger Dec 9, 2024
c5f2b1b
test: Add test case for diagram auto layout
ewuerger Dec 9, 2024
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
106 changes: 60 additions & 46 deletions capellambse_context_diagrams/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,15 +19,13 @@

from __future__ import annotations

import collections.abc as cabc
import logging
import typing as t
from importlib import metadata

import capellambse.model as m
from capellambse.diagram import COLORS, CSSdef, capstyle
from capellambse.metamodel import cs, fa, information, la, oa, pa, sa
from capellambse.model import DiagramType

from . import _elkjs, context, styling

Expand All @@ -39,7 +37,7 @@

DefaultRenderParams = dict[str, t.Any]
SupportedContextClass = tuple[
type[m.ModelElement], DiagramType, DefaultRenderParams
type[m.ModelElement], m.DiagramType, DefaultRenderParams
]
SupportedInterfaceContextClass = tuple[
type[m.ModelElement], dict[type[m.ModelElement], str], DefaultRenderParams
Expand Down Expand Up @@ -69,28 +67,29 @@ def init() -> None:
register_realization_view()
register_data_flow_view()
register_cable_tree_view()
register_diagram_layout_accessor()
# register_functional_context() XXX: Future


def register_classes() -> None:
"""Add the `context_diagram` property to the relevant model objects."""
supported_classes: list[SupportedContextClass] = [
(oa.Entity, DiagramType.OAB, {}),
(oa.Entity, m.DiagramType.OAB, {}),
(
oa.OperationalActivity,
DiagramType.OAB,
m.DiagramType.OAB,
{"display_parent_relation": True},
),
(oa.OperationalCapability, DiagramType.OCB, {}),
(sa.Mission, DiagramType.MCB, {}),
(oa.OperationalCapability, m.DiagramType.OCB, {}),
(sa.Mission, m.DiagramType.MCB, {}),
(
sa.Capability,
DiagramType.MCB,
m.DiagramType.MCB,
{"display_symbols_as_boxes": False},
),
(
sa.SystemComponent,
DiagramType.SAB,
m.DiagramType.SAB,
{
"display_symbols_as_boxes": True,
"display_parent_relation": True,
Expand All @@ -100,7 +99,7 @@ def register_classes() -> None:
),
(
sa.SystemFunction,
DiagramType.SAB,
m.DiagramType.SAB,
{
"display_symbols_as_boxes": True,
"display_parent_relation": True,
Expand All @@ -109,7 +108,7 @@ def register_classes() -> None:
),
(
la.LogicalComponent,
DiagramType.LAB,
m.DiagramType.LAB,
{
"display_symbols_as_boxes": True,
"display_parent_relation": True,
Expand All @@ -119,7 +118,7 @@ def register_classes() -> None:
),
(
la.LogicalFunction,
DiagramType.LAB,
m.DiagramType.LAB,
{
"display_symbols_as_boxes": True,
"display_parent_relation": True,
Expand All @@ -128,14 +127,14 @@ def register_classes() -> None:
),
(
pa.PhysicalComponent,
DiagramType.PAB,
m.DiagramType.PAB,
{
"display_parent_relation": True,
"display_port_labels": True,
"display_derived_interfaces": True,
},
),
(pa.PhysicalFunction, DiagramType.PAB, {}),
(pa.PhysicalFunction, m.DiagramType.PAB, {}),
]
cap: dict[str, CSSdef] = {
"fill": [COLORS["_CAP_Entity_Gray_min"], COLORS["_CAP_Entity_Gray"]],
Expand Down Expand Up @@ -166,32 +165,32 @@ def register_interface_context() -> None:
(
oa.CommunicationMean,
{
oa.EntityPkg: DiagramType.OAB.value,
oa.Entity: DiagramType.OAB.value,
oa.EntityPkg: m.DiagramType.OAB.value,
oa.Entity: m.DiagramType.OAB.value,
},
{"include_interface": True},
),
(
fa.ComponentExchange,
{
sa.SystemComponentPkg: DiagramType.SAB.value,
sa.SystemComponent: DiagramType.SAB.value,
la.LogicalComponentPkg: DiagramType.LAB.value,
la.LogicalComponent: DiagramType.LAB.value,
pa.PhysicalComponentPkg: DiagramType.PAB.value,
pa.PhysicalComponent: DiagramType.PAB.value,
sa.SystemComponentPkg: m.DiagramType.SAB.value,
sa.SystemComponent: m.DiagramType.SAB.value,
la.LogicalComponentPkg: m.DiagramType.LAB.value,
la.LogicalComponent: m.DiagramType.LAB.value,
pa.PhysicalComponentPkg: m.DiagramType.PAB.value,
pa.PhysicalComponent: m.DiagramType.PAB.value,
},
{"include_interface": True, "include_port_allocations": True},
),
(
cs.PhysicalLink,
{
sa.SystemComponentPkg: DiagramType.SAB.value,
sa.SystemComponent: DiagramType.SAB.value,
la.LogicalComponentPkg: DiagramType.LAB.value,
la.LogicalComponent: DiagramType.LAB.value,
pa.PhysicalComponentPkg: DiagramType.PAB.value,
pa.PhysicalComponent: DiagramType.PAB.value,
sa.SystemComponentPkg: m.DiagramType.SAB.value,
sa.SystemComponent: m.DiagramType.SAB.value,
la.LogicalComponentPkg: m.DiagramType.LAB.value,
la.LogicalComponent: m.DiagramType.LAB.value,
pa.PhysicalComponentPkg: m.DiagramType.PAB.value,
pa.PhysicalComponent: m.DiagramType.PAB.value,
},
{"include_interface": True, "display_port_labels": True},
),
Expand All @@ -215,7 +214,7 @@ def register_interface_context() -> None:
"stroke-dasharray": "2",
"text_fill": COLORS["black"],
}
for dt in (DiagramType.SAB, DiagramType.LAB, DiagramType.PAB):
for dt in (m.DiagramType.SAB, m.DiagramType.LAB, m.DiagramType.PAB):
capstyle.STYLES[dt.value][
"Edge.PortInputAllocation"
] = port_alloc_input_style
Expand All @@ -232,11 +231,11 @@ def register_functional_context() -> None:
The functional context diagrams will be available soon.
"""
attr_name = f"functional_{ATTR_NAME}"
supported_classes: list[tuple[type[m.ModelElement], DiagramType]] = [
(oa.Entity, DiagramType.OAB),
(sa.SystemComponent, DiagramType.SAB),
(la.LogicalComponent, DiagramType.LAB),
(pa.PhysicalComponent, DiagramType.PAB),
supported_classes: list[tuple[type[m.ModelElement], m.DiagramType]] = [
(oa.Entity, m.DiagramType.OAB),
(sa.SystemComponent, m.DiagramType.SAB),
(la.LogicalComponent, m.DiagramType.LAB),
(pa.PhysicalComponent, m.DiagramType.PAB),
]
class_: type[m.ModelElement]
for class_, dgcls in supported_classes:
Expand All @@ -252,7 +251,7 @@ def register_tree_view() -> None:
m.set_accessor(
information.Class,
"tree_view",
context.ClassTreeAccessor(DiagramType.CDB.value),
context.ClassTreeAccessor(m.DiagramType.CDB.value),
)


Expand All @@ -263,14 +262,14 @@ def register_realization_view() -> None:
of all layers.
"""
supported_classes: list[SupportedContextClass] = [
(oa.Entity, DiagramType.OAB, {}),
(oa.OperationalActivity, DiagramType.OAIB, {}),
(sa.SystemComponent, DiagramType.SAB, {}),
(sa.SystemFunction, DiagramType.SDFB, {}),
(la.LogicalComponent, DiagramType.LAB, {}),
(la.LogicalFunction, DiagramType.LDFB, {}),
(pa.PhysicalComponent, DiagramType.PAB, {}),
(pa.PhysicalFunction, DiagramType.PDFB, {}),
(oa.Entity, m.DiagramType.OAB, {}),
(oa.OperationalActivity, m.DiagramType.OAIB, {}),
(sa.SystemComponent, m.DiagramType.SAB, {}),
(sa.SystemFunction, m.DiagramType.SDFB, {}),
(la.LogicalComponent, m.DiagramType.LAB, {}),
(la.LogicalFunction, m.DiagramType.LDFB, {}),
(pa.PhysicalComponent, m.DiagramType.PAB, {}),
(pa.PhysicalFunction, m.DiagramType.PDFB, {}),
]
styles: dict[str, dict[str, capstyle.CSSdef]] = {}
for class_, dgcls, _ in supported_classes:
Expand All @@ -294,8 +293,8 @@ def register_realization_view() -> None:

def register_data_flow_view() -> None:
supported_classes: list[SupportedContextClass] = [
(oa.OperationalCapability, DiagramType.OAIB, {}), # portless
(sa.Capability, DiagramType.SDFB, {}), # default
(oa.OperationalCapability, m.DiagramType.OAIB, {}), # portless
(sa.Capability, m.DiagramType.SDFB, {}), # default
]
class_: type[m.ModelElement]
for class_, dgcls, default_render_params in supported_classes:
Expand All @@ -309,7 +308,22 @@ def register_cable_tree_view() -> None:
cs.PhysicalLink,
"cable_tree",
context.CableTreeAccessor(
DiagramType.PAB.value,
m.DiagramType.PAB.value,
{},
),
)


def register_diagram_layout_accessor() -> None:
"""Add the `auto_layout` attribute to `Diagram`s."""
render_params = {
m.DiagramType.SAB: {"display_symbols_as_boxes": True},
m.DiagramType.LAB: {"display_symbols_as_boxes": True},
m.DiagramType.PAB: {"display_port_labels": True},
}

m.set_accessor(
m.Diagram,
"auto_layout",
context.DiagramLayoutAccessor(render_params),
)
Loading
Loading