# kessity/test architecture

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

- Interactive diagram: https://gitdiagram.com/kessity/test
- Repository: https://github.com/kessity/test

## Overview

##### Project Type and Purpose
- A monolithic, desktop‐based engineering/test application built with NI LabWindows/CVI.
- Key roles: user interface, hardware/instrument control, lightweight database storage, and a custom build pipeline.

##### File Structure Analysis
- Top‐level artifacts:
- UI resource files: MAIN.uir, splash.uir
- Application logic: MAIN.c, mainTdm.c, special0.c, common.c, splash.c
- Headers: MAIN.h, common.h, splash.h, cvi_db.h
- Instrument config: special0.icd … special5.icd, common.icd
- Database files: cvi_db.fp
- Project file: main.prj
- Build folder: cvibuild.main/Release (scripts, Jamfile, .obj, .res, manifest.xml)
- Patterns:
- Layered separation: UI, business logic, data access, instrument control
- Custom build automation with batch files and Jamfile

##### Key Architectural Components
a. UI Layer
– Panels defined in .uir files
– Callback implementations in MAIN.c and splash.c
b. Business Logic Layer
– mainTdm.c: orchestration of test modules
– specialX.c + .icd files: instrument‐specific routines
– common.c: shared utilities
c. Data Access Layer
– cvi_db.fp + cvi_db.h: file‐based DB read/write
d. Instrument Control Subsystem
– .icd definitions loaded by CVI runtime
– Initialization, data acquisition, cleanup in special*.c
e. Build & Deployment
– cvibuild.main scripts (.bat, Jamfile)
– Compiler/linker options, resource compilation
– Outputs: executable, .res, manifest

##### Component Relationships
- UI → Business Logic: user actions invoke logic functions
- Logic → Data Access: configuration/results persistence
- Logic → Instrument Control: hardware I/O calls
- All source & resources → Build System → final EXE + artifacts

