VIPRA Documentation
Loading...
Searching...
No Matches
VIPRA::Simulation Class Reference
Inheritance diagram for VIPRA::Simulation:
Collaboration diagram for VIPRA::Simulation:

Public Member Functions

 VIPRA_MODULE_NAME ("main")
 
 VIPRA_MODULE_TYPE (Simulation)
 
 VIPRA_REGISTER_PARAMS (VIPRA_PARAM("max_timestep", _maxTimestep), VIPRA_PARAM("timestep_size", _timestepSize), VIPRA_PARAM("output_frequency", _outputFrequency), VIPRA_PARAM("random_seed", _seed), VIPRA_PARAM("output_params", _outputParams))
 
void run_sim (Parameters &params)
 
void operator() (std::string const &pedPath, std::string const &mapPath, std::string const &paramsPath)
 Runs the simulation with the given parameters.
 
void set_install_dir (std::string const &dir)
 
void set_module (Modules::Type type, std::string const &name)
 
void set_modules (std::string const &modulesPath)
 
void reset_modules ()
 
void output_timings ()
 
void set_sim_id (VIPRA::idx idx)
 
void add_sim_id (VIPRA::idx idx)
 
auto get_sim_id () const -> VIPRA::idx
 
auto get_ped_input () -> Modules::PedestrianInput &
 
auto get_map_input () -> Modules::MapInput &
 
- Public Member Functions inherited from VIPRA::Modules::Module< Simulation >
void register_params (Parameters &paramIn)
 Registers the modules parameters with the parameter reader.
 
void config (Parameters &paramIn, VIPRA::Random::Engine &engine)
 Loads in all parameters for the module.
 

Member Function Documentation

◆ operator()()

void VIPRA::Simulation::operator() ( std::string const & pedPath,
std::string const & mapPath,
std::string const & paramsPath )

Runs the simulation with the given parameters.

Parameters
paramsparameter module to use for the simulation
Returns
output_data_t Tuple of the output data

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