document_generate/README.md

59 lines
1.8 KiB
Markdown
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# BNTVS_SW — 总线网络测试验证软件
## 概述
总线网络测试验证软件 (Bus Network Test Verification Software, BNTVS_SW) 是机载总线网络测试验证系统的核心控制与数据处理软件。它运行在总线节点计算机和存储服务计算机上通过统一的用户界面提供对机载通信总线以太网、RS422、CAN、模拟量/离散量)的实时监听、协议解析、数据存储、故障诊断、故障注入、性能测试及数据管理与回放等功能。
## 软件单元
| 标识 | 名称 | 职责 |
| :--- | :--- | :--- |
| SU-COM | 基础通用通信单元 | 多总线并发基础通信 |
| SU-PROT | 协议兼容单元 | CAN2.0/CANFD协议兼容 |
| SU-STOR | 数据存储单元 | 持久化存储与分段管理 |
| SU-REPLAY | 数据管理与回放单元 | 历史数据检索与回放 |
| SU-ROUTE | 总线路由单元 | 以太网-CAN路由与协议转换 |
| SU-ANALY | 总线分析单元 | 监听、解析、诊断、监视 |
| SU-FAULT | 故障注入单元 | 短路/断路/干扰/错误帧注入 |
| SU-CONV | 信号转换单元 | 模拟量/离散量→总线信号 |
| SU-TEST | 总线测试分析单元 | 延迟/吞吐量/稳定性测试 |
## 构建与运行
### 依赖
- CMake ≥ 3.14
- C++17 兼容编译器GCC 8+, Clang 10+, MSVC 2019+
### 构建步骤
```bash
cd codegen-runs/codegen_6d86f8e27b034f19a3c48454544db10c
mkdir build && cd build
cmake ..
cmake --build .
```
### 运行主程序
```bash
./BNTVS_SW
```
### 运行测试
```bash
./BNTVS_SW_test
```
## 需求追踪
本工程通过 Doxygen `@requirement` 标签在函数级注释中关联 CSCI 需求标识SRS-F-xx-xxx确保每个业务函数可追踪到对应需求。详细需求清单见项目文档。
## 编码规范
- C++17 标准
- Doxygen 风格注释
- 模块化设计,职责单一
- 无外部第三方库依赖