op_esys_interface_value_get()
摘要
从 esys 接口(或向量接口的指定元素)获取单个值。
语法
op_esys_interface_value_get (interface, value, index)
| 参数 | 类型 | 说明 |
|---|---|---|
interface |
Esys_Interface |
包含待读取值的 esys 接口的接口 ID 该 esys 接口可以是向量接口或非向量接口。可以通过 Topo 包和 Id 包中的若干内核过程(包括 op_topo_child() 和 op_id_from_name())以及 op_intrpt_esys_interface() 获取 esys 接口 ID。] |
value |
void* |
指向接收 esys 接口值的变量的指针 [该参数可以接受 C 语言原生任意数据类型的指针。变量必须已经分配,且类型必须与 esys 接口的类型一致。] |
index |
int |
包含待读取值的向量接口元素 [如果 esys 接口是向量接口,则该参数为必需;否则它仅作为占位符处理。] |
返回类型
int
指示操作是否成功完成的完成码。
OPC_ESYS_SUCCESS 表示操作成功。关于其余的完成码,参见表 53 “External System Completion Code Symbolic Constants“ 第 13 页。
示例
/* Obtain a value from the esys interface and append to value vector. */
/* Get interface_id which caused the interrupt. */
interface_id = op_intrpt_esys_interface ();
op_esys_interface_value_get (interface_id, &c, 0);
/* Append value to end of vector. */
op_vvec_value_set (vector, OPC_VVEC_VECTOR_END, c);
/* If all values have been retrieved, send acknowledgment. */
if (op_vvec_size (vector) == 64)
{
op_esys_interface_value_set (ack_interface, op_sim_time (), '1');
}
详情
该过程从 esys 接口获取单个值并将其放入变量。esys 接口(对于向量接口则为相应元素)的值不受影响。esys 接口的数据类型必须与目标变量的数据类型一致,对应关系如下:
| Esys 接口类型 | 变量数据类型 |
|---|---|
integer |
int |
double |
double |
string |
char[] |
boolean |
int |
stdlogic |
char |
bit |
char |
character |
char |
pointer |
void * |
undefined |
char[] |
用途
提供一种将 esys 接口的值复制到变量的机制。
错误
- 程序中止:段违例。(由于目标值参数无效)
- 可恢复错误:接口句柄无效。
- 可恢复错误:试图从 esys 输出接口(
<name>)获取值。 - 可恢复错误:使用无效索引(
<index>)试图从向量接口(<name>)获取值。
参考
- 使用内核过程 op_intrpt_esys_interface() 获取某个 esys 接口的接口 ID
- 使用内核过程 op_esys_interface_value_set() 向 esys 接口写入单个值
- 使用内核过程 op_esys_interface_array_get() 将向量接口中的元素放入已有数组
- 使用内核过程 op_esys_interface_vector_get() 将向量接口中的元素放入值向量