Detailed Design#

HealthMonitor Detailed Design
status: draft
security: NO
safety: ASIL_B
tags: template, health_monitor
realizes: wp__sw_implementation
doc__health_monitor_detailed_design
Generic Document

Attention

The above directive must be updated according to your Component.

  • Modify Your Component Name to be your Component Name

  • Modify id to be your Component Name in upper snake case preceded by doc__ and followed by _detailed_design

  • Adjust status to be valid

  • Adjust safety and tags according to your needs

Detailed Design for Component: HealthMonitor#

Description#

HealthMonitor component consists of these units:

  • deadline_monitor

  • logic_monitor

  • health_monitor

Design Decisions - For the documentation of the decision the gd_temp__change_decision_record can be used.
Design Constraints

Implementation structure#

src
└── health_monitoring_lib
    ├── cpp             # C++ API using Rust FFI
    │   ├── include     # C++ public header files.
    │   │   └── ...
    │   └── tests
    └── rust            # Rust implementation + FFI for C++
        └── deadline

Implementation approach for multi language#

The implementation is done primarily in Rust language to leverage its memory safety features and concurrency model. Due to a need to interface with existing C++ codebases, a C-compatible Foreign Function Interface (FFI) is provided by this Rust implementation. C++ API is designed to be idiomatic wrapping around the Rust FFI, ensuring ease of use for C++ developers while maintaining the safe usage.

Rationale Behind Decomposition into Units#

mandatory: a motivation for the decomposition into one or more units.

Note

Reason for split into multiple units could be- - Based on design principles like SOLID,DRY etc - Based on design pattern’s etc.

Static Diagrams for Unit Interactions#

Class Diagram
status: valid
security: NO
safety: ASIL_B
tags: health_monitor
satisfies: comp_arc_sta__deadline_monitor__static_view, comp_arc_sta__logic_monitor__static_view, comp_arc_sta__health_monitor__static_view
implements: comp_req__health_monitor__dummy

dd_sta__health_monitor__class_diagram
Static detailed design

Dynamic Diagrams for Unit Interactions#

.. dd_dyn:: <Title>
   :id: dd_dyn__<Feature>__<Title>
   :security: <YES|NO>
   :safety: <QM|ASIL_B>
   :status: <valid|invalid>
   :implements: <link to component requirement id>
   :satisfies: <link to component architecture id>

     .. image:: <link to drawio image> or .. uml::  assets/<link to plantuml>