Health-GPS  1.2.2.0
Global Health Policy Simulation model (Health-GPS)
hgps::DiseaseDefinition Class Referencefinal

Implements the disease full definition data type. More...

#include <disease_definition.h>

Public Member Functions

 DiseaseDefinition (DiseaseTable &&measures_table, RelativeRiskTableMap &&diseases, RelativeRiskLookupMap &&risk_factors)
 Initialises a new instance of the DiseaseDefinition class for standard diseases. More...
 
 DiseaseDefinition (DiseaseTable &&measures_table, RelativeRiskTableMap &&diseases, RelativeRiskLookupMap &&risk_factors, DiseaseParameter &&parameter)
 Initialises a new instance of the DiseaseDefinition class for cancer diseases. More...
 
const core::DiseaseInfoidentifier () const noexcept
 Gets the disease unique identifier. More...
 
const DiseaseTabletable () const noexcept
 Gets the disease measures table, e.g., prevalence, incidence, etc., rates. More...
 
const RelativeRiskTableMaprelative_risk_diseases () const noexcept
 Gets the diseases relative risk to disease table. More...
 
const RelativeRiskLookupMaprelative_risk_factors () const noexcept
 Gets the risk factors relative risk to disease table. More...
 
const DiseaseParameterparameters () const noexcept
 Gets the cancer disease parameters. More...
 

Detailed Description

Implements the disease full definition data type.

Constructor & Destructor Documentation

◆ DiseaseDefinition() [1/2]

hgps::DiseaseDefinition::DiseaseDefinition ( DiseaseTable &&  measures_table,
RelativeRiskTableMap &&  diseases,
RelativeRiskLookupMap &&  risk_factors 
)
inline

Initialises a new instance of the DiseaseDefinition class for standard diseases.

Parameters
measures_tableThe disease measures table
diseasesThe diseases to disease relative risk table
risk_factorsThe risk-factors to diseases relative risk values

◆ DiseaseDefinition() [2/2]

hgps::DiseaseDefinition::DiseaseDefinition ( DiseaseTable &&  measures_table,
RelativeRiskTableMap &&  diseases,
RelativeRiskLookupMap &&  risk_factors,
DiseaseParameter &&  parameter 
)
inline

Initialises a new instance of the DiseaseDefinition class for cancer diseases.

Parameters
measures_tableThe disease measures table
diseasesThe diseases to disease relative risk table
risk_factorsThe risk-factors to diseases relative risk values
parameterThe cancer disease parameter

Member Function Documentation

◆ identifier()

const core::DiseaseInfo& hgps::DiseaseDefinition::identifier ( ) const
inlinenoexcept

Gets the disease unique identifier.

Returns
The disease identifier
Here is the call graph for this function:

◆ parameters()

const DiseaseParameter& hgps::DiseaseDefinition::parameters ( ) const
inlinenoexcept

Gets the cancer disease parameters.

Returns
The cancer parameters

◆ relative_risk_diseases()

const RelativeRiskTableMap& hgps::DiseaseDefinition::relative_risk_diseases ( ) const
inlinenoexcept

Gets the diseases relative risk to disease table.

Returns
The disease-disease relative risk table

◆ relative_risk_factors()

const RelativeRiskLookupMap& hgps::DiseaseDefinition::relative_risk_factors ( ) const
inlinenoexcept

Gets the risk factors relative risk to disease table.

Returns
The risk factors to disease relative risk values

◆ table()

const DiseaseTable& hgps::DiseaseDefinition::table ( ) const
inlinenoexcept

Gets the disease measures table, e.g., prevalence, incidence, etc., rates.

Returns
The disease measures table

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