CAPL系统事件-03 on preStop

在CAPL（CAN Access Programming Language）中，on preStop 事件是一个特殊的事件处理程序，用于在仿真节点（Simulation Node）停止之前执行特定的清理操作 。这个事件通常用于保存数据、释放资源、发送最终消息或执行其他仿真结束前的必要操作 。

---

1. on preStop 事件的基本功能

• 触发时机：在仿真节点停止之前触发。
• 主要用途：
  • 保存仿真数据（如日志、变量值）。
  • 释放资源（如关闭文件、释放内存）。
  • 发送最终消息。
  • 执行仿真结束前的清理操作。

---

2. on preStop 事件的语法

on preStop
{
    // 清理代码
}

---

3. on preStop 事件的使用场景

场景1：保存仿真数据

在仿真停止之前，将仿真数据保存到文件。

variables
{
    int gCounter = 0;
}

on preStop
{
    // 打开文件
    dword fileHandle;
    fileHandle = openFile("simulation_log.txt", 2); // 2表示写模式
    
    // 写入数据
    fileWrite(fileHandle, "Final Counter Value: %d", gCounter);
    
    // 关闭文件
    closeFile(fileHandle);
}

场景2：发送最终消息

在仿真停止之前，发送一条最终消息。

on preStop
{
    // 发送最终消息
    message Msg1;
    Msg1.id = 0x100;
    Msg1.dlc = 8;
    Msg1.byte(0) = 0xFF; // 最终状态
    output(Msg1);
}

场景3：释放资源

在仿真停止之前，释放占用的资源（如关闭文件、释放内存）。

variables
{
    dword fileHandle;
}

on preStop
{
    // 关闭文件
    if (fileHandle != 0) {
        closeFile(fileHandle);
    }
}

场景4：执行清理操作

在仿真停止之前，执行其他清理操作（如重置变量、停止定时器）。

variables
{
    int gCounter = 0;
    msTimer timer1;
}

on preStop
{
    // 重置变量
    gCounter = 0;
    
    // 停止定时器
    cancelTimer(timer1);
}

---

4. on preStop 事件的注意事项

• 执行顺序：on preStop 事件在仿真节点停止之前执行，确保所有清理操作在仿真结束前完成。
• 仅适用于仿真节点：on preStop 事件仅适用于仿真节点，不适用于测试模块或测量节点。
• 避免耗时操作：由于 on preStop 事件在仿真停止之前执行，应避免执行耗时操作，以免延迟仿真停止。

---

5. 示例

以下是一个完整的CAPL脚本示例，展示了如何使用 on preStop 事件进行清理操作：

variables
{
    int gCounter = 0;
    msTimer timer1;
    dword fileHandle;
}

on start
{
    // 启动定时器
    setTimer(timer1, 100);
    
    // 打开文件
    fileHandle = openFile("simulation_log.txt", 2);
}

on timer timer1
{
    // 定时器触发时执行的操作
    gCounter++;
    write("Timer triggered! Counter: %d", gCounter);
    
    // 重新启动定时器
    setTimer(timer1, 100);
}

on preStop
{
    // 保存仿真数据
    fileWrite(fileHandle, "Final Counter Value: %d", gCounter);
    
    // 关闭文件
    closeFile(fileHandle);
    
    // 停止定时器
    cancelTimer(timer1);
    
    // 发送最终消息
    message Msg1;
    Msg1.id = 0x100;
    Msg1.dlc = 8;
    Msg1.byte(0) = 0xFF;
    output(Msg1);
}

---

6. on preStop 与 on stop 的区别

• 触发时机：
  • on preStop：在仿真节点停止之前触发。
  • on stop：在仿真节点停止时触发。
• 主要用途：
  • on preStop：用于仿真停止前的清理操作（如保存数据、释放资源）。
  • on stop：用于仿真停止时的最终操作（如记录日志、发送最终状态）。

---

总结

on preStop 事件是CAPL中用于在仿真节点停止之前执行清理操作的重要事件处理程序。通过合理使用 on preStop 事件，可以确保仿真结束前的资源释放和数据保存，从而提高仿真脚本的可靠性和可维护性。