Class simulation_framework::core::time::IClock
Last update: 22.04.2026
Definition: core/time/i_clock/i_clock.h (line 40)
Interface for managing and manipulating simulation time.
The IClock class provides a generic interface for handling simulation time. It allows setting the current simulation time, retrieving it in different formats, and incrementing time by a specified duration.
This interface is particularly useful in simulations where time needs to be controlled programmatically rather than relying on real-world time progression.
Inherited by:
Members
Public functions
Function ~IClock
virtual simulation_framework::core::time::IClock::~IClock()=default
Virtual destructor.
Ensures proper cleanup of derived classes.
Return type:
Function SetNow
virtual void simulation_framework::core::time::IClock::SetNow(const milliseconds &ms)=0
Sets the current simulation time.
This method allows setting the simulation's current time to a specific duration from the epoch (0 milliseconds).
Parameters:
- ms: The time to set, represented as milliseconds from the epoch.
Parameters:
- const milliseconds & ms
Return type: void
Reimplemented by:
Function SetNow
virtual void simulation_framework::core::time::IClock::SetNow(const Timestamp ×tamp)=0
Sets the current simulation time using a timestamp.
This method sets the simulation's current time to a specific point in time, represented as a Timestamp object.
Parameters:
- timestamp: The point in time to set as the current simulation time.
Parameters:
- const Timestamp & timestamp
Return type: void
Reimplemented by:
Function GetNow
virtual milliseconds simulation_framework::core::time::IClock::GetNow() const =0
Gets the current simulation time in milliseconds.
This method returns the current simulation time as a duration measured in milliseconds since the epoch (0 milliseconds).
Returns:
The current simulation time as a milliseconds object.
Return type: milliseconds
Reimplemented by:
Function GetNowAsTimestamp
virtual Timestamp simulation_framework::core::time::IClock::GetNowAsTimestamp() const =0
Gets the current simulation time as a timestamp.
This method returns the current simulation time as a Timestamp object, providing a more precise representation of the current point in time.
Returns:
The current simulation time as a Timestamp object.
Return type: Timestamp
Reimplemented by:
Function IncrementBy
virtual void simulation_framework::core::time::IClock::IncrementBy(const milliseconds &ms)=0
Increments the simulation time by a specified duration.
This method adds the given duration (in milliseconds) to the current simulation time. It is useful for progressing the simulation clock in a controlled manner.
Parameters:
- ms: The duration to add to the current simulation time.
Parameters:
- const milliseconds & ms
Return type: void
Reimplemented by:
