hgps::DiseaseModel Class Reference

Diseases model interface. More...

#include <interfaces.h>

Inheritance diagram for hgps::DiseaseModel:

Public Member Functions
virtual	~DiseaseModel ()=default
	Destroys a DiseaseModel instance. More...
virtual core::DiseaseGroup	group () const noexcept=0
	Gets the disease group. More...
virtual const core::Identifier &	disease_type () const noexcept=0
	Gets the model disease type unique identifier. More...
virtual void	initialise_disease_status (RuntimeContext &context)=0
	Initialises the population disease status. More...
virtual void	initialise_average_relative_risk (RuntimeContext &context)=0
	Initialises the average relative risks once all diseases status were initialised. More...
virtual void	update_disease_status (RuntimeContext &context)=0
	Updates the disease cases remission and incidence in the population. More...
virtual double	get_excess_mortality (const Person &entity) const noexcept=0
	Gets the excess mortality associated with a disease for an individual. More...

Detailed Description

Diseases model interface.

Constructor & Destructor Documentation

~DiseaseModel()

virtual hgps::DiseaseModel::~DiseaseModel ( )

virtualdefault

Destroys a DiseaseModel instance.

Member Function Documentation

disease_type()

virtual const core::Identifier& hgps::DiseaseModel::disease_type ( ) const

pure virtualnoexcept

Gets the model disease type unique identifier.

Returns

The disease type identifier

Implemented in hgps::DefaultDiseaseModel, and hgps::DefaultCancerModel.

get_excess_mortality()

virtual double hgps::DiseaseModel::get_excess_mortality ( const Person &  entity ) const

pure virtualnoexcept

Gets the excess mortality associated with a disease for an individual.

Parameters

entity

The entity associated with the mortality rate

Returns

the mortality rate value, if found, otherwise zero.

Implemented in hgps::DefaultDiseaseModel, and hgps::DefaultCancerModel.

group()

virtual core::DiseaseGroup hgps::DiseaseModel::group ( ) const

pure virtualnoexcept

Gets the disease group.

Returns

The disease group identifier

Implemented in hgps::DefaultDiseaseModel, and hgps::DefaultCancerModel.

initialise_average_relative_risk()

virtual void hgps::DiseaseModel::initialise_average_relative_risk ( RuntimeContext &  context )

pure virtual

Initialises the average relative risks once all diseases status were initialised.

Parameters

context

The simulation run-time context

Implemented in hgps::DefaultDiseaseModel, and hgps::DefaultCancerModel.

initialise_disease_status()

virtual void hgps::DiseaseModel::initialise_disease_status ( RuntimeContext &  context )

pure virtual

Initialises the population disease status.

Parameters

context

The simulation run-time context

Implemented in hgps::DefaultDiseaseModel, and hgps::DefaultCancerModel.

update_disease_status()

virtual void hgps::DiseaseModel::update_disease_status ( RuntimeContext &  context )

pure virtual

Updates the disease cases remission and incidence in the population.

Parameters

context

The simulation run-time context

Implemented in hgps::DefaultDiseaseModel, and hgps::DefaultCancerModel.

---

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

• HealthGPS/interfaces.h