hgps::EnergyBalanceHierarchicalModel Class Reference

Implements the dynamic hierarchical linear model (energy balance) type. More...

#include <energy_balance_hierarchical_model.h>

Inheritance diagram for hgps::EnergyBalanceHierarchicalModel:

Collaboration diagram for hgps::EnergyBalanceHierarchicalModel:

Public Member Functions
	EnergyBalanceHierarchicalModel (const std::map< core::IntegerInterval, AgeGroupGenderEquation > &equations, const std::map< core::Identifier, core::Identifier > &variables, const double boundary_percentage)
	Initialises a new instance of the EnergyBalanceHierarchicalModel class. More...
HierarchicalModelType	type () const noexcept override
	Gets the model type identifier. More...
std::string	name () const noexcept override
	Gets the model name. More...
void	generate_risk_factors (RuntimeContext &context) override
	Generates the initial risk factors for a population and newborns. More...
void	update_risk_factors (RuntimeContext &context) override
	Update risk factors for population. More...
Public Member Functions inherited from hgps::HierarchicalLinearModel
virtual	~HierarchicalLinearModel ()=default
	Destroys a HierarchicalLinearModel instance. More...

Detailed Description

Implements the dynamic hierarchical linear model (energy balance) type.

The dynamic model is used to advance the virtual population over time.

Constructor & Destructor Documentation

EnergyBalanceHierarchicalModel()

hgps::EnergyBalanceHierarchicalModel::EnergyBalanceHierarchicalModel	(	const std::map< core::IntegerInterval, AgeGroupGenderEquation > &	equations,
		const std::map< core::Identifier, core::Identifier > &	variables,
		const double	boundary_percentage
	)

Initialises a new instance of the EnergyBalanceHierarchicalModel class.

Parameters

equations	The linear regression equations
variables	The factors delta variables mapping
boundary_percentage	The boundary percentage to sample

Member Function Documentation

generate_risk_factors()

void hgps::EnergyBalanceHierarchicalModel::generate_risk_factors ( RuntimeContext &  context )

overridevirtual

Generates the initial risk factors for a population and newborns.

Parameters

context

The simulation run-time context

Exceptions

std::logic_error

the dynamic model does not generate risk factors.

Implements hgps::HierarchicalLinearModel.

name()

std::string hgps::EnergyBalanceHierarchicalModel::name ( ) const

overridevirtualnoexcept

Gets the model name.

Returns

The human-readable model name

Implements hgps::HierarchicalLinearModel.

type()

HierarchicalModelType hgps::EnergyBalanceHierarchicalModel::type ( ) const

overridevirtualnoexcept

Gets the model type identifier.

Returns

The module type identifier

Implements hgps::HierarchicalLinearModel.

update_risk_factors()

void hgps::EnergyBalanceHierarchicalModel::update_risk_factors ( RuntimeContext &  context )

overridevirtual

Update risk factors for population.

Parameters

context

The simulation run-time context

Implements hgps::HierarchicalLinearModel.

Here is the call graph for this function:

---

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

• HealthGPS/energy_balance_hierarchical_model.h
• HealthGPS/energy_balance_hierarchical_model.cpp