op_topo_child()
摘要
获取指定类型和索引的子对象的对象 ID。
语法
op_topo_child (parent_objid, child_type, child_index)
| 参数 | 类型 | 说明 |
|---|---|---|
parent_objid |
Objid |
父对象的对象 ID [对象 ID 可通过 Id 包中的多个内核过程获得: op_id_self()、op_id_from_userid() 和 op_id_from_name()。此外,对象 ID 也可从 Topo 包内核过程 op_topo_parent()、op_topo_child()、op_topo_assoc() 和 op_topo_connect() 的先前调用中获得。] |
child_type |
int |
所关注子对象的元类型 [该值是一个整数代码,指定所关注子对象的对象类型(参见表 69“对象类型符号常量”第 19 页)。] |
child_index |
int |
所关注子对象的数字索引 [子对象索引从 0 开始,每次递增 1,最大值为该类型子对象数量减 1。] |
返回类型
Objid
指定子对象的对象 ID。若发生可恢复错误,将返回符号常量 OPC_OBJID_INVALID 所代表的特殊值。
示例
/* Set unique user ID's of the nodes in parent subnet. */
/* First obtain the subnet object ID. */
node_id = op_topo_parent (op_id_self ());
subnet_id = op_topo_parent (node_id);
/* Determine the number of children that are nodes. */
node_count = op_topo_child_count (subnet_id, OPC_OBJMTYPE_NODE);
/* Loop through the child nodes and set unique user ID's. */
for (i = 0; i < node_count; i++)
{
node_id = op_topo_child (subnet_id, OPC_OBJMTYPE_NODE, i);
op_ima_obj_attr_set (node_id, "user id", i);
}
详情
子对象包含在父对象之内。子网的子对象包括其他子网、节点、链路和总线抽头。节点的子对象包括模块、数据包流和统计量连线。队列模块的子对象是子队列。发射机和接收机的子对象是信道。
指定所关注的子对象需要两个参数:
- 子对象的类型
- 子对象在指定类型的所有子对象集合中的数字索引
对该内核过程的连续调用可用于沿对象层次结构向下移动。在一个具有五级对象的示例仿真中,通过五次连续调用该内核过程,即可将“顶层”子网(对象 ID = 0)转换为子队列对象 ID,如下所示:
subnet_objid = op_topo_child (top_subnet_objid, OPC_OBJTYPE_SUBNET_FIX, 0);
node_objid = op_topo_child (subnet_objid, OPC_OBJTYPE_NODE_FIX, 0);
queue_objid = op_topo_child (node_objid, OPC_OBJTYPE_QUEUE, 0);
subq_comp_attr_objid = op_topo_child (queue_objid, OPC_OBJTYPE_COMP, 0);
subqueue_objid = op_topo_child (subq_comp_attr_objid, OPC_OBJTYPE_SUBQ, 0);
注意 subq_comp_attr_objid 是一种内置的复合属性类型。对于用户定义的复合属性:
generic_objid = op_topo_child (comp_attr_objid, OPC_OBJTYPE_GENERIC, 0);
路径没有子对象,也不属于任何子网。因此,如果 parent_obj_hndl 引用路径对象,或 child_type 等于 OPC_OBJTYPE_PATH,该函数将返回空句柄。
用途
当已知较高层对象的 ID 且需要对较低层对象执行操作时,该内核过程提供了一种沿对象树向下移动的机制。它常用于获取已知发射机或接收机内包含的信道的对象 ID,以便通过内核过程 op_ima_obj_attr_get() 或 op_ima_obj_attr_set() 获取或设置信道属性的值。另一种常见用途是用该内核过程获取已知节点内包含的模块的对象 ID,但这通常通过内核过程 op_id_from_name() 完成,后者按名称而非数字索引标识子对象。该内核过程还用于获取用户定义复合属性及其子对象的对象 ID。
错误
- 可恢复错误:对象 ID (<parent_objid>) 超出范围。
- 可恢复错误:对象元类型 (<child_type>) 无法识别。
- 可恢复错误:对象 (<parent_objid>) 没有子对象。
- 可恢复错误:子对象索引 (<child_index>) 超出范围。
- 可恢复错误:子对象索引 (<child_index>) 超过指定类型的子对象数量。
- 可恢复错误:对象 ID (<parent_objid>) 指向受限对象。
参考
- 使用内核过程 op_topo_child_count() 确定对象的子对象数量
- 使用内核过程 op_ima_obj_attr_get() 获取对象属性的值
- 使用内核过程 op_ima_obj_attr_set() 为对象属性赋值
- 使用内核过程 op_topo_object() 获取对象的对象 ID
- 使用内核过程 op_topo_parent() 获取对象的父对象的对象 ID
- 使用内核过程 op_id_from_name() 从名称获取子对象的对象 ID