Skip to content

WaveformDisplay2.md

Latest commit

 

History

History
142 lines (89 loc) · 4.48 KB

WaveformDisplay2.md

File metadata and controls

142 lines (89 loc) · 4.48 KB
Raw

WaveformDisplay2 — CSM 模块接口文档

⚠️ AI 自动生成，还未经过人工审阅

本文档由 AI 基于代码仓库结构和脚本上下文自动生成，可能包含不准确或遗漏的信息。请在合并前进行人工核查。

功能简述

WaveformDisplay2 是 WaveformDisplay 的改进版本，一个 CSM 模块，用于在波形图上显示波形数据。

相比原版 WaveformDisplay，本版本可能包含性能优化或功能增强。具体差异请参考模块内部实现。

模块信息

属性 值
LabVIEW 版本 ≥ 2020
支持的操作系统 Windows
支持 RT ❌ 不支持
支持 64-bit ✅ 支持
所属模块组 CSM-WaveformDisplay.lvlib

依赖项

依赖 类型
Communicable-State-Machine 必须
CSM-MassData-Parameter-Support 必须
CSM-API-String-Arguments-Support 可选

API 接口（消息接口）

以下是外部调用者可以发送给本模块的消息。

API: Initialize

初始化波形图控件和内部资源。

  • 参数：APIString — String：配置文件路径
  • 响应：N/A

API: Start

启动波形显示。

  • 参数：N/A
  • 响应：N/A

API: Stop

停止波形显示，释放资源。

  • 参数：N/A
  • 响应：N/A

UI: Update Waveforms

接收并更新波形图显示数据。

  • 参数：MassData — Waveform[]：一维波形数据数组
  • 响应：N/A

UI: Front Panel State

控制本模块前面板的显示状态。

  • 参数：APIString — Enum：Open、Close 或 Minimize
  • 响应：N/A

参数类型说明

类型 说明
HexStr 将 LabVIEW Variant 序列化为十六进制字符串，内置支持
ErrStr 将错误信息编码为字符串，内置支持
APIString 支持嵌套键值对的纯文本字符串，需要 CSM API String Arguments Support 插件
MassData 内存映射缓冲区，传递 Start:N,Size:M，需要 CSM MassData Parameter Support 插件

注意：接口文档中对 String 类型数据统一使用 APIString 标注。

状态广播接口

本模块不主动广播状态。

属性接口

本模块暂无对外暴露的属性。

配置说明

同 WaveformDisplay，使用相同的辅助 VI：

  • Graph-UpdatePlotLegend.vi — 更新波形图图例文字
  • Waveform-GetAttributes.vi — 从波形数据中提取属性

调用限制与注意事项

Important

  • API: Initialize 必须在其他任何 API 之前调用。
  • 本模块为单例——同一时间不可运行多个实例。
  • 本模块为 WaveformDisplay 的改进版本，接口保持兼容。

使用示例

将 UI.Waveform2 替换为启动模块 VI 时实际使用的名称。

API: Initialize -@ UI.Waveform2
API: Start -@ UI.Waveform2
Acquired Waveform@Acquisition >> UI: Update Waveforms@UI.Waveform2 -><register>
API: Stop -@ UI.Waveform2

备注

  • 本模块为 WaveformDisplay 的第二代版本，具体改进内容请参考 CHANGELOG 或代码提交记录。
  • 如需更精细的引用控制，可使用 WaveformDisplay(SingleRef) 或 WaveformDisplay(Multi-Refs) 变体。