op_pk_nfd_set()
已弃用——请使用显式指定类型的 op_pk_nfd_set_<type>()
摘要
设置指定数据包中预定义的信息(information)字段;目标字段通过名称指定。
注意:该形式仅用于信息字段。对于其他字段类型,请使用其他形式(详情参见目的部分)。
语法
op_pk_nfd_set (pkptr, fd_name)
| 参数 | 类型 | 说明 |
|---|---|---|
pkptr |
Packet* |
指向目标数据包的指针 [数据包的指针可以从许多内核过程获得,包括 op_pk_create_fmt()、op_pk_copy()、op_pk_get()、op_subq_pk_access() 和 op_subq_pk_remove()。] |
fd_name |
const char* |
目标字段的名称 [该名称必须是数据包格式中已定义的字段,否则会发生错误。] |
返回类型
Compcode
完成代码,指示是否为指定字段成功赋了新值。如果发生可恢复错误,将返回 OPC_COMPCODE_FAILURE。
示例
/* create a formatted packet */
f_pkptr = op_pk_create_fmt ("info_pkt");
/* assign an integer code to the packet */
op_pk_nfd_set (f_pkptr, "fd_type", DATA_XFER);
/* set the information field in the packet */
op_pk_nfd_set (f_pkptr, "fd_data");
/* send the defined packet out of the processor */
op_pk_send (f_pkptr, OUTSTRM);
详情
对于信息字段类型,该字段所模拟数据的实际值与仿真无关,因此数据包中只存储该字段的大小。op_pk_nfd_set() 内核过程的该形式只执行在格式化数据包内设置信息字段的功能,因为这些字段的大小在格式中已自动预定义。无法通过直接调用内核过程来更改格式化数据包中信息字段的大小,但可以通过以下方式实现:
- 使用内核过程 op_pk_name_to_index() 或 op_pk_nfd_name_to_index() 将字段名称转换为字段索引
- 使用内核过程 op_pk_fd_set() 设置该信息字段的大小
通过内核过程 op_pk_nfd_get() 获取信息字段的值没有有效用途,但该操作不会导致错误,而是将字符串 “unspecified” 复制到传入的值指针中。
目的
提供一种设置数据包内部信息字段大小的机制。由于数据包是格式化的,信息字段的大小(若使用未格式化版本的内核过程 op_pk_fd_set() 则需要指定)会自动从格式中查得。
**注意:**该内核过程只应应用于格式化数据包;否则会发生错误。
op_pk_nfd_set() 的该形式只支持信息字段类型,因为没有指定字段值。该内核过程的其他形式支持整型、双精度或数据包字段类型(op_pk_nfd_set())以及结构字段类型(op_pk_nfd_set())。
该内核过程存在针对特定数据类型的版本。该替代内核过程比这种可变参数版本更高效;此外,它还能让编译器捕获该内核过程遗漏的参数错误。详情参见 op_pk_nfd_set_info()。
错误
- 程序中止:段违例。(由无效的数据包指针或 fd_name 参数引起)
- 程序中止:数据包指针为 NIL。
- 程序中止:数据包指针指向已被销毁的数据包。
- 程序中止:数据包指针指向无主数据包 (
<pk_id>)。 - 可恢复错误:数据包 (
<pk_id>) 中没有名为 (<fd_name>) 的字段。
参考
- 使用该内核过程的其他形式为数据包的整型、双精度、数据包或结构字段赋值
- 使用内核过程 op_pk_fd_set() 的变体,通过数字索引指定字段,为数据包中的字段赋值
- 使用内核过程 op_pk_nfd_strip() 的变体,取消数据包中某字段的设置,并从数据包总大小中减去其贡献