op_ima_obj_selfdesc_characteristic_get()
摘要
获取节点、链路、路径或需求模型的自描述信息。
语法
op_ima_obj_selfdesc_characteristic_get (objid, characteristic_name, max_characteristic_len, value_ptr, type_ptr)
| 参数 | 类型 | 说明 |
|---|---|---|
objid |
Objid |
目标对象的对象 ID |
characteristic_name |
const char * |
要获取的特征名称。 |
max_characteristic_len |
int |
可用于存放所返回特征值的缓冲区长度 |
value_ptr |
char * |
指向待填入所请求特征值的缓冲区的指针 |
type_ptr |
OpT_Sim_Selfdesc_Characteristic_Type * |
指向待填入与所请求特征对应的比较器的存储区域的指针。参见详情。 |
返回类型
Compcode
若能够获取指定特征则为 OPC_COMPCODE_SUCCESS;否则为 OPC_COMPCODE_FAILURE。
示例
char vendor [256];
OpT_Sim_Selfdesc_Characteristic_Type type;
if (op_ima_obj_selfdesc_characteristic_get (node_objid, "vendor", sizeof (vendor),
vendor, &type) == OPC_COMPCODE_SUCCESS)
{
printf ("Node's vendor is (%s)\n", vendor);
}
详情
type_ptr 是在拓扑导入过程中用于将模型的特征值与导入对象的特征值进行匹配的比较器。它可以是以下符号常量之一:
OPC_SELFDESC_CHARACTERISTIC_EQUALOPC_SELFDESC_CHARACTERISTIC_ONEOFOPC_SELFDESC_CHARACTERISTIC_RANGEOPC_SELFDESC_CHARACTERISTIC_CONTAINS
注意: 本 KP 仅在仿真时刻 0 有效。此后,所有自描述信息都将从内存中清除。
用途
本函数获取关于对象的通用自描述信息。你可以利用本函数基于对象的特定自描述特征执行自定义处理。例如,进程模型可以利用本函数获取某个节点实例的自描述信息,然后对该节点执行与厂商相关的操作。
错误
- 可恢复错误:对象 ID(
<objid>)超出范围。 - 可恢复错误:对象 ID(
<objid>)指向受限对象。 - 可恢复错误:对象(
<objid>)类型不正确(<type>);应为节点、链路、路径或需求对象。
参考
- 使用 KP op_id_self() 可获取所在进程或队列的对象 ID
- 使用 KP op_id_from_name() 可获取任意对象的对象 ID