Supported PUML diagrams

There are currently four diagram types the AaC PUML Plugin supports: component, object, requirements, and sequence.

For a basic overview of PUML diagraming, view their documentation.

AaC’s PUML Plugin is built around the structures and design provided by PUML by relating the pertinent model fields to the diagram elements. AaC ingests and parses a full model structure, then extracts the necessary fields, and finally maps them to the related diagram elements to output an acceptable formatted PUML file that can be rendered as the PUML diagram.

flowchart TD
    A[Ingest AaC File] --> B{Model with necessary fields?};
    B -- Yes --> C[Map to diagram elements];
    B -- No --> D[Return model type error notice];
    C --> E[Output PUML text file];

Component Diagrams

For direct information on PUML component diagrams, view the component diagram documentation.

A component diagram helps to represent the organization and relationship of system components so that complex systems are able to be better understood and evaluated for interdependencies and efficient design.

For viewing example usage and results of the component diagram generation, view Component Examples.

Object Diagrams

For direct information on PUML object diagrams, view the object diagram documentation.

An object diagram shows objects and their relationships in a snapshot of the system’s structure.

For viewing example usage and results of the object diagram generation, view Object Examples.

Sequence Diagrams

For direct information on PUML sequence diagrams, view the sequence diagram documentation.

A sequence diagram helps to represent the flow of actions and/or data between system components or users and system components so that complex systems are able to be better understood and evaluated for accurate behavior paths through the designed system.

For viewing example usage and results of the component diagram generation, view Component Examples.

Requirements Diagrams

For direct information on SysML requirement diagrams, view the requirement diagram documentation.

A requirements diagram helps to provide a way of tracing a capability the system shall satisfy by relating the requirement to model elements to use cases to show the complete relationship from requirement to verification within the system.

For viewing example usage and results of the requirements diagram generation, view Requirements Examples.