op_hla_interaction_pk_struct_set()
注意: 需要 High-Level Architecture 功能
摘要
将一块任意数据存储到代表传出交互的数据包的某个字段中。
语法
op_hla_interaction_pk_struct_set (pk_ptr, field_name, data, size)
| 参数 | 类型 | 说明 |
|---|---|---|
pk_ptr |
Packet * |
代表要发送出的交互的数据包 |
field_name |
const char * |
用于存储数据的包字段 |
data |
char * |
要存储到包字段中的数据块 |
size |
size_t |
数据块的大小,以字节计 |
返回类型
Compcode
完成代码,指示获取 Location ID 的成功或失败。如果数据已成功存储,该内核过程返回 OPC_COMPCODE_SUCCESS;如果无法存储数据,则返回 OPC_COMPCODE_FAILURE。
示例
static void send_reply (void)
{
Packet * reply;
Interaction_Info_Type * info;
. . .
info = (Interaction_Info_Type *)
op_prg_mem_alloc (num_elements * sizeof (Interaction_Info_Type));
. . .
op_hla_interaction_pk_struct_set (reply, "information", info,
num_elements * sizeof (Interaction_Info_Type));
详情
RTI 交互的字段要么是简单类型(short、long、double),要么是一块任意数据,需要由交互的发送方编码、接收方解释。
由于数据的实际大小并非事先已知,该内核过程提供要存储的数据(其地址在 data_ptr 中,其大小在 size 中)。内核过程的调用者应已使用 op_prg_mem_alloc() 创建了该内存块。该内存块会被转移给 HLA-PM,因此调用者不应销毁它。
用途
提供了一种机制,用于将任意数据块存储到代表传出交互的数据包中。
错误
- 可恢复错误:无法设置交互数据包的字段(
<field_name>)。
参考
- 使用内核过程 op_hla_interaction_pk_send() 发送代表交互的数据包
- 使用内核过程 op_prg_mem_alloc() 分配通过
data_ptr提供的内存块