Defines the Simulation runtime context data type. More...

#include <runtime_context.h>

Public Member Functions
	RuntimeContext ()=delete

	RuntimeContext (std::shared_ptr< const EventAggregator > bus, std::shared_ptr< const ModelInput > inputs, std::unique_ptr< Scenario > scenario)
	Initialises a new instance of the RuntimeContext class.

int	time_now () const noexcept
	Gets the current simulation time.

int	start_time () const noexcept
	Gets the experiment start time.

unsigned int	current_run () const noexcept
	Gets the experiment current run number.

int	sync_timeout_millis () const noexcept
	Gets the data synchronisation timeout in milliseconds.

Population &	population () noexcept
	Gets a reference to the virtual population container.

const Population &	population () const noexcept
	Gets a reference to the virtual population container.

RuntimeMetric &	metrics () noexcept
	Gets a reference to the runtime metrics container.

const ModelInput &	inputs () const noexcept
	Gets a reference to the model inputs definition.

Scenario &	scenario () const noexcept
	Gets a reference to the simulation scenario instance.

Random &	random () const noexcept
	Gets a reference to the engine random number generator.

const HierarchicalMapping &	mapping () const noexcept
	Gets a read-only reference to the hierarchical risk factors mapping.

const std::vector< core::DiseaseInfo > &	diseases () const noexcept
	Gets a read-only reference to the select diseases information.

const core::IntegerInterval &	age_range () const noexcept
	Gets a read-only reference to the population age range constraints.

const std::string &	identifier () const noexcept
	Gets the simulation identifier for outside world messages.

void	set_current_time (const int time_now) noexcept
	Sets the current simulation time value.

void	set_current_run (const unsigned int run_number) noexcept
	Sets the current simulation run number.

void	reset_population (std::size_t initial_pop_size)
	Resets the virtual population to an initial size, with only new individuals.

void	publish (std::unique_ptr< EventMessage > message) const noexcept
	Publishes a polymorphic new message to the outside world synchronously.

void	publish_async (std::unique_ptr< EventMessage > message) const noexcept
	Publishes a polymorphic new message to the outside world asynchronously.

Detailed Description

Defines the Simulation runtime context data type.

The context holds the simulation runtime information, including the virtual population, and expose to all modules via the API calls. Only one context instance exists per simulation instance for internal use only by the engine algorithm.

Constructor & Destructor Documentation

◆ RuntimeContext() [1/2]

hgps::RuntimeContext::RuntimeContext ( )

delete

◆ RuntimeContext() [2/2]

hgps::RuntimeContext::RuntimeContext	(	std::shared_ptr< const EventAggregator >	bus,
		std::shared_ptr< const ModelInput >	inputs,
		std::unique_ptr< Scenario >	scenario
	)

Initialises a new instance of the RuntimeContext class.

Parameters

bus	The message bus instance for communication with the outside world
inputs	The simulation model inputs
scenario	The scenario to simulate

Member Function Documentation

◆ age_range()

const core::IntegerInterval & hgps::RuntimeContext::age_range ( ) const

noexcept

Gets a read-only reference to the population age range constraints.

Returns: Allowed age range

Here is the caller graph for this function:

◆ current_run()

unsigned int hgps::RuntimeContext::current_run ( ) const

noexcept

Gets the experiment current run number.

Returns: Current run number

Here is the caller graph for this function:

◆ diseases()

const std::vector< core::DiseaseInfo > & hgps::RuntimeContext::diseases ( ) const

noexcept

Gets a read-only reference to the select diseases information.

Returns: Selected diseases

◆ identifier()

const std::string & hgps::RuntimeContext::identifier ( ) const

noexcept

Gets the simulation identifier for outside world messages.

Returns: Simulation identifier

Here is the caller graph for this function:

◆ inputs()

const ModelInput & hgps::RuntimeContext::inputs ( ) const

noexcept

Gets a reference to the model inputs definition.

Returns: The model inputs reference

Here is the caller graph for this function:

◆ mapping()

const HierarchicalMapping & hgps::RuntimeContext::mapping ( ) const

noexcept

Gets a read-only reference to the hierarchical risk factors mapping.

Returns: Risk factor mapping

Here is the caller graph for this function:

◆ metrics()

RuntimeMetric & hgps::RuntimeContext::metrics ( )

noexcept

Gets a reference to the runtime metrics container.

Returns: Runtime metrics

Here is the caller graph for this function:

◆ population() [1/2]

const Population & hgps::RuntimeContext::population ( ) const

noexcept

Gets a reference to the virtual population container.

Returns: Virtual population

◆ population() [2/2]

Population & hgps::RuntimeContext::population ( )

noexcept

Gets a reference to the virtual population container.

Returns: Virtual population

Here is the caller graph for this function:

◆ publish()

void hgps::RuntimeContext::publish ( std::unique_ptr< EventMessage > message ) const

noexcept

Publishes a polymorphic new message to the outside world synchronously.

Parameters

message The message instance to publish

Here is the caller graph for this function:

◆ publish_async()

void hgps::RuntimeContext::publish_async ( std::unique_ptr< EventMessage > message ) const

noexcept

Publishes a polymorphic new message to the outside world asynchronously.

Parameters

message The message instance to publish

◆ random()

Random & hgps::RuntimeContext::random ( ) const

noexcept

Gets a reference to the engine random number generator.

Returns: Random number generator

Here is the caller graph for this function:

◆ reset_population()

void hgps::RuntimeContext::reset_population ( std::size_t initial_pop_size )

Resets the virtual population to an initial size, with only new individuals.

Parameters

initial_pop_size Initial population size

◆ scenario()

Scenario & hgps::RuntimeContext::scenario ( ) const

noexcept

Gets a reference to the simulation scenario instance.

Returns: Experiment Scenario reference

Here is the caller graph for this function:

◆ set_current_run()

void hgps::RuntimeContext::set_current_run ( const unsigned int run_number )

noexcept

Sets the current simulation run number.

Parameters

run_number The new run number

◆ set_current_time()

void hgps::RuntimeContext::set_current_time ( const int time_now )

noexcept

Sets the current simulation time value.

Parameters

time_now The new simulation time

Here is the caller graph for this function:

◆ start_time()

int hgps::RuntimeContext::start_time ( ) const

noexcept

Gets the experiment start time.

Returns: Experiment start time

Here is the caller graph for this function:

◆ sync_timeout_millis()

int hgps::RuntimeContext::sync_timeout_millis ( ) const

noexcept

Gets the data synchronisation timeout in milliseconds.

Returns: Timeout in milliseconds

Here is the caller graph for this function:

◆ time_now()

int hgps::RuntimeContext::time_now ( ) const

noexcept

Gets the current simulation time.

Returns: Current simulation time

Here is the caller graph for this function:

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

HealthGPS/runtime_context.h
HealthGPS/runtime_context.cpp

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ RuntimeContext() [1/2]

◆ RuntimeContext() [2/2]

Member Function Documentation

◆ age_range()

◆ current_run()

◆ diseases()

◆ identifier()

◆ inputs()

◆ mapping()

◆ metrics()

◆ population() [1/2]

◆ population() [2/2]

◆ publish()

◆ publish_async()

◆ random()

◆ reset_population()

◆ scenario()

◆ set_current_run()

◆ set_current_time()

◆ start_time()

◆ sync_timeout_millis()

◆ time_now()