hgps::HierarchicalLinearModel Class Reference

Hierarchical linear model interface. More...

#include <interfaces.h>

Inheritance diagram for hgps::HierarchicalLinearModel:

Public Member Functions
virtual	~HierarchicalLinearModel ()=default
	Destroys a HierarchicalLinearModel instance. More...
virtual HierarchicalModelType	type () const noexcept=0
	Gets the model type identifier. More...
virtual std::string	name () const noexcept=0
	Gets the model name. More...
virtual void	generate_risk_factors (RuntimeContext &context)=0
	Generates the initial risk factors for a population and newborns. More...
virtual void	update_risk_factors (RuntimeContext &context)=0
	Update risk factors for population. More...

Detailed Description

Hierarchical linear model interface.

Constructor & Destructor Documentation

~HierarchicalLinearModel()

virtual hgps::HierarchicalLinearModel::~HierarchicalLinearModel ( )

virtualdefault

Destroys a HierarchicalLinearModel instance.

Member Function Documentation

generate_risk_factors()

virtual void hgps::HierarchicalLinearModel::generate_risk_factors ( RuntimeContext &  context )

pure virtual

Generates the initial risk factors for a population and newborns.

Parameters

context

The simulation run-time context

Implemented in hgps::StaticHierarchicalLinearModel, hgps::EnergyBalanceModel, and hgps::EnergyBalanceHierarchicalModel.

name()

virtual std::string hgps::HierarchicalLinearModel::name ( ) const

pure virtualnoexcept

Gets the model name.

Returns

The human-readable model name

Implemented in hgps::StaticHierarchicalLinearModel, hgps::EnergyBalanceModel, and hgps::EnergyBalanceHierarchicalModel.

type()

virtual HierarchicalModelType hgps::HierarchicalLinearModel::type ( ) const

pure virtualnoexcept

Gets the model type identifier.

Returns

The module type identifier

Implemented in hgps::StaticHierarchicalLinearModel, hgps::EnergyBalanceModel, and hgps::EnergyBalanceHierarchicalModel.

update_risk_factors()

virtual void hgps::HierarchicalLinearModel::update_risk_factors ( RuntimeContext &  context )

pure virtual

Update risk factors for population.

Parameters

context

The simulation run-time context

Implemented in hgps::StaticHierarchicalLinearModel, hgps::EnergyBalanceModel, and hgps::EnergyBalanceHierarchicalModel.

---

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

• HealthGPS/interfaces.h