您好,欢迎访问三七文档
OPNET核心函数集(目录)包函数集:......................................................................2统计量函数集..................................................................4中断处理函数集..............................................................5ICI接口控制信息函数集...............................................6鉴定函数集......................................................................7拓扑函数集......................................................................7内部模型访问函数集......................................................9分布函数集....................................................................10进程函数集....................................................................11事件函数集....................................................................12仿真函数集....................................................................12包函数集1op_pk_create_fmt()作用:创建一个具有预定义的特定的包格式的包。语法:op_pk_create_fmt(format_name)参数类型描述format_nameconstchar*包格式的文件名(在包格式编辑器中创建并保存的.pk.m文件名)返回值:Packet*指向新创建的包的一个指针。如果发生可恢复的错误,返回OPC_NIL符号常量。2op_pk_copy()作用:创建指定包的新复制包。语法:op_pk_copy(pkptr)参数类型描述pkptrPacket*指向原始包的指针返回值:Packet*指向新复制的包的指针。3op_pk_destroy()作用:销毁指定的包,并释放其内存资源。语法:op_pk_destroy(pkptr)参数类型描述pkptrPacket*指向需要被销毁的包的指针返回值:void无返回值4op_pk_get()作用:获取到达输入包流的包的指针,并将其从流中移除。语法:op_pk_get(instrm_index)参数类型描述instrm_indexint所属模块输入包流的索引号,一般可以通过op_intrpt_strm()获取这个索引号返回值:Packet*指向从输入包流中移除的包(也就是获取的包)的指针。如果流中无包,返回OPC_NIL。可以首先通过函数op_strm_empty()来确定流中是否有包存在。5op_pk_send()作用:将指定的包发送到输出包流中去;基于当前仿真时间安排包到达某个目的模块的时间;并释放调用进程对包的所有权。语法:op_pk_send(pkptr,outstrm_index)参数类型描述pkptrPacket*指向将要被发送的包的指针outstrm_indexint所属模块输出流的索引号返回值:void无返回值6op_pk_send_delayed()作用:将指定包发送到输出包流中去;基于一段延时的仿真时间后,安排包到达目的模块的时间;并释放调用对包的所有权。语法:op_pk_send_delayed(pkptr,outstrm_index,delay)参数类型描述pkptrPacket*指向将被发送的包的指针outstrm_indexint所属模块输出流的索引号delaydouble设置包到达的延时(=0)返回值:void无返回值7op_pk_nfd_set()作用:给指定包的某个字段赋值,该字段由其名称确定,所赋的值只能是int,double和包字段三种。(封装)语法:op_pk_nfd_set(pkptr,fd_name,value)参数类型描述pkptrPacket*指向给定包的指针fd_nameconstchar*字段名称valuevoid*所赋到字段中的的值(只能是int和double和包指针)返回值:Compcode如果指定字段成功赋予新值,返回完成代码。如果发生可恢复错误,则返回OPC_COMPCODE_FAILURE。NOTE:有格式的包的格式在包格式编辑器中编辑,每个包域都有名称。通过名称进行包域操作的包函数具有前缀op_pk_nfd_type。还有一些相关的函数为:op_pk_nfd_set_type,type=dbl,info,int32,int64,objid,pkid,pkt,ptr其中type的内容不同。8op_pk_nfd_get()作用:获取给定包中某字段的值。将字段类型状态改为“unset”,根据名称确定字段。(解封装)语法:op_pk_nfd_get(pkptr,fd_name,value_ptr)参数类型描述pkptrPacket*指向给定包的指针fd_nameconstchar*字段的名称value_ptrvoid*指向存放指定字段地址的指针返回值:compcode确认操作是否成功的代码,若发生错误,则返回OPC_COMPCODE_FAILURE。9op_pk_creation_time_get()作用:获取包创建时的仿真时间。语法:op_pk_creation_time_get(pkptr)参数类型描述pkptrPacket*指向相关包的指针返回值:double返回包创建时的仿真时间。10op_pk_total_size_get()作用:获取包的总大小。语法:op_pk_total_size_get(pkptr)参数类型描述pkptrPacket*指向相关包的指针返回值:OpT_Packet_Size返回包的总大小(bit)11op_subq_pk_insert()作用:将包插入到给定子队列的指定位置。语法:op_subq_pk_insert(subq_index,pkptr,pos_index)参数类型描述subq_indexint给定子队列的索引(从0开始)pkptrPacket*指向给定包的指针pos_indexint子队列中包应该插入的位置索引返回值:int表明插入是否成功的插入代码。返回的为符合常量:OPC_QINS_OK,OPC_QINS_FAIL,OPC_QINS_PK_ERROR,OPC_QINS_SEL_ERROR12op_subq_pk_remove()作用:获取包在子队列中的位置指针,并将其从子队列中移除。语法:op_subq_pk_remove(subq_index,pos_index)参数类型描述subq_indexint相关子队列的索引pos_indexint子队列中需要移除的包所在位置的索引号返回值:Packet*从给定子队列中移除的包指针,如果发生可恢复错误,则返回OPC_NIL统计量函数集1.op_stat_reg()作用:返回从进程模型中的节点或模块统计量(局部或全局)的句柄。语法:op_stat_reg(stat_name,stat_index,type)参数类型描述group_dot_stat_nameconstchar*统计量所在的组和名称,中间用“.”隔开stat_indexint统计量的数字索引,若为一维统计量,则为OPC_STAT_INDEX_NONEtypeintOPC_STAT_GLOBAL(全局变量)OPC_STAT_LOCAL(局部变量).返回值:Stathandle统计量句柄。可以在函数op_stat_write()和op_stat_write_t()中使用。2.op_stat_write()作用:将(时间,值)对写到指定统计量中,将写入的值通过参数传递给该函数,时间为当前仿真时间。语法:op_stat_write(stat_handle,value)参数类型描述stat_handleStathandle指定统计量的统计量句柄valuedouble指定统计量将要写入的值返回值:void无返回值中断处理函数集1.op_intrpt_schedule_self()作用:为调用进程预设一个中断。语法:op_intrpt_schedule_self(time,code)参数类型描述timedouble预设的中断时间(该值为绝对仿真时间,而不是当前仿真时间的时延)codeint与中断关联的用户自定义数值代码(该值完全由用户自定义的整数值,可作为预设中断的标识代码。当中断调用进程时,可通过函数op_intrpt_code()获取该代码返回值:Evhandle预设中断的事件句柄。该返回值可存储在一个状态变量中,以用于以后调用函数op_ev_cancel()时取消中断。2.op_intrpt_schedule_remote()作用:在指定的时间,为给定处理器或队列预设一个远程中断。语法:op_intrpt_schedule_remote(time,code,mod_objid)参数类型描述timedouble预设的中断时间codeint与中断相关的用户自定义数值代码mod_objidObjid给定处理器或队列的对象ID(处理器或队列的ID可通过id函数集op_id_self(),op_topo_child(),andop_id_from_name()函数获取返回值:Evhandle预设中断的事件句柄。3.op_intrpt_type()作用:获取调用进程的当前中断的类型。语法:op_intrpt_type()参数类型描述noargument没有参数返回值:int当前中断类型4.op_intrpt_strm()作用:获取与当前调用进程中断相关联的流索引语法:op_intrpt_strm()参数类型描述noargument没有参数返回值:int与当前中断相关联的流索引5.op_intrpt_ici()作用:获取与当前中断相关的ICI(interfacecontrolinformation)语法:op_intrpt_ici()参数类型描述noargument没有参数返回值:Ici*指向与当前中断相关联的ICI的指针。当没有与调用进程的当前中断相关联的ICI时,返回符号常量OPC_NIL。6.op_intrpt_code()作用:获取调用进程当前中断相关联的数值代码。语法:op_intrpt_code()参数类型描述noargument没有参数返回值:int返回与当前中断相关联的数值代码(这个值是用户自定义的整数值;当获得一个中断通过op_intrpt_schedule_self(),op_intrpt_schedule_remote(),op_intrpt_force_remote()时,也可以提供这个整数值。)ICI接口控制信息函数集1.op_ici_create()作用:创建一个具有预定义ICI格式的ICI。语法:op_ici_create(fmt_name)参数类型描述fmt_nameconstchar*被创建ICI的格式名称(该值必须为已定义的ICI格式名称)返回值:Ici*指向新创建的ICI的指针。若发生可恢复错误,则返回常量OPC_NIL。2.op_ici_destroy()作用:解除已分配的ICI,并释放相应的内存资源。语法:op_ici_destroy(iciptr)参数类型描述iciptrIci*指向给定ICI的指针(
本文标题:常用核心函数库
链接地址:https://www.777doc.com/doc-3788728 .html