op_pk_creation_mod_set()
Abstract
Changes the object ID that specifies the creation module of a packet.
Syntax
op_pk_creation_mod_set (pkptr, objid)
| Argument | Type | Description |
|---|---|---|
pkptr |
Packet* |
pointer to the packet-of-interest [A pointer to a packet can be obtained from many KPs, including op_pk_create(), op_pk_create_fmt(), op_pk_copy(), op_pk_get(), op_subq_pk_access(), and op_subq_pk_remove().] |
objid |
Objid |
new creation module ID, or OPC_OBJID_UNIVERSAL |
Return Type
Compcode
Completion code indicating if the change was successful.
If successful, this KP returns the value OPC_COMPCODE_SUCCESS; OPC_COMPCODE_FAILURE otherwise.
Example
/* declarations */
Packet *uf_pkptr;
/* create an unformatted packet */
uf_pkptr = op_pk_create (64);
/* set the object ID of packet’s creation module */
op_pk_creation_mod_set (uf_pkptr, op_id_self());
Details
A process model invoking this function must own the packet to be changed; non-process model code can use this function for any packet.
Purpose
Provides a way for cosimulations to reset the creation module for packets converted from value vector representation.
Errors
- Program Abort: Segmentation violation. (due to an invalid packet pointer or malformed packet)
- Program Abort: Packet pointer is NIL.
- Program Abort: Packet pointer references destroyed packet.
- Program Abort: Packet pointer references unowned packet (
<pk_id>). - Program Abort: Only modules can be set as packet creator. Objid (
<objid>) is<type>.
Reference
- Use the KP op_topo_parent() to convert a module object ID to the surrounding node’s object ID
- Use the KP op_pk_stamp() to stamp a packet with the current module and simulation time
- Use the KPs op_pk_stamp_mod_get() and op_pk_stamp_time_get() to obtain the module object ID and simulation time from a packet’s stamp
- Use the KP op_pk_id() to obtain the unique ID of a packet