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.
	AnalysisModule (AnalysisDefinition &&definition, WeightModel &&classifier, core::IntegerInterval age_range, unsigned int comorbidities, std::vector< double > calculated_factors)
	Initialises a new instance of the AnalysisModule class.
SimulationModuleType	type () const noexcept override
	Gets the module type identifier.
const std::string &	name () const noexcept override
	Gets the module name.
void	initialise_population (RuntimeContext &context) override
	Initialises the virtual population.
void	update_population (RuntimeContext &context) override
	Updates the virtual population status.
void	set_income_analysis_enabled (bool enabled) noexcept
	Sets whether income-based analysis is enabled.
void	set_individual_id_tracking_config (std::optional< hgps::input::IndividualIdTrackingConfig > config) noexcept
	MAHIMA: Sets optional individual ID tracking config for per-person CSV output.
Public Member Functions inherited from hgps::SimulationModule
virtual	~SimulationModule ()=default
	Destroys a SimulationModule instance.

Static Public Member Functions
static std::vector< core::Income >	get_available_income_categories (RuntimeContext &context)
	Gets available income categories from the runtime context (for tests and callers).
static std::string	income_category_to_string (core::Income income)
	Converts income category enum to string representation (for tests and callers).

Detailed Description

Implements the burden of diseases (BoD) analysis module.

Constructor & Destructor Documentation

AnalysisModule() [1/3]

hgps::AnalysisModule::AnalysisModule ( )

delete

AnalysisModule() [2/3]

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

AnalysisModule() [3/3]

hgps::AnalysisModule::AnalysisModule	(	AnalysisDefinition &&	definition,
		WeightModel &&	classifier,
		core::IntegerInterval	age_range,
		unsigned int	comorbidities,
		std::vector< double >	calculated_factors
	)

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
calculated_factors	The calculated factors to include

Member Function Documentation

get_available_income_categories()

std::vector< core::Income > hgps::AnalysisModule::get_available_income_categories ( RuntimeContext &  context )

static

Gets available income categories from the runtime context (for tests and callers).

Here is the call graph for this function:

income_category_to_string()

std::string hgps::AnalysisModule::income_category_to_string ( core::Income  income )

static

Converts income category enum to string representation (for tests and callers).

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.

set_income_analysis_enabled()

void hgps::AnalysisModule::set_income_analysis_enabled ( bool  enabled )

noexcept

Sets whether income-based analysis is enabled.

Parameters

enabled

true to enable income analysis, false to disable

set_individual_id_tracking_config()

void hgps::AnalysisModule::set_individual_id_tracking_config ( std::optional< hgps::input::IndividualIdTrackingConfig >  config )

noexcept

MAHIMA: Sets optional individual ID tracking config for per-person CSV output.

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