op_anim_lprobe_anvid()
摘要
返回与带标签探针关联的查看器 ID,由该探针的标签文本指定。每个已定义的带标签探针的查看器在第一次调用引用该探针标签的本内核过程时被打开。
语法
op_anim_lprobe_anvid (label)
| 参数 | 类型 | 说明 |
|---|---|---|
label |
char* |
自定义动画探针标签 [该值是一个字符串,将与为周围模块定义的所有自定义动画探针的 label 属性进行比较。如果找到匹配,则返回与该探针关联的动画查看器 ID。] |
返回类型
Anvid
带标签探针的查看器 ID
[如果未定义具有指定标签的探针,将返回符号常量 OPC_ANIM_ANVID_NONE 所代表的值。如果完全没有激活的动画流,则返回符号常量 OPC_ANIM_ID_NIL 所代表的值。这些值可以被检测并用于抑制后续动画 KP 的执行,如示例部分所示。]
示例
/* Obtain the ID of a viewer opened by a probe labeled "switch I/O"; */
/* if the probe has not been set, none of the dependent animation statements */
/* will be executed. */
vid = op_anim_lprobe_anvid ("switch I/O");
if (vid != OPC_ANIM_ANVID_NONE)
{
/* Draw background color. */
op_anim_igp_bg_fill (vid, OPC_ANIM_RETAIN | OPC_ANIM_COLOR_STEEL, " ");
/* Load and draw node model. */
op_anim_ime_nmod_draw (vid, OPC_ANIM_MODTYPE_NODE, "hyper_switch", " ",
OPC_ANIM_MOD_OPTION_NONE, OPC_ANIM_DEFPROPS);
/* Draw title string at top of viewer window. */
op_anim_igp_text_draw (vid, OPC_ANIM_COLOR_YELLOW | OPC_ANIM_FONT_OPEN_10 |
OPC_ANIM_ALIGNH_CENTER, 200, 50, "Switch I/O Diagram");
}
详情
本 KP 是获取供 Anim 包 KP 使用的动画查看器 ID 的几种不同技术之一;它获取由带标签的自定义动画探针打开的查看器的 ID。使用带标签探针查看器具有以下特点:
- 单个动画查看器可以由多个进程模型共享(可能分布在整个网络模型中),除了对特定探针标签的共同预期外,不需要进程间通信或协调。
- 动画查看器的位置、大小和名称是在探针编辑器(Probe Editor)中设置的带标签探针的属性,无需修改仿真即可方便地更改。
- 共同构成仿真事件某一特定动态视图的多个动画 KP 可以在特定探针标签下“逻辑分组”,从而方便地启用/禁用组内的所有 KP(例如,用于描绘交换机内数据包处理的所有动画 KP 可以从标签为“switch_proc”的探针获取其查看器 ID——如果未定义这样的探针,相关图形将会出现)。
当指定标签的探针不存在时,指向带标签探针查看器的动画请求将被禁用;此时 op_anim_lprobe_anvid() 返回一个特殊值(由符号常量 OPC_ANIM_ANVID_NONE 标识)。这种禁用可以透明地完成:只需将“空”查看器 ID 传给 Anim KP(它会检测该值并禁用请求而不产生错误);也可以显式检测,在指定带标签探针未定义时避免执行成块的代码并提高性能(如示例中的代码)。
用途
提供了一种获取由限定于特定标签的自定义动画探针打开的查看器的机制。描绘仿真某一特定方面、或显示特定协议栈层内事件的动画 KP 可以将本 KP 的输出作为参数传入,从而可以在探针编辑器中方便地控制请求屏蔽和查看器参数。注意,与带标签探针关联的动画查看器不一定在仿真动画流开始时打开,而是在本 KP 首次以该探针的标签被调用时打开。
错误
- 程序中止:segmentation violation(由于
label参数的字符串格式错误)
参考
- 使用 KP op_anim_viewer_open() 或 op_anim_viewer_open_std() 创建动画查看器并获取其 ID,或与以任何方式(自定义打开、自动探针或自定义探针)创建的现有查看器会合
- 使用 KP op_anim_viewer_close() 关闭不再需要的查看器(如果后续 Anim KP 引用该查看器,关闭带标签探针的查看器将在 anim. 流中导致错误)
- 使用
op_anim_igp…KPs 在已打开的查看器中显示图形图元 - 使用
op_anim_ime…KPs 在已打开的查看器中显示或修改模型元素