op_pk_stamp_time_set()
Abstract
Sets the simulation time when the specified packet was last stamped.
Syntax
op_pk_stamp_time_set (pkptr, time)
| 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().] |
time |
double |
Simulation time to set. |
Return Type
Compcode
OPC_COMPCODE_SUCCESS if the change was successful; OPC_COMPCODE_FAILURE otherwise
Example
/* declarations */
Packet *uf_pkptr;
double stamp_time;
/* create an unformatted packet */
uf_pkptr = op_pk_create (64);
/* Set the stamp time for this packet */
op_pk_stamp_time_set (uf_pkptr, stamp_time);
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 simulation time when a packet was last stamped. Typically this KP is used in conjunction with the KP op_pk_stamp_mod_set() to set end-to-end delays with reference to different source locations.
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: Packet creation time (
<time>) must be positive and less than or equal to the simulation time (<current_sim_time>)
Reference
- Use the KP op_pk_stamp() to set a packet's stamp
- Use the KPs op_pk_creation_mod_get() and op_pk_creation_time_get() to obtain the module object ID and simulation time associated with a packet's creation
- Use the KP op_pk_id() to obtain the unique ID of a packet