hgps::AnalysisModule Class Reference

Implements the burden of diseases (BoD) analysis module. More...

#include <analysis_module.h>

Inheritance diagram for hgps::AnalysisModule:

Collaboration diagram for hgps::AnalysisModule:

Public Member Functions
	AnalysisModule ()=delete
	AnalysisModule (AnalysisDefinition &&definition, WeightModel &&classifier, const core::IntegerInterval age_range, unsigned int comorbidities)
	Initialises a new instance of the AnalysisModule class. More...
SimulationModuleType	type () const noexcept override
	Gets the module type identifier. More...
const std::string &	name () const noexcept override
	Gets the module name. More...
void	initialise_population (RuntimeContext &context) override
	Initialises the virtual population. More...
void	update_population (RuntimeContext &context) override
	Updates the virtual population status. More...
Public Member Functions inherited from hgps::SimulationModule
virtual	~SimulationModule ()=default
	Destroys a SimulationModule instance. More...

Detailed Description

Implements the burden of diseases (BoD) analysis module.

Constructor & Destructor Documentation

AnalysisModule() [1/2]

hgps::AnalysisModule::AnalysisModule ( )

delete

AnalysisModule() [2/2]

hgps::AnalysisModule::AnalysisModule	(	AnalysisDefinition &&	definition,
		WeightModel &&	classifier,
		const core::IntegerInterval	age_range,
		unsigned int	comorbidities
	)

Initialises a new instance of the AnalysisModule class.

Parameters

definition	The analysis module definition
classifier	Body weight classifier model instance
age_range	The experiment valid age range
comorbidities	Maximum number of comorbidities to include

Member Function Documentation

initialise_population()

void hgps::AnalysisModule::initialise_population ( RuntimeContext &  context )

overridevirtual

Initialises the virtual population.

Parameters

context

The simulation shared runtime context instance

Implements hgps::SimulationModule.

Here is the call graph for this function:

name()

const std::string & hgps::AnalysisModule::name ( ) const

overridevirtualnoexcept

Gets the module name.

Returns

The human-readable module name

Implements hgps::SimulationModule.

type()

SimulationModuleType hgps::AnalysisModule::type ( ) const

overridevirtualnoexcept

Gets the module type identifier.

Returns

The module type identifier

Implements hgps::SimulationModule.

update_population()

void hgps::AnalysisModule::update_population ( RuntimeContext &  context )

overridevirtual

Updates the virtual population status.

Parameters

context

The simulation run-time context

Implements hgps::UpdatableModule.

---

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

• HealthGPS/analysis_module.h
• HealthGPS/analysis_module.cpp