op_ima_obj_state_set()

摘要

将一个结构或值附加到对象上,之后可通过 KP op_ima_obj_state_get() 获取。

语法

op_ima_obj_state_set (objid, state_ptr)
参数 类型 说明
objid Objid 目标对象的对象 ID
[进程或队列的对象 ID 可以从 Topo 和 Id 包中的多个 KP 获得:op_topo_assoc()、op_topo_child()、op_id_self() 和 op_id_from_name()。]
state_ptr void* 指向数据结构或值的指针
[该数据结构或值是一个任意的状态指示器,其含义由建模者确定。]

返回类型

Compcode

指示操作是否成功完成的完成代码。该代码可与两个符号常量 OPC_COMPCODE_SUCCESS 和 OPC_COMPCODE_FAILURE 进行比较。

示例

摘自 models/std/utilities/oms 中的 oms_bgutil.ex.c。

/* We will use op_ima_obj_state_set to store in the channel object a dynamically */
/* allocated pointer to the bgutil_routed_state_ptr. */
bgutil_routed_state_pptr = (OmsT_Bgutil_Routed_State **)
	op_prg_mem_alloc (sizeof (OmsT_Bgutil_Routed_State *));
*bgutil_routed_state_pptr = bgutil_routed_state_ptr;
/* Install on this channel the pointer to the bgutil routed state pointer. */
op_ima_obj_state_set (tx_ch_objid, bgutil_routed_state_pptr);

详情

对象可以以值或结构的形式包含状态信息。KP op_ima_obj_state_set() 将这些值或结构附加到对象上,KP op_ima_obj_state_get() 则获取它们的副本。状态信息保留在对象上,可以再次获取。

用途

提供了一种将状态信息附加到仿真对象上的机制。

错误

  • 可恢复错误:对象 ID(<objid>)超出范围。
  • 可恢复错误:对象 ID(<objid>)指向受限对象。

参考

本站文档由 北京智网畅联科技有限公司 整理、翻译并提供 · Documentation compiled and provided by Beijing ZNetLink Technology Co., Ltd.

交流群 · QQ Group:OPNET/智网妙算网络仿真交流群(群号 486383494)

原文档 © 2017 Riverbed Technology · 本站为公益翻译,由 AI 辅助完成,请仔细甄别

Original documentation © 2017 Riverbed Technology. Community translation, AI-assisted. Contact: jiazequn@znetlink.com