# aaronmcleancs/tslim-data-simulator architecture

> Architecture diagram of the GitHub repository aaronmcleancs/tslim-data-simulator, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-06-08). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/aaronmcleancs/tslim-data-simulator
- Repository: https://github.com/aaronmcleancs/tslim-data-simulator

## Overview

##### Project type and purpose
- This is a Qt/C++ desktop application that simulates an insulin pump system. Its key features include manual and extended bolus calculations, continuous glucose monitoring (CGM), automated insulin adjustment (Control-IQ), profile management, power management (battery and on/off), security (PIN lock screen), data visualization, and history logging.

##### File structure
- Top level:
- main.cpp, COMP3004A4.pro, README.txt (build entry point)
- Models folder (UML models and documentation)
- “headers” vs “cpp” directories: split between API/interface declarations (.h) and implementations (.cpp)
- UI definitions (.ui) and controllers: mainwindow.ui, lockscreen2.ui, bolus.ui, contentwidget.ui, statusbar.ui, optionswindow.ui, poweroff.ui
- Domain and service classes: Battery, Pump, InsulinCartridge, CGM, BolusCalculator, ControlIQ, Profile, PumpHistory, StatusModel, AuthManager, PowerStateMachine, QCustomPlot
- Separation of concerns:
- UI layer (Qt .ui files + UI controllers)
- Business-logic layer (calculation, state machines, safety checks)
- Domain model (representing pump, cartridge, battery, profiles)
- Persistence/history (PumpHistory, Profile storage)
- Security (AuthManager, PIN lockscreen)

