op_ima_sim_attr_get()
摘要
获取仿真属性的值。
语法
op_ima_sim_attr_get (attr_type, attr_name, value_ptr)
| 参数 | 类型 | 说明 |
|---|---|---|
attr_type |
int |
目标属性的类型 [该值是一个数字代码,指定属性类型;此参数的可接受值为 OPC_IMA_INTEGER、OPC_IMA_DOUBLE、OPC_IMA_TOGGLE、OPC_IMA_STRING 或 OPC_IMA_COLOR。] |
attr_name |
const char* |
目标属性的名称 [该值必须指定仿真环境中已定义的属性,否则将发出提示以请求该属性的值。] |
value_ptr |
void* |
指向某个变量的指针,用于填入指定属性的值 [此参数可以接受指向整数、double、 PrgT_Color 或字符串的指针。在最后一种情况下,字符数组必须足够大以容纳该属性的值。参数指针的数据类型必须与指定属性的数据类型匹配,否则会发生错误。] |
返回类型
Compcode
如果成功获取属性值,返回 OPC_COMPCODE_SUCCESS;否则返回 OPC_COMPCODE_FAILURE。
示例
摘自:示例模型(models/std/fddi);进程模型(fddi_mac);状态(INIT);enter execs。
/* Obtain the station latency for tokens and frames. */
op_ima_sim_attr_get (OPC_IMA_DOUBLE, "station_latency", &Fddi_St_Latency);
/* Obtain the propagation delay separating stations. */
/* This value is given in seconds. */
op_ima_sim_attr_get (OPC_IMA_DOUBLE, "prop_delay", &Fddi_Prop_Delay);
/* Derive the Delay for a ’hop’ of a freely circulating packet. */
Fddi_Tk_Hop_Delay = Fddi_Prop_Delay + Fddi_St_Latency;
仿真属性提示在标准输出设备上的示例输出:
-------------------- Unset Environment Attribute ---------------------
* station_latency: <double>
* Desc:
* Press <return> to select default: 0.0
Enter Value> 4.5
详情
仿真属性不是在模型规格阶段定义的,这一点使它们与 subnet、node、module 和进程属性有所区别。相反,这些属性是在仿真运行时动态定义的。这些值通过环境属性机制赋值:仿真的命令行、偏好设置文件(<HOME>/op_admin/opnet-<rel>.prefs)、shell 变量或环境文件(有关环境属性的更多信息,参见第 2 章“Preferences”第 31 页)。
本 KP 会扫描仿真的内部偏好设置文件以寻找可能的值。如果本 KP 在现有程序环境中找不到该仿真属性的值,它就会在标准输出设备上打印提示,请求一个值(此类提示的示例显示在前一页的示例中)。可以使用仿真的 noprompt 环境属性禁用用户提示。当发出提示时,会打印该属性的默认值作为建议的可能取值。
注意: 该默认值是调用本 KP 时传入的 value_ptr 参数所引用的值。它不是取自进程模型属性表中显示的默认初始值。因此,为了在必要时获得干净的提示,在调用本 KP 之前,value_ptr 所引用地址处存储的值应当已被明确定义。
如果指定的属性可以在仿真程序的环境中定位,或者在提示时显式输入了值,则本 KP 被视为成功,并返回 OPC_COMPCODE_SUCCESS。如果 Kernel 不得不改用 value_ptr 所引用地址处存储的值,则返回 OPC_COMPCODE_FAILURE。
用途
提供了一种机制,用于获取在仿真运行时已赋值的仿真属性。本 KP 与通过环境属性为仿真属性赋值的做法相结合,是一种将关键的网络范围参数传递到进程层的有用技术,这些参数会影响进程逻辑的运行。例如,某个仿真属性可能是数据链路协议在放弃某个 Packet 之前所执行的重传次数。
本 KP 存在针对特定数据类型的版本。这些替代 KP 比这种可变参数版本更高效。此外,它们允许编译器捕获使用本 KP 时会漏掉的参数错误。有关详情,参见 op_ima_sim_attr_get_color()、op_ima_sim_attr_get_dbl()、op_ima_sim_attr_get_int32() 和 op_ima_sim_attr_get_str()。
错误
- 程序中止:段违例。(由于无效的值指针、指向内存量不足的指针,或格式错误的 attr_name 参数)
- 程序中止:内存分配失败。
- 可恢复错误:属性类型(
<attr_type>)无法识别。
参考
- 使用 KP op_ima_obj_attr_get()、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() 可获取对象属性的值
- 使用 KP 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() 可为对象属性赋值
- 使用 KP op_ima_obj_svar_get() 可获取进程状态变量的值
- 使用 KP op_ima_obj_command() 可向对象发出命令