ResultSimulation< M > Class Template Reference

CPP API: mio::abm::ResultSimulation< M > Class Template Reference
mio::abm::ResultSimulation< M > Class Template Reference

Simulation holding its own History to provide a get_result member. Can be used for a ParameterStudy. More...

#include <result_simulation.h>

Inheritance diagram for mio::abm::ResultSimulation< M >:
Collaboration diagram for mio::abm::ResultSimulation< M >:

Public Types

using Model = M
 
- Public Types inherited from mio::abm::Simulation< Model >
using Model = Model
 

Public Member Functions

void advance (TimePoint tmax)
 Run the simulation until the given time point. More...
 
const mio::TimeSeries< double > & get_result () const
 Return the simulation result aggregated by infection states. More...
 
 ResultSimulation (Model &&m, TimePoint t)
 Create a simulation, moving the model. More...
 
- Public Member Functions inherited from mio::abm::Simulation< Model >
void advance (TimePoint tmax, History &... history)
 Run the Simulation from the current time to tmax. More...
 
Modelget_model ()
 Get the Model that this Simulation evolves. More...
 
const Modelget_model () const
 
TimePoint get_time () const
 Get the current time of the Simulation. More...
 
 Simulation (TimePoint t0, Model &&model)
 Create a simulation. More...
 
 Simulation (TimePoint t0, size_t num_agegroups)
 Create a Simulation with an empty Model. More...
 

Public Attributes

mio::History< TimeSeriesWriter, LogInfectionStatehistory
 History used to create the result TimeSeries. More...
 

Detailed Description

template<class M = Model>
class mio::abm::ResultSimulation< M >

Simulation holding its own History to provide a get_result member. Can be used for a ParameterStudy.

Member Typedef Documentation

◆ Model

template<class M = Model>
using mio::abm::ResultSimulation< M >::Model = M

Constructor & Destructor Documentation

◆ ResultSimulation()

template<class M = Model>
mio::abm::ResultSimulation< M >::ResultSimulation ( Model &&  m,
TimePoint  t 
)
inline

Create a simulation, moving the model.

Member Function Documentation

◆ advance()

template<class M = Model>
void mio::abm::ResultSimulation< M >::advance ( TimePoint  tmax)
inline

Run the simulation until the given time point.

Parameters
tmaxFinal time point for the simualtion.

◆ get_result()

template<class M = Model>
const mio::TimeSeries<double>& mio::abm::ResultSimulation< M >::get_result ( ) const
inline

Return the simulation result aggregated by infection states.

Member Data Documentation

◆ history

Initial value:

History used to create the result TimeSeries.