##### README for additional insights
- Confirms use of Qt (qmake + make) and runtime binary
- Lists team contributions aligning to components above

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% UI Layer
    subgraph "UI Layer"
        MW["MainWindow"]:::ui
        SB["StatusBar"]:::ui
        CW["ContentWidget"]:::ui
        BW["BolusWindow"]:::ui
        OW["OptionsWindow"]:::ui
        PW["PowerOffWindow"]:::ui
        LS["LockScreen"]:::ui
    end

    %% Controller
    subgraph "Controller"
        UIC["UIController"]:::controller
    end

    %% Services
    subgraph "Business Logic / Services"
        BC["BolusCalculator"]:::service
        CIQ["Control-IQ"]:::service
        CGM["CGM"]:::service
        PSM["PowerStateMachine"]:::service
        AM["AuthManager"]:::service
    end

    %% Domain Model
    subgraph "Domain Model"
        PUMP["Pump"]:::model
        BAT["Battery"]:::model
        CAR["InsulinCartridge"]:::model
        PROF["Profile"]:::model
        HIST["PumpHistory"]:::model
        SM["StatusModel"]:::model
    end

    %% Data Visualization
    subgraph "Data Visualization"
        QCP["QCustomPlot"]:::viz
    end

    %% Persistence & Logging
    subgraph "Persistence & Logging"
        PROF
        HIST
    end

    %% Connections: UI to Controller
    MW -->|"signalClicked"| UIC
    SB -->|"signalUpdate"| UIC
    CW -->|"signalRequestData"| UIC
    BW -->|"signalBolusRequest"| UIC
    OW -->|"signalOptionChange"| UIC
    PW -->|"signalPowerToggle"| UIC
    LS -->|"signalAuthenticate"| UIC

    %% Controller to Services
    UIC -->|"calculateBolus()"| BC
    UIC -->|"runControlIQ()"| CIQ
    UIC -->|"fetchCGMData()"| CGM
    UIC -->|"triggerPowerEvent()"| PSM
    UIC -->|"authenticateUser()"| AM

    %% Services to Domain Model
    BC -->|"computeDose()"| PUMP
    CIQ -->|"adjustInsulin()"| PUMP
    CGM -->|"updateGlucoseLevel()"| SM
    PSM -->|"changePowerState()"| PUMP
    PSM -->|"monitorBattery()"| BAT
    AM -->|"verifyPIN()"| SM

    %% Domain Model interactions
    PUMP -->|"consumeBattery()"| BAT
    PUMP -->|"dispenseInsulin()"| CAR
    PUMP -->|"logDelivery()"| HIST
    PROF -->|"loadProfile()"| PROF
    PROF -->|"saveProfile()"| PROF

    %% Persistence & Logging storage
    HIST -->|"persistEvent()"| HIST

    %% Model to UI updates
    SM -->|"statusChanged()"| MW
    PROF -->|"profileUpdated()"| CW
    HIST -->|"historyUpdated()"| CW

    %% Data Visualization connections
    QCP -->|"plotProfile()"| CW
    QCP -->|"plotHistory()"| CW

    %% Click Events
    click MW "https://github.com/aaronmcleancs/tslim-data-simulator/blob/main/mainwindow.ui"
    click MW "https://github.com/aaronmcleancs/tslim-data-simulator/blob/main/mainwindow.cpp"
    click MW "https://github.com/aaronmcleancs/tslim-data-simulator/blob/main/mainwindow.h"
    click SB "https://github.com/aaronmcleancs/tslim-data-simulator/blob/main/statusbar.ui"
    click SB "https://github.com/aaronmcleancs/tslim-data-simulator/blob/main/statusbar.cpp"
    click SB "https://github.com/aaronmcleancs/tslim-data-simulator/blob/main/statusbar.h"
    click CW "https://github.com/aaronmcleancs/tslim-data-simulator/blob/main/contentwidget.ui"
    click CW "https://github.com/aaronmcleancs/tslim-data-simulator/blob/main/cpp/contentwidget.cpp"
    click CW "https://github.com/aaronmcleancs/tslim-data-simulator/blob/main/headers/contentwidget.h"
    click BW "https://github.com/aaronmcleancs/tslim-data-simulator/blob/main/bolus.ui"
    click BW "https://github.com/aaronmcleancs/tslim-data-simulator/blob/main/bolus.cpp"
    click BW "https://github.com/aaronmcleancs/tslim-data-simulator/blob/main/bolus.h"
    click OW "https://github.com/aaronmcleancs/tslim-data-simulator/blob/main/optionswindow.ui"
    click OW "https://github.com/aaronmcleancs/tslim-data-simulator/blob/main/cpp/optionswindow.cpp"
    click OW "https://github.com/aaronmcleancs/tslim-data-simulator/blob/main/headers/optionswindow.h"
    click PW "https://github.com/aaronmcleancs/tslim-data-simulator/blob/main/poweroff.ui"
    click PW "https://github.com/aaronmcleancs/tslim-data-simulator/blob/main/poweroff.cpp"
    click PW "https://github.com/aaronmcleancs/tslim-data-simulator/blob/main/poweroff.h"
    click LS "https://github.com/aaronmcleancs/tslim-data-simulator/blob/main/lockscreen2.ui"
    click LS "https://github.com/aaronmcleancs/tslim-data-simulator/blob/main/cpp/lockscreen.cpp"
    click LS "https://github.com/aaronmcleancs/tslim-data-simulator/blob/main/headers/lockscreen.h"
    click UIC "https://github.com/aaronmcleancs/tslim-data-simulator/blob/main/cpp/UI.cpp"
    click UIC "https://github.com/aaronmcleancs/tslim-data-simulator/blob/main/headers/UI.h"
    click BC "https://github.com/aaronmcleancs/tslim-data-simulator/blob/main/cpp/BolusCalculator.cpp"
    click BC "https://github.com/aaronmcleancs/tslim-data-simulator/blob/main/headers/BolusCalculator.h"
    click CIQ "https://github.com/aaronmcleancs/tslim-data-simulator/blob/main/cpp/ControlIQ.cpp"
    click CIQ "https://github.com/aaronmcleancs/tslim-data-simulator/blob/main/headers/ControlIQ.h"
    click CGM "https://github.com/aaronmcleancs/tslim-data-simulator/blob/main/cpp/CGM.cpp"
    click CGM "https://github.com/aaronmcleancs/tslim-data-simulator/blob/main/headers/CGM.h"
    click PSM "https://github.com/aaronmcleancs/tslim-data-simulator/blob/main/cpp/powerstatemachine.cpp"
    click PSM "https://github.com/aaronmcleancs/tslim-data-simulator/blob/main/headers/powerstatemachine.h"
    click AM "https://github.com/aaronmcleancs/tslim-data-simulator/blob/main/cpp/authmanager.cpp"
    click AM "https://github.com/aaronmcleancs/tslim-data-simulator/blob/main/headers/authmanager.h"
    click PUMP "https://github.com/aaronmcleancs/tslim-data-simulator/blob/main/cpp/Pump.cpp"
    click PUMP "https://github.com/aaronmcleancs/tslim-data-simulator/blob/main/headers/Pump.h"
    click BAT "https://github.com/aaronmcleancs/tslim-data-simulator/blob/main/cpp/Battery.cpp"
    click BAT "https://github.com/aaronmcleancs/tslim-data-simulator/blob/main/headers/Battery.h"
    click CAR "https://github.com/aaronmcleancs/tslim-data-simulator/blob/main/cpp/InsulinCartridge.cpp"
    click CAR "https://github.com/aaronmcleancs/tslim-data-simulator/blob/main/headers/InsulinCartridge.h"
    click PROF "https://github.com/aaronmcleancs/tslim-data-simulator/blob/main/cpp/Profile.cpp"
    click PROF "https://github.com/aaronmcleancs/tslim-data-simulator/blob/main/headers/Profile.h"
    click HIST "https://github.com/aaronmcleancs/tslim-data-simulator/blob/main/cpp/PumpHistory.cpp"
    click HIST "https://github.com/aaronmcleancs/tslim-data-simulator/blob/main/headers/PumpHistory.h"
    click SM "https://github.com/aaronmcleancs/tslim-data-simulator/blob/main/cpp/statusmodel.cpp"
    click SM "https://github.com/aaronmcleancs/tslim-data-simulator/blob/main/headers/statusmodel.h"
    click QCP "https://github.com/aaronmcleancs/tslim-data-simulator/blob/main/cpp/QCustomPlot.cpp"
    click QCP "https://github.com/aaronmcleancs/tslim-data-simulator/blob/main/headers/QCustomPlot.h"

    %% Styles
    classDef ui fill:#cce5ff,stroke:#333,stroke-width:1px;
    classDef controller fill:#d4edda,stroke:#333,stroke-width:1px;
    classDef service fill:#fff3cd,stroke:#333,stroke-width:1px;
    classDef model fill:#ffeeba,stroke:#333,stroke-width:1px;
    classDef viz fill:#e2e3e5,stroke:#333,stroke-width:1px;
    classDef persistence fill:#d6d8db,stroke:#333,stroke-width:1px;
    class PROF,HIST persistence
```
