hgps::Settings Class Reference

Defines the simulation experiment settings data type. More...

#include <settings.h>

Public Member Functions
	Settings (const core::Country &country, const float size_fraction, const core::IntegerInterval &age_range)
	Initialises a new instance of the Settings class. More...
const core::Country &	country () const noexcept
	Gets the experiment target country information. More...
const float &	size_fraction () const noexcept
	The virtual population fraction from the real population size in range (0, 1]. More...
const core::IntegerInterval &	age_range () const noexcept
	The experiment population age range constraint. More...

Detailed Description

Defines the simulation experiment settings data type.

Constructor & Destructor Documentation

Settings()

hgps::Settings::Settings	(	const core::Country &	country,
		const float	size_fraction,
		const core::IntegerInterval &	age_range
	)

Initialises a new instance of the Settings class.

Parameters

country	Target country population
size_fraction	Virtual population fraction of the real population
age_range	Allowed age range in the population

Exceptions

std::out_of_range

for size fraction value outside of the range (0, 1].

Member Function Documentation

age_range()

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

noexcept

The experiment population age range constraint.

Returns

The allowed age range

Here is the caller graph for this function:

country()

const core::Country & hgps::Settings::country ( ) const

noexcept

Gets the experiment target country information.

Returns

Country information

Here is the caller graph for this function:

size_fraction()

const float & hgps::Settings::size_fraction ( ) const

noexcept

The virtual population fraction from the real population size in range (0, 1].

Returns

The size fraction in range (0, 1]

---

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

• HealthGPS/settings.h
• HealthGPS/settings.cpp