Non-Confidential | ![]() | 101196_0100_03_en | ||
| ||||
Home > Iris APIs > Simulation time execution control API > Event source IRIS_SIMULATION_TIME_EVENT |
This event is emitted when the simulation time starts or stops progressing. It gives the reason why simulation time stopped. It is provided by the framework.SimulationEngine
instance, not by individual instances.
Table 5-8 Event source IRIS_SIMULATION_TIME_EVENT
Field | Type | Description | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
TICKS |
NumberU64 |
Current simulation time in ticks. One tick is
1/TICK_HZ seconds long. The elapsed simulation
time is TICKS /TICK_HZ
seconds. |
||||||||||||||
TICK_HZ |
NumberU64 |
Time resolution of the TICKS value in Hz. For example, 1000 means that 1 tick
= 1ms. |
||||||||||||||
RUNNING |
Boolean |
True if and only if the simulation is running, else False. Note:This information might already be out of date when the callback is received. When multiple simulation controllers start and stop the simulation, for example if multiple debuggers are connected, there is no way to reliably know whether the simulation is currently running or stopped. In this case, this field is only a hint. |
||||||||||||||
REASON |
NumberU64 |
Optional. This field is only present when the simulation is
stopped, in other words, when
All other bits are reserved and must be zero. |
||||||||||||||
INST_ID |
NumberU64 |
Optional. If available, this contains the instance id that originally caused the simulation time event. |