SyDEVS  v0.6.5
Multiscale Simulation and Systems Modeling Library
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
sydevs::systems::real_time_buffer Class Reference

A data structure which suggests event wallclock times to aid in the synchronization of a simulation's execution. More...

#include <real_time_buffer.h>

Public Member Functions

 real_time_buffer (float64 t_adv_rate, int64 t_syn_rate)
 Constructs a real time buffer with the specified time advancement rate t_adv_rate and time synchronization rate t_syn_rate. More...
 
float64 time_advancement_rate () const
 Returns the time advancement rate. More...
 
float64 time_synchronization_rate () const
 Returns the time synchronization rate. More...
 
void update_time_advancement_rate (float64 t_adv_rate)
 Updates the time advancement rate and recomputes the planned wallclock time. More...
 
void update_time_synchronization_rate (float64 t_syn_rate)
 Updates the time synchonization rate and recomputes the planned wallclock time. More...
 
time_point synchronization_time () const
 Returns the simulated time of the synchronization reference point. More...
 
clock_time synchronization_clock_time () const
 Returns the wallclock time of the synchronization reference point. More...
 
void update_synchronization_time (const time_point &sim_t, const clock_time &clk_t)
 Updates the synchonization reference point and recomputes the planned wallclock time. More...
 
time_point current_time () const
 Returns the current simulated time. More...
 
clock_time current_clock_time () const
 Returns the current wallclock time. More...
 
void update_current_time (const time_point &sim_t, const clock_time &clk_t, duration planned_sim_dt)
 Updates the current time and the planned duration of simulated time until the planned event. More...
 
clock_time planned_clock_time () const
 Returns the recommended point in wallclock time of the planned event. More...
 

Detailed Description

A data structure which suggests event wallclock times to aid in the synchronization of a simulation's execution.

A real_time_buffer is continually updated with the current point in simulated time, the current point in wallclock time, and the planned duration of simulated time until the next planned event. It then recommends a planned wallclock time point for the future event, with the objective of eventually synchronizing simulated and wallclock time. The synchronization is based on a reference point in both simulated and wallclock time, as well as the time advancement rate.

The time advancement rate t_adv_rate is the intended ratio of a duration of simulated time to a corresponding duration of wallclock time. If the rate is 1, the objective is that the simulation proceed at exactly real time. If the rate is 2, the objective is to run the simulation twice as fast as real time. If the rate is 0.1, the objective is to run the simulation at one tenth the speed of real-world time.

The time synchronization rate t_syn_rate measures how aggressively the real time buffer will try to synchronize simulated and wallclock time. If the rate is large (i.e. much greater than 1), the objective is to rapidly bring simulated and wallclock time into alignment. If rate is small (i.e. considerably less than 1), the objective is to gradually and smoothly synchronize simulated and wallclock time and eventually bring them into alignment.

Constructor & Destructor Documentation

sydevs::systems::real_time_buffer::real_time_buffer ( float64  t_adv_rate,
int64  t_syn_rate 
)

Constructs a real time buffer with the specified time advancement rate t_adv_rate and time synchronization rate t_syn_rate.

Member Function Documentation

clock_time sydevs::systems::real_time_buffer::current_clock_time ( ) const
inline

Returns the current wallclock time.

time_point sydevs::systems::real_time_buffer::current_time ( ) const
inline

Returns the current simulated time.

clock_time sydevs::systems::real_time_buffer::planned_clock_time ( ) const
inline

Returns the recommended point in wallclock time of the planned event.

clock_time sydevs::systems::real_time_buffer::synchronization_clock_time ( ) const
inline

Returns the wallclock time of the synchronization reference point.

time_point sydevs::systems::real_time_buffer::synchronization_time ( ) const
inline

Returns the simulated time of the synchronization reference point.

float64 sydevs::systems::real_time_buffer::time_advancement_rate ( ) const
inline

Returns the time advancement rate.

float64 sydevs::systems::real_time_buffer::time_synchronization_rate ( ) const
inline

Returns the time synchronization rate.

void sydevs::systems::real_time_buffer::update_current_time ( const time_point sim_t,
const clock_time clk_t,
duration  planned_sim_dt 
)

Updates the current time and the planned duration of simulated time until the planned event.

void sydevs::systems::real_time_buffer::update_synchronization_time ( const time_point sim_t,
const clock_time clk_t 
)

Updates the synchonization reference point and recomputes the planned wallclock time.

void sydevs::systems::real_time_buffer::update_time_advancement_rate ( float64  t_adv_rate)

Updates the time advancement rate and recomputes the planned wallclock time.

void sydevs::systems::real_time_buffer::update_time_synchronization_rate ( float64  t_syn_rate)

Updates the time synchonization rate and recomputes the planned wallclock time.


The documentation for this class was generated from the following files: