hgps::DefaultCancerModel Class Reference

Defines the cancer disease model data type. More...

#include <default_cancer_model.h>

Inheritance diagram for hgps::DefaultCancerModel:

Collaboration diagram for hgps::DefaultCancerModel:

Public Member Functions
	DefaultCancerModel ()=delete
	DefaultCancerModel (DiseaseDefinition &definition, WeightModel &&classifier, const core::IntegerInterval &age_range)
	Initialise a new instance of the DefaultCancerModel class. More...
core::DiseaseGroup	group () const noexcept override
	Gets the disease group. More...
const core::Identifier &	disease_type () const noexcept override
	Gets the model disease type unique identifier. More...
void	initialise_disease_status (RuntimeContext &context) override
	Initialises the population disease status. More...
void	initialise_average_relative_risk (RuntimeContext &context) override
	Initialises the average relative risks once all diseases status were initialised. More...
void	update_disease_status (RuntimeContext &context) override
	Updates the disease cases remission and incidence in the population. More...
double	get_excess_mortality (const Person &entity) const noexcept override
	Gets the excess mortality associated with a disease for an individual. More...
Public Member Functions inherited from hgps::DiseaseModel
virtual	~DiseaseModel ()=default
	Destroys a DiseaseModel instance. More...

Detailed Description

Defines the cancer disease model data type.

Constructor & Destructor Documentation

DefaultCancerModel() [1/2]

hgps::DefaultCancerModel::DefaultCancerModel ( )

delete

DefaultCancerModel() [2/2]

hgps::DefaultCancerModel::DefaultCancerModel	(	DiseaseDefinition &	definition,
		WeightModel &&	classifier,
		const core::IntegerInterval &	age_range
	)

Initialise a new instance of the DefaultCancerModel class.

Parameters

definition	The disease definition instance
classifier	The body weight classification model instance
age_range	The valid age range for model dataset

Member Function Documentation

disease_type()

const core::Identifier & hgps::DefaultCancerModel::disease_type ( ) const

overridevirtualnoexcept

Gets the model disease type unique identifier.

Returns

The disease type identifier

Implements hgps::DiseaseModel.

Here is the caller graph for this function:

get_excess_mortality()

double hgps::DefaultCancerModel::get_excess_mortality ( const Person &  entity ) const

overridevirtualnoexcept

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.

Implements hgps::DiseaseModel.

group()

core::DiseaseGroup hgps::DefaultCancerModel::group ( ) const

overridevirtualnoexcept

Gets the disease group.

Returns

The disease group identifier

Implements hgps::DiseaseModel.

initialise_average_relative_risk()

void hgps::DefaultCancerModel::initialise_average_relative_risk ( RuntimeContext &  context )

overridevirtual

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

Parameters

context

The simulation run-time context

Implements hgps::DiseaseModel.

Here is the call graph for this function:

initialise_disease_status()

void hgps::DefaultCancerModel::initialise_disease_status ( RuntimeContext &  context )

overridevirtual

Initialises the population disease status.

Parameters

context

The simulation run-time context

Implements hgps::DiseaseModel.

Here is the call graph for this function:

update_disease_status()

void hgps::DefaultCancerModel::update_disease_status ( RuntimeContext &  context )

overridevirtual

Updates the disease cases remission and incidence in the population.

Parameters

context

The simulation run-time context

Implements hgps::DiseaseModel.

---

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

• HealthGPS/default_cancer_model.h
• HealthGPS/default_cancer_model.cpp