sumo-integrator  0.4.0-alpha4+201812051700
sumo-integrator is a C++ static library that provides abstract integration tools geared towards connecting SUMO with a (any) graphic engine(s).
Public Member Functions | List of all members
sumointegrator::Sumo::Simulation Class Reference

Exposes facilities related to SUMO's simulation. More...

#include <include/sumo-integrator/core/Simulation.h>

Public Member Functions

void tick ()
 Run a step of SUMO's simulation. More...
 
void tick (const double)
 Run SUMO's simulation up to a given time. More...
 

Detailed Description

Exposes facilities related to SUMO's simulation.

Author
Mattia Affabris - matti.nosp@m.a.af.nosp@m.fabri.nosp@m.s@an.nosp@m.temot.nosp@m.ion..nosp@m.com
Date
2018-11-26
2018-11-29
Version
0.4.0-alpha4
2
Copyright
Copyright (C) (2018) AnteMotion

Handles anything related to managing SUMO's simulation.

Note
May only be accessed as a pointer member class of sumointegrator::Sumo (sumointegrator::Sumo::simulation).

Inherits sumointegrator::Sumo::Concern.

Member Function Documentation

◆ tick() [1/2]

void sumointegrator::Sumo::Simulation::tick ( )

Run a step of SUMO's simulation.

The length of the time simulated in the step depends on the value passed to SUMO with its --step-length option.

Note
SUMO halts its simulation until this method is called.
Debug
DEBUG_DATA - Simulation tick.

◆ tick() [2/2]

void sumointegrator::Sumo::Simulation::tick ( const double  time)

Run SUMO's simulation up to a given time.

This is useful in an asynchronous environment, where the client runs independently from SUMO and sends/requests updates at variable intervals. The client may tick at its own rate, and sync up only when needed by signalling SUMO to step through its simulation up to the current time.

Note
SUMO ticks the appropriate amount of times based on the --step-length option.
Units
time seconds (s)
Parameters
[in]timeThe time up to which SUMO should run its simulation.
Debug
DEBUG_DATA - Simulation tick.
The documentation for this class was generated from the following files: