hgps::RiskFactorModel Class Reference

Risk factor model interface. More...

#include <risk_factor_model.h>

Inheritance diagram for hgps::RiskFactorModel:

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

Detailed Description

Risk factor model interface.

Constructor & Destructor Documentation

~RiskFactorModel()

virtual hgps::RiskFactorModel::~RiskFactorModel ( )

virtualdefault

Destroys a RiskFactorModel instance.

Member Function Documentation

generate_risk_factors()

virtual void hgps::RiskFactorModel::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::DummyModel, hgps::DynamicHierarchicalLinearModel, hgps::KevinHallModel, hgps::StaticHierarchicalLinearModel, and hgps::StaticLinearModel.

name()

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

pure virtualnoexcept

Gets the model name.

Returns

The human-readable model name

Implemented in hgps::DummyModel, hgps::DynamicHierarchicalLinearModel, hgps::KevinHallModel, hgps::StaticHierarchicalLinearModel, and hgps::StaticLinearModel.

type()

virtual RiskFactorModelType hgps::RiskFactorModel::type ( ) const

pure virtualnoexcept

Gets the model type identifier.

Returns

The module type identifier

Implemented in hgps::DummyModel, hgps::DynamicHierarchicalLinearModel, hgps::KevinHallModel, hgps::StaticHierarchicalLinearModel, and hgps::StaticLinearModel.

update_risk_factors()

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

pure virtual

Update risk factors for population.

Parameters

context

The simulation run-time context

Implemented in hgps::DummyModel, hgps::DynamicHierarchicalLinearModel, hgps::KevinHallModel, hgps::StaticHierarchicalLinearModel, and hgps::StaticLinearModel.

---

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

• HealthGPS/risk_factor_model.h