hgps::DiseaseDefinition Class Reference

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

#include <disease_definition.h>

Public Member Functions
	DiseaseDefinition (DiseaseTable &&measures_table, RelativeRiskTableMap &&diseases, RelativeRiskLookupMap &&risk_factors, hgps::input::PIFData &&pif_data=hgps::input::PIFData{})
	Initialises a new instance of the DiseaseDefinition class for standard diseases.
	DiseaseDefinition (DiseaseTable &&measures_table, RelativeRiskTableMap &&diseases, RelativeRiskLookupMap &&risk_factors, DiseaseParameter &&parameter, hgps::input::PIFData &&pif_data=hgps::input::PIFData{})
	Initialises a new instance of the DiseaseDefinition class for cancer diseases.
const core::DiseaseInfo &	identifier () const noexcept
	Gets the disease unique identifier.
const DiseaseTable &	table () const noexcept
	Gets the disease measures table, e.g., prevalence, incidence, etc., rates.
const RelativeRiskTableMap &	relative_risk_diseases () const noexcept
	Gets the diseases relative risk to disease table.
const RelativeRiskLookupMap &	relative_risk_factors () const noexcept
	Gets the risk factors relative risk to disease table.
const DiseaseParameter &	parameters () const noexcept
	Gets the cancer disease parameters.
const hgps::input::PIFData &	pif_data () const noexcept
	Gets the PIF data for this disease.
void	set_pif_data (hgps::input::PIFData &&pif_data)
	Sets the PIF data for this disease.
bool	has_pif_data () const noexcept
	Checks if PIF data is available for this disease.

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, hgps::input::PIFData &&  pif_data = hgps::input::PIFData{}  )

inline

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

Parameters

measures_table	The disease measures table
diseases	The diseases to disease relative risk table
risk_factors	The risk-factors to diseases relative risk values
pif_data	The PIF data for this disease (optional)

DiseaseDefinition() [2/2]

hgps::DiseaseDefinition::DiseaseDefinition ( DiseaseTable &&  measures_table, RelativeRiskTableMap &&  diseases, RelativeRiskLookupMap &&  risk_factors, DiseaseParameter &&  parameter, hgps::input::PIFData &&  pif_data = hgps::input::PIFData{}  )

inline

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

Parameters

measures_table	The disease measures table
diseases	The diseases to disease relative risk table
risk_factors	The risk-factors to diseases relative risk values
parameter	The cancer disease parameter
pif_data	The PIF data for this disease (optional)

Member Function Documentation

has_pif_data()

bool hgps::DiseaseDefinition::has_pif_data ( ) const

inlinenoexcept

Checks if PIF data is available for this disease.

Returns

true if PIF data is available, false otherwise

Here is the call graph for this function:

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

pif_data()

const hgps::input::PIFData & hgps::DiseaseDefinition::pif_data ( ) const

inlinenoexcept

Gets the PIF data for this disease.

Returns

Reference to PIF data

Here is the caller graph for this function:

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

set_pif_data()

void hgps::DiseaseDefinition::set_pif_data ( hgps::input::PIFData &&  pif_data )

inline

Sets the PIF data for this disease.

Parameters

pif_data

The PIF data to set

Here is the call graph for this function:

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:

• HealthGPS/disease_definition.h