op_ima_obj_attr_get()
摘要
获取指定对象中某个属性的值。
语法
op_ima_obj_attr_get (objid, attr_name, value_ptr)
| 参数 | 类型 | 说明 |
|---|---|---|
objid |
Objid |
关注对象的对象 ID [对象 ID 可以从 Topo 包和 Id 包中的多个内核过程获得: op_id_self()、op_topo_parent()、op_topo_child()、op_id_from_userid() 和 op_id_from_name()。] |
attr_name |
const char* |
关注属性的名称 [该值必须是指定对象中已定义的属性,否则会发生错误。] |
value_ptr |
void* |
指向某个变量的指针,该变量将被填入指定属性的值 [此参数可以接受一个字符串,或指向整数、double、PrgT_Color 或指向复合属性值的对象 ID 的指针。对于字符串情形,字符数组必须足够大以容纳该属性的值。 参数指针的数据类型必须与指定属性的数据类型相匹配,否则会发生错误。如果属性的类型为 toggle,返回值将是 OPC_BOOLINT_ENABLED 或 OPC_BOOLINT_DISABLED。如果属性的类型为 profile,返回值是一个 profile 规范(PrgT_Profile_Spec),其中包含使用函数 prg_profile_load() 访问该 profile 所需的信息。] |
返回类型
Compcode
若成功获取属性值,返回 OPC_COMPCODE_SUCCESS;否则返回 OPC_COMPCODE_FAILURE。
如果处理的是相等的合并复合属性(见注意),value_ptr 将被设置为其中一个合并复合属性的对象 ID(不指定是哪一个),并返回 OPC_COMPCODE_SUCCESS。如果合并的复合属性不相等,则返回 OPC_COMPCODE_FAILURE。
注意: 在合并复合属性的语境中,“相等”意味着复合属性对象上的所有属性都具有相同的名称、类型和值,并且复合属性的所有子对象也相等。
示例
/* determine id of own processor to use in finding attrs */
my_id = op_id_self ();
/* determine address range for uniform destination assignment */
op_ima_obj_attr_get (my_id, "low dest address", &low_dest_addr);
op_ima_obj_attr_get (my_id, "high dest address", &high_dest_addr);
/* determine object id of connected ’mac’ layer processor */
mac_objid = op_topo_assoc (my_id, OPC_TOPO_ASSOC_OUT,
OPC_OBJTYPE_QPS, MAC_LAYER_OUT_STREAM);
/* determine the address assigned to it */
/* which is also the address of this station */
op_ima_obj_attr_get (mac_objid, "station_address", &station_addr);
/* setup a distribution for generation of addresses */
dest_dist_ptr = op_dist_load ("uniform_int", low_dest_addr, high_dest_addr);
附加示例——获取并使用字符串变量:
/* Obtain the process name (the "process model" attribute of the module. */
/* Assumes proc_model_name is declared in the temporary variable block as: */
/* char proc_model_name [128]; */
op_ima_obj_attr_get (op_id_self (), "process model", proc_model_name);
详情
对象属性的值可以从网络域对象(子网、节点和链路)、节点域对象(模块)以及复合属性中获取,前提是这些属性已经通过 Network、Node、Process 或 Link 编辑器(或通过 Ema 程序)预先定义。此外,被提升的属性的值可以从分层上包含定义对象的对象中获取(例如,从处理器的根进程自动提升的属性可以从分层上包含该处理器的子网中获取)。引用被提升的属性时,需要为每一个分层中间对象在属性名称前添加一个以点分隔的前缀;也就是说,属性名称按其在被引用对象的菜单中显示的样子来指定。例如,在节点层获取某个进程属性时,属性名称前必须加上“包含”该进程实例的模块的名称。无论使用哪个建模层次来引用属性,找到的并获取的都是同一个公共属性存储单元。
并非所有对象属性都可以在仿真期间通过调用 op_ima_obj_attr_get() 访问。第 3 章 “Network Reference” 第 60 页 对链路属性和节点属性进行了详细说明。任何 Simulation/Access 字段标记为 N/A 的属性都不能通过调用 op_ima_obj_attr_get() 访问。
注意: 获取字符串属性时,请确保 *value_ptr 足够大以容纳预期的属性值。字符串属性可以是任意长度;但显示给用户的字符最多为 2048 个。
用途
提供一种在仿真过程中动态获取对象属性的机制。该设施可供处理器(或队列)使用,用于确定自身属性的值,或网络中任何其他对象的属性的值。例如,可以查询天线的指向方向,或发射机信道的功率。该内核过程与 op_ima_obj_attr_set() 配合使用,还可以提供一种不涉及 Packet、ICI 或中断投递的远程进程间通信方法。
此内核过程存在针对特定数据类型的版本。这些替代内核过程比这种可变参数版本更高效。此外,它们还允许编译器捕获这种内核过程漏掉的参数错误。详情参见 op_ima_obj_attr_get_color()、op_ima_obj_attr_get_dbl()、op_ima_obj_attr_get_int32()、op_ima_obj_attr_get_objid()、op_ima_obj_attr_get_str() 和 op_ima_obj_attr_get_toggle()。
错误
- 程序中止:Segmentation violation(由于无效的值指针、指向内存不足的指针,或
attr_name的地址无效) - 可恢复错误:属性名称(
<attr_name>)对于对象(<objid>)无法识别。 - 可恢复错误:对象 ID(
<objid>)超出范围。 - 可恢复错误:对象 ID(
<objid>)指向受限对象。(由于关注对象位于受保护的模型内)
参考
- 使用内核过程 op_ima_obj_attr_set()、op_ima_obj_attr_set_color()、op_ima_obj_attr_set_dbl()、op_ima_obj_attr_set_int32()、op_ima_obj_attr_set_objid()、op_ima_obj_attr_set_str() 和 op_ima_obj_attr_set_toggle() 为对象属性赋值
- 使用内核过程 op_ima_sim_attr_get()、op_ima_sim_attr_get_color()、op_ima_sim_attr_get_dbl()、op_ima_sim_attr_get_int32() 和 op_ima_sim_attr_get_str() 获取仿真属性的值
- 使用内核过程 op_ima_obj_svar_get() 获取进程状态变量的值
- 使用内核过程 op_ima_obj_command() 向对象发出命令
- 使用内核过程 op_id_self() 获取所在处理器或队列的对象 ID
- 使用内核过程 op_id_from_name() 获取任意对象的对象 ID