op_prg_log_handle_create()
摘要
返回一个可用于引用 DES 日志的句柄。
语法
op_prg_log_handle_create (category, class_name, subclass, incident_limit)
| 参数 | 类型 | 说明 |
|---|---|---|
category |
Log_Category |
要与新日志句柄关联的日志条目类型(见详情)。 |
class_name |
const char* |
描述该句柄日志条目类别的字符串 该字符串的含义与内容由你自行定义。 |
subclass |
const char* |
描述该句柄条目子类别的字符串 该字符串的含义与内容由你自行定义。 |
incident_limit |
unsigned int |
该句柄允许的独立日志条目最大数量(见详情)。 |
返回类型
Log_Handle
可用于调用其他 op_prg_log… 内核过程的日志句柄。
示例
摘自 models/std/atm 目录中的 ams_atm_notif_log_support_v2.ex.c。
if (atm_notif_log_initialized == OPC_FALSE)
{
/* Set flag to prevent re-initialization. */
atm_notif_log_initialized = OPC_TRUE;
...
/* Configuration related notification handles. */
atm_conf_log_handle = op_prg_log_handle_create
(OpC_Log_Category_Configuration, "ATM", "Setup", atm_conf_log_limit);
atm_invalid_dest_conf_log_handle = op_prg_log_handle_create
(OpC_Log_Category_Configuration, "ATM", "Setup", atm_conf_log_limit);
...
}
详情
创建离散事件仿真(DES)日志时,每种要使用的日志条目类别都需要一个日志句柄。category 的数据类型及定义值如下:
Log_Category
OpC_Log_Category_ConfigurationOpC_Log_Category_ProtocolOpC_Log_Category_LowlevelOpC_Log_Category_ResultsOpC_Log_Category_Unknown
注意: Unknown 类别会在 DES 日志中产生一条空白条目。
你应当使用 class_name 和 subclass 参数,结合具体建模项目进一步细化这些类别的含义。如果日志句柄收到多条完全相同的日志条目,它会逐条分别报告,直到已报告 incident_limit 条为止。此后,它会跟踪该条目被记录的次数,并在仿真结束时以单条日志条目报告其出现次数。
新创建的句柄的严重级别为 PrgC_Log_Severity_Notice。你可以在写入日志之前使用 op_prg_log_handle_severity_set() 更改严重级别。
用途
提供创建日志句柄的机制,用于写入 DES 日志条目。
错误
- 不捕获任何错误。