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.
core::DiseaseGroup	group () const noexcept override
	Returns the disease group type (cancer).
const core::Identifier &	disease_type () const noexcept override
	Returns the cancer type identifier.
void	initialise_disease_status (RuntimeContext &context) override
	Initialises the cancer status of the population (from prevalence). Cancer start_time = 0 disambiguates from incidence cases on start year. Must be followed by:
void	initialise_average_relative_risk (RuntimeContext &context) override
	Initialise average relative risk for cancer model on start year. The average relative risks from risk factors and diseases on start year is used to normalise the relative risks for an indivudual at a given time To preserve the distribution of this cancer as the simulation prorgesses.
void	update_disease_status (RuntimeContext &context) override
	Simulates cancer remission and incidence cases of the population. For each year, this method calls the following methods in ordrer:
double	get_excess_mortality (const Person &person) const noexcept override
	Returns the excess mortality for a given person's age and sex.
Public Member Functions inherited from hgps::DiseaseModel
virtual	~DiseaseModel ()=default
	Destroys a DiseaseModel instance.

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

Returns the cancer type identifier.

Returns

The cancer type identifier

Implements hgps::DiseaseModel.

Here is the caller graph for this function:

get_excess_mortality()

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

overridevirtualnoexcept

Returns the excess mortality for a given person's age and sex.

Parameters

person

The person instance to calculate the excess mortality

Returns

The excess mortality for a given person's age and sex

Implements hgps::DiseaseModel.

group()

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

overridevirtualnoexcept

Returns the disease group type (cancer).

Returns

The disease group type (cancer).

Implements hgps::DiseaseModel.

initialise_average_relative_risk()

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

overridevirtual

Initialise average relative risk for cancer model on start year. The average relative risks from risk factors and diseases on start year is used to normalise the relative risks for an indivudual at a given time To preserve the distribution of this cancer as the simulation prorgesses.

Parameters

context

The runtime context instance

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 cancer status of the population (from prevalence). Cancer start_time = 0 disambiguates from incidence cases on start year. Must be followed by:

• initialise_average_relative_risk (used to preserve distribution)
• update_disease_status (to simulate incidence cases on start year)

  Parameters

  context

  The runtime context instance

Implements hgps::DiseaseModel.

Here is the call graph for this function:

update_disease_status()

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

overridevirtual

Simulates cancer remission and incidence cases of the population. For each year, this method calls the following methods in ordrer:

• update_incidence_cases

  Parameters

  context

  The runtime context instance

Implements hgps::DiseaseModel.

---

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

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