From 5ecd52fcb7279e93f17a22193278e3558f5d9474 Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Sat, 28 Mar 2026 14:14:50 +0000 Subject: [PATCH] docs: improve and synchronize EN/CN README files Agent-Logs-Url: https://github.com/NEVSTOP-LAB/LabVIEW-TagDB/sessions/f40dd018-e992-4c2a-b5c8-1bd2dca60209 Co-authored-by: nevstop <8196752+nevstop@users.noreply.github.com> --- README(en).md | 40 ++++++++++++++++++++-------------------- README.md | 38 +++++++++++++++++++------------------- 2 files changed, 39 insertions(+), 39 deletions(-) diff --git a/README(en).md b/README(en).md index 212381f..dad7888 100644 --- a/README(en).md +++ b/README(en).md @@ -2,7 +2,7 @@ [English](./README(en).md) | [中文](./README.md) -NEVSTOP TagDB is an advanced data management library designed specifically for the LabVIEW environment, providing efficient reading, writing, storage, and sharing of configuration and Tag data. Through optimized data structures and caching mechanisms, it offers reliable data persistence and real-time data access solutions for LabVIEW applications. +NEVSTOP TagDB is an advanced data management library for LabVIEW, providing efficient read/write, storage, and sharing of configuration and Tag data. With optimized data structures and a built-in caching layer, it delivers reliable data persistence and real-time access for LabVIEW applications. ## Directory Structure @@ -25,7 +25,7 @@ NEVSTOP TagDB is an advanced data management library designed specifically for t ### 1. Flexible Data Storage - Supports persistent storage of configuration data and Tag data -- Automatically supports conversion and storage of all LabVIEW data types through VIM (VI Macro) +- Supports read/write and automatic type conversion for all LabVIEW data types via VIM (VI Macro) - Specially optimized for Reference type data to ensure efficient storage and retrieval ### 2. Multi-thread Safety @@ -34,9 +34,9 @@ NEVSTOP TagDB is an advanced data management library designed specifically for t - Supports data access and synchronization across VIs and tasks ### 3. High Performance Design -- Implements efficient caching mechanism for fast data access +- Implements an efficient caching mechanism for fast data access - Optimized data structures to reduce memory usage and improve retrieval efficiency -- Supports name-based DBRef acquisition method, similar to LabVIEW Named Queue, simplifying programming patterns +- Supports name-based DBRef lookup (similar to LabVIEW Named Queue), simplifying cross-VI data access patterns ### 4. Configuration Management - Complete configuration file import/export functionality @@ -63,9 +63,9 @@ NEVSTOP TagDB is an advanced data management library designed specifically for t |--------------|-------------| | TagDB-Write.vim | Writes/updates the value of a single Tag | | TagDB-Write Data Recursive.vim | Recursively writes/updates data structures to Tags | -| TagDB-Write Data Elements.vim | Writes data, when data is Cluster, writes sequentially according to element names | +| TagDB-Write Data Elements.vim | For Cluster data, writes each element to its corresponding Tag by element name | | TagDB-Read.vim | Reads the value of a single Tag | -| TagDB-Read Data By Element Names.vim | Reads data, when data is Cluster, reads sequentially according to element names | +| TagDB-Read Data By Element Names.vim | For Cluster data, reads each element from its corresponding Tag by element name | | TagDB-Read By RegExp.vim | Batch reads Tags using regular expressions | | TagDB-Delete.vi | Deletes a Tag | | TagDB-Delete Single.vi | Deletes a single Tag by name | @@ -77,7 +77,7 @@ NEVSTOP TagDB is an advanced data management library designed specifically for t |--------------|-------------| | TagDB-Load.vi | Loads TagDB configuration from file | | TagDB-Save.vi | Saves TagDB configuration to file | -| TagDB-Set Lock.vi | Locks/unlocks TagDB, disallows/allows adding new Tags | +| TagDB-Set Lock.vi | Locks/unlocks TagDB to restrict or allow adding new Tags | ### Utility Functions @@ -94,20 +94,20 @@ NEVSTOP TagDB is an advanced data management library designed specifically for t ## Best Practices ### Data Management -- **Data sharing in multi-threaded environments**: Use TagDB as a data sharing center between multi-threaded applications, avoiding the use of global variables -- **Configuration information storage**: Store system configuration information in TagDB for easy import/export and version control -- **Temporary data caching**: Utilize TagDB's caching functionality to achieve asynchronous updates and fast access to data points -- **Control reference management**: Store LabVIEW front panel control References for convenient dynamic UI manipulation +- **Multi-threaded data sharing**: Use TagDB as a shared data hub across threads, replacing global variables +- **Configuration storage**: Store system configuration in TagDB for easy import/export and version management +- **Temporary data caching**: Leverage TagDB's caching to enable asynchronous updates and fast access to data points +- **Control reference management**: Store front-panel control References for dynamic UI manipulation ### Performance Optimization -- For frequently accessed data, consider using TagDB's caching mechanism -- When performing bulk data operations, properly use batch operation functions to improve efficiency -- Appropriately use the locking feature to prevent data modification during critical operations +- For frequently accessed data, make use of TagDB's caching mechanism +- For bulk data operations, prefer batch operation functions to improve efficiency +- Use the locking feature during critical operations to prevent unintended data modification ### Debugging Techniques -- Use the three built-in Probe tools to monitor the status and data changes of TagDB during runtime -- Regularly check the database status using TagDB-Status.vi to detect issues in a timely manner -- Use TagDB-Change Detector.vi to monitor changes in specific Tags, facilitating debugging of complex interaction logic +- Use the three built-in Probe tools to monitor TagDB state and data changes at runtime +- Periodically check database status with TagDB-Status.vi to catch issues early +- Use TagDB-Change Detector.vi to watch specific Tags for value changes, aiding in debugging complex interaction logic ## Example Programs @@ -117,14 +117,14 @@ The library includes multiple example programs demonstrating usage in different - **TagDB Application Example**: Practical application demonstration with a complete model configuration system - **TagDB For Control Reference.vi**: Example of handling Reference type data for UI controls - **TagDB Multi-Thread Example**: Usage example in multi-threaded environments -- **TagDB Read Data Example.vi**: Comprehensive example showing various reading operations including single read, element name read (for Cluster data), and regular expression read -- **TagDB Write Data Example.vi**: Comprehensive example demonstrating various writing operations including single write, element name write (for Cluster data), and recursive data structure write +- **TagDB Read Data Example.vi**: Comprehensive read example covering single read, element-name read (for Cluster data), and regular expression read +- **TagDB Write Data Example.vi**: Comprehensive write example covering single write, element-name write (for Cluster data), and recursive data structure write - **TagDB Using regexp Example.vi**: Regular expression query example - **TagDB Refresh UI Value.vi**: UI value refresh example, showing how to update UI control values in real-time ## Installation Instructions -Install the VIP package using VIPM (VI Package Manager) +Install the VIP package using VIPM (VI Package Manager). ## System Requirements diff --git a/README.md b/README.md index 254959d..9a70841 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ [English](./README(en).md) | [中文](./README.md) -NEVSTOP TagDB 是一个专为 LabVIEW 环境设计的高级数据管理库，提供配置及 Tag 数据的高效读写、存储和共享功能。它通过优化的数据结构和缓存机制，为 LabVIEW 应用程序提供了可靠的数据持久化和实时数据访问解决方案。 +NEVSTOP TagDB 是专为 LabVIEW 环境设计的高级数据管理库，提供配置与 Tag 数据的高效读写、存储和共享能力。库内置优化的数据结构与缓存机制，为 LabVIEW 应用程序实现可靠的数据持久化与实时访问。 ## 目录结构 @@ -25,7 +25,7 @@ NEVSTOP TagDB 是一个专为 LabVIEW 环境设计的高级数据管理库，提 ### 1. 灵活的数据存储 - 支持配置数据和 Tag 数据的持久化存储 -- 通过 VIM (VI Macro) 自动支持 LabVIEW 所有数据类型的转换和存储 +- 通过 VIM (VI Macro) 自动支持 LabVIEW 所有数据类型的读写与转换 - 针对 Reference 类型数据进行了特别优化，确保高效存储和检索 ### 2. 多线程安全 @@ -36,7 +36,7 @@ NEVSTOP TagDB 是一个专为 LabVIEW 环境设计的高级数据管理库，提 ### 3. 高性能设计 - 实现高效的缓存机制，提供快速数据访问 - 优化的数据结构，减少内存占用和提高检索效率 -- 支持按名称获取 DBRef 的方法，类似 LabVIEW Named Queue，简化编程模式 +- 支持按名称获取 DBRef，类似 LabVIEW Named Queue，简化跨 VI 的数据访问模式 ### 4. 配置管理 - 完整的配置文件导入导出功能 @@ -63,9 +63,9 @@ NEVSTOP TagDB 是一个专为 LabVIEW 环境设计的高级数据管理库，提 |---------|---------| | TagDB-Write.vim | 写入/更新单个 Tag 的值 | | TagDB-Write Data Recursive.vim | 递归写入/更新数据结构到 Tags | -| TagDB-Write Data Elements.vim | 写入数据，当数据是Cluster时，根据元素名称依次写入 | +| TagDB-Write Data Elements.vim | 写入 Cluster 数据时，按元素名称逐一写入对应 Tag | | TagDB-Read.vim | 读取单个 Tag 的值 | -| TagDB-Read Data By Element Names.vim | 读取数据，当数据是Cluster时，根据元素名称依次读取 | +| TagDB-Read Data By Element Names.vim | 读取 Cluster 数据时，按元素名称逐一读取对应 Tag | | TagDB-Read By RegExp.vim | 使用正则表达式批量读取 Tag | | TagDB-Delete.vi | 删除 Tag | | TagDB-Delete Single.vi | 通过名称删除单个 Tag | @@ -77,7 +77,7 @@ NEVSTOP TagDB 是一个专为 LabVIEW 环境设计的高级数据管理库，提 |---------|---------| | TagDB-Load.vi | 从文件加载 TagDB 配置 | | TagDB-Save.vi | 将 TagDB 配置保存到文件 | -| TagDB-Set Lock.vi | 锁定/解锁 TagDB，禁止/允许添加新 Tag | +| TagDB-Set Lock.vi | 锁定/解锁 TagDB，限制或开放新 Tag 的添加 | ### 实用工具函数 @@ -94,20 +94,20 @@ NEVSTOP TagDB 是一个专为 LabVIEW 环境设计的高级数据管理库，提 ## 最佳实践 ### 数据管理 -- **多线程环境下的数据共享**：使用 TagDB 作为多线程应用程序之间的数据共享中心，避免使用全局变量 -- **配置信息存储**：将系统配置信息存储在 TagDB 中，便于导入导出和版本控制 -- **临时数据缓存**：利用 TagDB 的缓存功能实现数据点的异步更新与快速访问 -- **控件引用管理**：存储 LabVIEW 前面板控件 Reference，方便动态操作 UI +- **多线程数据共享**：以 TagDB 作为多线程应用的数据共享中心，取代全局变量 +- **配置信息存储**：将系统配置保存在 TagDB 中，便于导入/导出和版本管理 +- **临时数据缓存**：利用 TagDB 缓存功能实现数据点的异步更新与快速访问 +- **控件引用管理**：存储前面板控件 Reference，方便动态操作 UI ### 性能优化 -- 对于频繁访问的数据，考虑使用 TagDB 的缓存机制 -- 在大量数据操作时，合理使用批量操作函数以提高效率 -- 适当使用锁定功能，防止在关键操作期间数据被修改 +- 对频繁访问的数据，善用 TagDB 的缓存机制 +- 大量数据操作时，优先使用批量操作函数以提高效率 +- 在关键操作期间使用锁定功能，防止数据被意外修改 ### 调试技巧 -- 使用内置的三种 Probe 工具监控运行时 TagDB 的状态和数据变化 -- 利用 TagDB-Status.vi 定期检查数据库状态，及时发现问题 -- 使用 TagDB-Change Detector.vi 监控特定 Tag 的变化，便于调试复杂交互逻辑 +- 使用内置三种 Probe 工具监控运行时 TagDB 的状态与数据变化 +- 使用 TagDB-Status.vi 定期检查数据库状态，及时发现异常 +- 使用 TagDB-Change Detector.vi 监控特定 Tag 的值变化，便于调试复杂交互逻辑 ## 示例程序 @@ -117,14 +117,14 @@ NEVSTOP TagDB 是一个专为 LabVIEW 环境设计的高级数据管理库，提 - **TagDB Application Example**：带有完整模型配置系统的实际应用演示 - **TagDB For Control Reference.vi**：用于 UI 控件的 Reference 类型数据处理示例 - **TagDB Multi-Thread Example**：多线程环境下的使用示例 -- **TagDB Read Data Example.vi**：综合示例，展示各种读取操作，包括单次读取、元素名称读取（用于Cluster数据）和正则表达式读取 -- **TagDB Write Data Example.vi**：综合示例，演示各种写入操作，包括单次写入、元素名称写入（用于Cluster数据）和递归数据结构写入 +- **TagDB Read Data Example.vi**：综合读取示例，涵盖单次读取、按元素名称读取（Cluster 数据）及正则表达式读取 +- **TagDB Write Data Example.vi**：综合写入示例，涵盖单次写入、按元素名称写入（Cluster 数据）及递归数据结构写入 - **TagDB Using regexp Example.vi**：正则表达式查询示例 - **TagDB Refresh UI Value.vi**：UI 值刷新示例，展示如何实时更新 UI 控件值 ## 安装说明 -使用 VIPM (VI Package Manager) 打安装 VIP 包 +使用 VIPM (VI Package Manager) 安装 VIP 包 ## 系统要求