hgps::Simulation Class Reference

Defines the simulation class interface. More...

#include <simulation.h>

Inheritance diagram for hgps::Simulation:

Collaboration diagram for hgps::Simulation:

Public Member Functions
	Simulation ()=delete
	Simulation (SimulationDefinition &&definition)
	Initialises a new instance of the Simulation class. More...
virtual	~Simulation ()=default
	Destroys a simulation instance. More...
virtual void	initialize ()=0
	Initialises the simulation experiment. More...
virtual void	terminate ()=0
	Terminates the simulation experiment. More...
virtual void	setup_run (const unsigned int run_number) noexcept=0
	Set-up a new simulation run with default seed. More...
virtual void	setup_run (const unsigned int run_number, const unsigned int run_seed) noexcept=0
	Set-up a new simulation run. More...
ScenarioType	type () noexcept
	Gets the simulation type. More...
std::string	name () override
	Gets the simulation name. More...

Protected Attributes
SimulationDefinition	definition_

Detailed Description

Defines the simulation class interface.

Constructor & Destructor Documentation

Simulation() [1/2]

hgps::Simulation::Simulation ( )

delete

Simulation() [2/2]

hgps::Simulation::Simulation ( SimulationDefinition &&  definition )

inlineexplicit

Initialises a new instance of the Simulation class.

Parameters

definition

The simulation configuration

~Simulation()

virtual hgps::Simulation::~Simulation ( )

virtualdefault

Destroys a simulation instance.

Member Function Documentation

initialize()

virtual void hgps::Simulation::initialize ( )

pure virtual

Initialises the simulation experiment.

Implemented in hgps::HealthGPS.

name()

std::string hgps::Simulation::name ( )

inlineoverride

Gets the simulation name.

Returns

The intervention scenario name

Here is the call graph for this function:

Here is the caller graph for this function:

setup_run() [1/2]

virtual void hgps::Simulation::setup_run ( const unsigned int  run_number )

pure virtualnoexcept

Set-up a new simulation run with default seed.

Parameters

run_number

The run number

Implemented in hgps::HealthGPS.

setup_run() [2/2]

virtual void hgps::Simulation::setup_run ( const unsigned int  run_number, const unsigned int  run_seed  )

pure virtualnoexcept

Set-up a new simulation run.

Parameters

run_number	The run number
run_seed	The custom seed for random number generation

Implemented in hgps::HealthGPS.

terminate()

virtual void hgps::Simulation::terminate ( )

pure virtual

Terminates the simulation experiment.

Implemented in hgps::HealthGPS.

type()

ScenarioType hgps::Simulation::type ( )

inlinenoexcept

Gets the simulation type.

Returns

The intervention scenario type enumeration

Here is the call graph for this function:

Member Data Documentation

definition_

SimulationDefinition hgps::Simulation::definition_

protected

---

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

• HealthGPS/simulation.h