##### Architectural Patterns & Principles
- Layered architecture for separation of concerns
- Modularity: distinct modules for UI, logic, data, hardware control
- Lightweight persistence via flat‐file DB

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% UI Layer
    subgraph "UI Layer"
        direction TB
        MAIN_UIR["MAIN.uir"]:::ui
        splash_UIR["splash.uir"]:::ui
        MAIN_C["MAIN.c"]:::ui
        splash_C["splash.c"]:::ui
        MAIN_H["MAIN.h"]:::ui
        splash_H["splash.h"]:::ui
    end

    %% Business Logic Layer
    subgraph "Business Logic Layer"
        direction TB
        mainTdm_C["mainTdm.c"]:::logic
        common_C["common.c"]:::logic
        special0_C["special0.c"]:::logic
    end

    %% Data Access Layer
    subgraph "Data Access Layer"
        direction TB
        cvi_db_FP["cvi_db.fp"]:::data
        cvi_db_H["cvi_db.h"]:::data
    end

    %% Instrument Control Subsystem
    subgraph "Instrument Control Subsystem"
        direction TB
        common_ICD["common.icd"]:::instr
        special0_ICD["special0.icd"]:::instr
        special1_ICD["special1.icd"]:::instr
        special2_ICD["special2.icd"]:::instr
        special3_ICD["special3.icd"]:::instr
        special4_ICD["special4.icd"]:::instr
        special5_ICD["special5.icd"]:::instr
    end

    %% Build & Deployment
    subgraph "Build & Deployment"
        direction TB
        cvibuild_dir["cvibuild.main/"]:::build
        bs1["Release/BuildStep.bat"]:::build
        bs2["Release/CallCC.bat"]:::build
        bs3["Release/CallLink.bat"]:::build
        bs4["Release/CallRC.bat"]:::build
        jam1["Release/Jamfile"]:::build
        jam2["Release/Jamfile_instr"]:::build
        opt1["Release/CC_options.txt"]:::build
        opt2["Release/CC_no_dep_options.txt"]:::build
        opt3["Release/link_options.txt"]:::build
        res["Release/resources.res"]:::build
        manifest["Release/manifest.xml"]:::build
        exe["test.exe & artifacts"]:::build
    end

    %% Relationships
    MAIN_C -->|"OnPanelEvent"| mainTdm_C
    splash_C -->|"OnPanelEvent"| mainTdm_C
    MAIN_C -->|"UI callbacks"| common_C
    mainTdm_C -->|"DB_Read/Write"| cvi_db_FP
    mainTdm_C -->|"DB_Read/Write"| cvi_db_H
    common_C -->|"DB utilities"| cvi_db_FP
    special0_C -->|"InitInstrument() / ReadData()"| special0_ICD
    mainTdm_C -->|"Orchestrate Modules"| special0_C
    mainTdm_C -->|"Load ICDs"| common_ICD
    mainTdm_C -->|"Load ICDs"| special1_ICD
    mainTdm_C -->|"Load ICDs"| special2_ICD
    mainTdm_C -->|"Load ICDs"| special3_ICD
    mainTdm_C -->|"Load ICDs"| special4_ICD
    mainTdm_C -->|"Load ICDs"| special5_ICD
    MAIN_UIR -->|"Compile .uir → UI code"| cvibuild_dir
    splash_UIR -->|"Compile .uir → UI code"| cvibuild_dir
    MAIN_C -->|"Compile/Link"| cvibuild_dir
    splash_C -->|"Compile/Link"| cvibuild_dir
    mainTdm_C -->|"Compile/Link"| cvibuild_dir
    common_C -->|"Compile/Link"| cvibuild_dir
    special0_C -->|"Compile/Link"| cvibuild_dir
    cvi_db_FP -->|"Include in build"| cvibuild_dir
    cvi_db_H -->|"Include in build"| cvibuild_dir
    common_ICD -->|"Include in build"| cvibuild_dir
    special0_ICD -->|"Include in build"| cvibuild_dir
    special1_ICD -->|"Include in build"| cvibuild_dir
    special2_ICD -->|"Include in build"| cvibuild_dir
    special3_ICD -->|"Include in build"| cvibuild_dir
    special4_ICD -->|"Include in build"| cvibuild_dir
    special5_ICD -->|"Include in build"| cvibuild_dir
    cvibuild_dir --> bs1
    cvibuild_dir --> bs2
    cvibuild_dir --> bs3
    cvibuild_dir --> bs4
    cvibuild_dir --> jam1
    cvibuild_dir --> jam2
    cvibuild_dir --> opt1
    cvibuild_dir --> opt2
    cvibuild_dir --> opt3
    cvibuild_dir --> res
    cvibuild_dir --> manifest
    cvibuild_dir --> exe

    %% Click Events
    click MAIN_UIR "https://github.com/kessity/test/blob/main/MAIN.uir"
    click splash_UIR "https://github.com/kessity/test/blob/main/splash.uir"
    click MAIN_C "https://github.com/kessity/test/blob/main/MAIN.c"
    click splash_C "https://github.com/kessity/test/blob/main/splash.c"
    click MAIN_H "https://github.com/kessity/test/blob/main/MAIN.h"
    click splash_H "https://github.com/kessity/test/blob/main/splash.h"
    click mainTdm_C "https://github.com/kessity/test/blob/main/mainTdm.c"
    click common_C "https://github.com/kessity/test/blob/main/common.c"
    click special0_C "https://github.com/kessity/test/blob/main/speical0.c"
    click cvi_db_FP "https://github.com/kessity/test/blob/main/cvi_db.fp"
    click cvi_db_H "https://github.com/kessity/test/blob/main/cvi_db.h"
    click common_ICD "https://github.com/kessity/test/blob/main/common.icd"
    click special0_ICD "https://github.com/kessity/test/blob/main/special0.icd"
    click special1_ICD "https://github.com/kessity/test/blob/main/special1.icd"
    click special2_ICD "https://github.com/kessity/test/blob/main/special2.icd"
    click special3_ICD "https://github.com/kessity/test/blob/main/special3.icd"
    click special4_ICD "https://github.com/kessity/test/blob/main/special4.icd"
    click special5_ICD "https://github.com/kessity/test/blob/main/special5.icd"
    click cvibuild_dir "https://github.com/kessity/test/tree/main/cvibuild.main/"
    click bs1 "https://github.com/kessity/test/blob/main/cvibuild.main/Release/BuildStep.bat"
    click bs2 "https://github.com/kessity/test/blob/main/cvibuild.main/Release/CallCC.bat"
    click bs3 "https://github.com/kessity/test/blob/main/cvibuild.main/Release/CallLink.bat"
    click bs4 "https://github.com/kessity/test/blob/main/cvibuild.main/Release/CallRC.bat"
    click jam1 "https://github.com/kessity/test/tree/main/cvibuild.main/Release/Jamfile"
    click jam2 "https://github.com/kessity/test/tree/main/cvibuild.main/Release/Jamfile_instr"
    click opt1 "https://github.com/kessity/test/blob/main/cvibuild.main/Release/CC_options.txt"
    click opt2 "https://github.com/kessity/test/blob/main/cvibuild.main/Release/CC_no_dep_options.txt"
    click opt3 "https://github.com/kessity/test/blob/main/cvibuild.main/Release/link_options.txt"
    click res "https://github.com/kessity/test/blob/main/cvibuild.main/Release/resources.res"
    click manifest "https://github.com/kessity/test/blob/main/cvibuild.main/Release/manifest.xml"

    %% Styles
    classDef ui fill:#cfe2f3,stroke:#0b5394,color:#0b5394;
    classDef logic fill:#d9ead3,stroke:#38761d,color:#38761d;
    classDef data fill:#f9cb9c,stroke:#e69138,color:#e69138;
    classDef instr fill:#d9d2e9,stroke:#674ea7,color:#674ea7;
    classDef build fill:#eeeeee,stroke:#7f7f7f,color:#7f7f7f.
```
