hgps::DummyModel Class Reference

Implements the dummy risk factor model type. More...

#include <dummy_model.h>

Inheritance diagram for hgps::DummyModel:

Collaboration diagram for hgps::DummyModel:

Public Member Functions
	DummyModel (RiskFactorModelType type, const std::vector< core::Identifier > &names, const std::vector< double > &values, const std::vector< double > &policy, const std::vector< int > &policy_start)
	Initialises a new instance of the DummyModel class.
RiskFactorModelType	type () const noexcept override
	Get the risk factor model type.
std::string	name () const noexcept override
	Get the risk factor model name.
void	generate_risk_factors (RuntimeContext &context) override
	Initialise risk factor values and apply intervention policy.
void	update_risk_factors (RuntimeContext &context) override
	Update risk factor values and apply intervention policy.
Public Member Functions inherited from hgps::RiskFactorModel
virtual	~RiskFactorModel ()=default
	Destroys a RiskFactorModel instance.

Detailed Description

Implements the dummy risk factor model type.

The dummy model is used to fix risk factors to known constant values.

Constructor & Destructor Documentation

DummyModel()

hgps::DummyModel::DummyModel	(	RiskFactorModelType	type,
		const std::vector< core::Identifier > &	names,
		const std::vector< double > &	values,
		const std::vector< double > &	policy,
		const std::vector< int > &	policy_start
	)

Initialises a new instance of the DummyModel class.

Parameters

type	Risk factor model type
names	Risk factor names
values	Constant values to set risk factors to
policy	Risk factor policy in intervention scenario
policy_start	Policy start (in years since the start of the simulation)

Member Function Documentation

generate_risk_factors()

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

overridevirtual

Initialise risk factor values and apply intervention policy.

Parameters

context

The runtime context

Implements hgps::RiskFactorModel.

Here is the call graph for this function:

name()

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

overridevirtualnoexcept

Get the risk factor model name.

Returns

The risk factor model name

Implements hgps::RiskFactorModel.

type()

RiskFactorModelType hgps::DummyModel::type ( ) const

overridevirtualnoexcept

Get the risk factor model type.

Returns

The risk factor model type

Implements hgps::RiskFactorModel.

update_risk_factors()

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

overridevirtual

Update risk factor values and apply intervention policy.

Parameters

context

The runtime context

Implements hgps::RiskFactorModel.

Here is the call graph for this function:

---

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

• HealthGPS/dummy_model.h
• HealthGPS/dummy_model.cpp