hgps::RiskFactorAdjustableModelDefinition Class Reference

Risk factor adjustable model definition interface. More...

#include <risk_factor_adjustable_model.h>

Inheritance diagram for hgps::RiskFactorAdjustableModelDefinition:

Collaboration diagram for hgps::RiskFactorAdjustableModelDefinition:

Public Member Functions
	~RiskFactorAdjustableModelDefinition () override=default
	Destroys a RiskFactorAdjustableModelDefinition instance.
	RiskFactorAdjustableModelDefinition (std::unique_ptr< RiskFactorSexAgeTable > expected, std::unique_ptr< std::unordered_map< core::Identifier, double > > expected_trend, std::unique_ptr< std::unordered_map< core::Identifier, int > > trend_steps, TrendType trend_type=TrendType::Null)
	Constructs a new RiskFactorAdjustableModelDefinition instance.
Public Member Functions inherited from hgps::RiskFactorModelDefinition
virtual	~RiskFactorModelDefinition ()=default
	Destroys a RiskFactorModelDefinition instance.
virtual std::unique_ptr< RiskFactorModel >	create_model () const =0
	Creates a new risk factor model from this definition.

Protected Attributes
std::shared_ptr< RiskFactorSexAgeTable >	expected_
std::shared_ptr< std::unordered_map< core::Identifier, double > >	expected_trend_
std::shared_ptr< std::unordered_map< core::Identifier, int > >	trend_steps_
TrendType	trend_type_

Detailed Description

Risk factor adjustable model definition interface.

Constructor & Destructor Documentation

~RiskFactorAdjustableModelDefinition()

hgps::RiskFactorAdjustableModelDefinition::~RiskFactorAdjustableModelDefinition ( )

overridedefault

Destroys a RiskFactorAdjustableModelDefinition instance.

RiskFactorAdjustableModelDefinition()

hgps::RiskFactorAdjustableModelDefinition::RiskFactorAdjustableModelDefinition	(	std::unique_ptr< RiskFactorSexAgeTable >	expected,
		std::unique_ptr< std::unordered_map< core::Identifier, double > >	expected_trend,
		std::unique_ptr< std::unordered_map< core::Identifier, int > >	trend_steps,
		TrendType	trend_type = TrendType::Null
	)

Constructs a new RiskFactorAdjustableModelDefinition instance.

Parameters

expected	The expected risk factor values by sex and age
expected_trend	The expected trend of risk factor values
trend_steps	The number of time steps to apply the trend
trend_type	The type of trend to apply (optional, defaults to Null)

Exceptions

HgpsException

for invalid arguments

Member Data Documentation

expected_

std::shared_ptr<RiskFactorSexAgeTable> hgps::RiskFactorAdjustableModelDefinition::expected_

protected

expected_trend_

std::shared_ptr<std::unordered_map<core::Identifier, double> > hgps::RiskFactorAdjustableModelDefinition::expected_trend_

protected

trend_steps_

std::shared_ptr<std::unordered_map<core::Identifier, int> > hgps::RiskFactorAdjustableModelDefinition::trend_steps_

protected

trend_type_

TrendType hgps::RiskFactorAdjustableModelDefinition::trend_type_

protected

---

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

• HealthGPS/risk_factor_adjustable_model.h
• HealthGPS/risk_factor_adjustable_model.cpp