EtsT_Pj_Simulation_Update_Callback
Note: Requires OPNET Development Kit
Abstract
Callback: Called whenever a simulation status update message is generated.
Syntax
<simulation_update_callback_name> (client_state_ptr, message_type, message_tlptr, elapsed_time, remaining_time)
| Argument | Type | Description |
|---|---|---|
client_state_ptr |
void * |
State information specified by the client when the callback was registered. |
message_type |
EtsT_Pj_Simulation_Message_Type |
Reason for the update message; one of the simulation message types given in Table 36 Project Package Symbolic Constants. |
message_tlptr |
PrgT_List * |
Text list containing the update message generated by op_runsim, or PRGC_NIL when message_type is EtsC_Pj_Simulation_Message_Update. |
elapsed_time |
double |
Amount of simulation time that has elapsed (when message_type is EtsC_Pj_Simulation_Message_Update; 0.0 for all other message types). |
remaining_time |
double |
Time remaining until the simulation completes (when message_type is EtsC_Pj_Simulation_Message_Update; 0.0 for all other message types). |
Return Type
void
No return value.
Header
ets_api_pj.h
Details
This callback gives access to the simulation update messages generated by op_runsim. It can be used to perform needed processing when particular simulation events occur (for example, when the simulation is paused or when it completes).
This callback is registered by Ets_Pj_Simulation_Update_Callback_Register().