Oma_Ov_Reader_Iterator_Create()
摘要
创建一个用于从 OV 文件中检索输出向量的迭代器。
语法
Oma_Ov_Reader_Iterator_Create (ov_reader_ptr, report_name, obj_path, group_and_stat_name)
| 参数 | 类型 | 说明 |
|---|---|---|
ov_reader_ptr |
OmaT_Ov_Reader * |
目标 OV 文件。 |
report_name |
const char * |
作为筛选条件使用的报表名,用于筛选迭代器提供的向量。参见下文 report_name。 |
obj_path |
const char * |
作为筛选条件使用的完整层次对象名,用于筛选迭代器提供的向量。参见下文 obj_path。 |
group_and_stat_name |
const char * |
迭代器提供的统计量的完整名称。参见下文 group_and_stat_name。 |
返回类型
OmaT_Ov_Reader_Iterator *
可用于筛选特定向量的迭代器。
头文件
oma_ov.h
详情
此函数创建一个迭代器对象,可用于查找所有满足特定条件的向量并遍历它们。匹配条件的工作方式如下。
report_name
此条件用于筛选与特定报表匹配的统计量,规则如下:
- 若
report_name为 PRGC_NIL,则选择所有统计量,不论其出现在哪个报表中。 - 若
report_name为 OmaC_Ov_Default_Report_Name,则选择所有未指定报表的统计量。 - 若
report_name为其他字符串值,则只选择属于该报表的统计量。
obj_path
此条件用于筛选适用于特定对象的统计量,规则如下:
- 若
object_path为 PRGC_NIL,则选择所有统计量。 - 若
object_path为 OmaC_Ov_Global_Object_Path,则只选择全局统计量。 - 若
object_path为其他字符串值,则只选择该对象的统计量。
group_and_stat_name
此条件用于筛选特定的统计量,规则如下:
- 若
group_and_stat_name为 PRGC_NIL,则选择所有统计量。 - 若
group_and_stat_name为其他字符串值,则只选择该统计量。该参数的取值应为统计量的完整名称。例如,要选择“Ethernet”组中的“Load (bits/sec)”统计量,group_and_stat_name应为“Ethernet.Load (bits/sec)”。
这些筛选条件可以组合使用,以按需要过滤统计量。例如,要获取“January”报表中节点“Logical Network.boston.router”的所有统计量,应按如下方式调用此函数:
Oma_Ov_Reader_Iterator_Create (ov_reader_ptr, "January",
"Logical Network.boston.router", PRGC_NIL);
若要获取所有统计量,函数调用应为:
Oma_Ov_Reader_Iterator_Create (ov_reader_ptr, PRGC_NIL,
PRGC_NIL, PRGC_NIL);