hgps::DemographicModule Class Reference

Demographic prospects module interface. More...

#include <interfaces.h>

Inheritance diagram for hgps::DemographicModule:

Collaboration diagram for hgps::DemographicModule:

Public Member Functions
virtual std::size_t	get_total_population_size (int time_year) const noexcept=0
	Gets the total population at a specific point in time. More...
virtual const std::map< int, PopulationRecord > &	get_population_distribution (int time_year) const =0
	Gets the population age distribution at a specific point in time. More...
virtual void	update_population (RuntimeContext &context, const DiseaseHostModule &disease_host)=0
	Updates the virtual population status. More...
Public Member Functions inherited from hgps::SimulationModule
virtual	~SimulationModule ()=default
	Destroys a SimulationModule instance. More...
virtual SimulationModuleType	type () const noexcept=0
	Gets the module type identifier. More...
virtual const std::string &	name () const noexcept=0
	Gets the module name. More...
virtual void	initialise_population (RuntimeContext &context)=0
	Initialises the virtual population. More...

Detailed Description

Demographic prospects module interface.

Member Function Documentation

get_population_distribution()

virtual const std::map<int, PopulationRecord>& hgps::DemographicModule::get_population_distribution ( int  time_year ) const

pure virtual

Gets the population age distribution at a specific point in time.

Parameters

time_year

The reference point in time (in year)

Returns

The respective population age distribution

Implemented in hgps::PopulationModule.

get_total_population_size()

virtual std::size_t hgps::DemographicModule::get_total_population_size ( int  time_year ) const

pure virtualnoexcept

Gets the total population at a specific point in time.

Parameters

time_year

The reference point in time (in year)

Returns

The respective total population size

Implemented in hgps::PopulationModule.

update_population()

virtual void hgps::DemographicModule::update_population ( RuntimeContext &  context, const DiseaseHostModule &  disease_host  )

pure virtual

Updates the virtual population status.

Parameters

context	The simulation run-time context
disease_host	The diseases host module instance

Implemented in hgps::PopulationModule.

---

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

• HealthGPS/interfaces.h