Implements the cached data repository for input datasets and back-end storage. More...

#include <repository.h>

Inheritance diagram for hgps::CachedRepository:

Collaboration diagram for hgps::CachedRepository:

Public Member Functions
	CachedRepository ()=delete

	CachedRepository (core::Datastore &manager)
	Initialises a new instance of the CachedRepository class.

void	register_risk_factor_model_definition (const RiskFactorModelType &model_type, std::unique_ptr< RiskFactorModelDefinition > definition)
	Register a user provided risk factor model definition.

core::Datastore &	manager () noexcept override
	Gets a reference to the back-end storage instance.

const RiskFactorModelDefinition &	get_risk_factor_model_definition (const RiskFactorModelType &model_type) const override
	Gets a user-provided risk factor model definition.

const std::vector< core::DiseaseInfo > &	get_diseases () override
	Gets the collection of all diseases available in the back-end storage.

std::optional< core::DiseaseInfo >	get_disease_info (core::Identifier code) override
	Gets a disease information by identifier.

DiseaseDefinition &	get_disease_definition (const core::DiseaseInfo &info, const ModelInput &config) override
	Gets a disease complete definition.

LmsDefinition &	get_lms_definition () override
	Gets the LMS (lambda-mu-sigma) definition.

void	register_region_prevalence (const std::map< core::Identifier, std::map< core::Gender, std::map< std::string, double > > > &region_data) override
	Register region prevalence data.

void	register_ethnicity_prevalence (const std::map< core::Identifier, std::map< core::Gender, std::map< std::string, std::map< std::string, double > > > > &ethnicity_data) override
	Register ethnicity prevalence data.

const std::map< core::Identifier, std::map< core::Gender, std::map< std::string, double > > > &	get_region_prevalence () const override
	Gets region prevalence data.

const std::map< core::Identifier, std::map< core::Gender, std::map< std::string, std::map< std::string, double > > > > &	get_ethnicity_prevalence () const override
	Gets ethnicity prevalence data.

void	clear_cache () noexcept

Public Member Functions inherited from hgps::Repository
	Repository ()=default
	Initialises a new instance of the Repository class.

	Repository (Repository &&)=delete

	Repository (const Repository &)=delete

Repository &	operator= (Repository &&)=delete

Repository &	operator= (const Repository &)=delete

virtual	~Repository ()=default
	Destroys a Repository instance.

Detailed Description

Implements the cached data repository for input datasets and back-end storage.

This repository caches the read-only dataset used by multiple instances of the simulation to minimise back-end data access. This type is thread-safe

Constructor & Destructor Documentation

◆ CachedRepository() [1/2]

hgps::CachedRepository::CachedRepository ( )

delete

◆ CachedRepository() [2/2]

hgps::CachedRepository::CachedRepository ( core::Datastore & manager )

Initialises a new instance of the CachedRepository class.

Parameters

manager Back-end storage instance

Member Function Documentation

◆ clear_cache()

void hgps::CachedRepository::clear_cache ( )

noexcept

◆ get_disease_definition()

DiseaseDefinition & hgps::CachedRepository::get_disease_definition	(	const core::DiseaseInfo &	info,
		const ModelInput &	config
	)

overridevirtual

Gets a disease complete definition.

Parameters

info	The disease information
config	The user inputs instance

Returns: The disease definition

Exceptions

std::runtime_error for failure to load disease definition.

Implements hgps::Repository.

◆ get_disease_info()

std::optional< core::DiseaseInfo > hgps::CachedRepository::get_disease_info ( core::Identifier code )

overridevirtual

Gets a disease information by identifier.

Parameters

code	The disease identifier

Returns: Disease information, if found; otherwise, empty

Implements hgps::Repository.

Here is the call graph for this function:

◆ get_diseases()

const std::vector< core::DiseaseInfo > & hgps::CachedRepository::get_diseases ( )

overridevirtual

Gets the collection of all diseases available in the back-end storage.

Returns: Collection of diseases information

Implements hgps::Repository.

Here is the caller graph for this function:

◆ get_ethnicity_prevalence()

const std::map< core::Identifier, std::map< core::Gender, std::map< std::string, std::map< std::string, double > > > > & hgps::CachedRepository::get_ethnicity_prevalence ( ) const

overridevirtual

Gets ethnicity prevalence data.

Returns: Map of age group, gender, and region-specific ethnicity probabilities

Implements hgps::Repository.

◆ get_lms_definition()

LmsDefinition & hgps::CachedRepository::get_lms_definition ( )

overridevirtual

Gets the LMS (lambda-mu-sigma) definition.

Returns: The LMS definition

Implements hgps::Repository.

Here is the call graph for this function:

◆ get_region_prevalence()

const std::map< core::Identifier, std::map< core::Gender, std::map< std::string, double > > > & hgps::CachedRepository::get_region_prevalence ( ) const

overridevirtual

Gets region prevalence data.

Returns: Map of age-specific region probabilities by gender

Implements hgps::Repository.

◆ get_risk_factor_model_definition()

const RiskFactorModelDefinition & hgps::CachedRepository::get_risk_factor_model_definition ( const RiskFactorModelType & model_type ) const

overridevirtual

Gets a user-provided risk factor model definition.

Parameters

model_type Static or Dynamic

Returns: The risk factor model definition

Implements hgps::Repository.

◆ manager()

core::Datastore & hgps::CachedRepository::manager ( )

overridevirtualnoexcept

Gets a reference to the back-end storage instance.

Returns: The back-end data storage

Implements hgps::Repository.

◆ register_ethnicity_prevalence()

void hgps::CachedRepository::register_ethnicity_prevalence ( const std::map< core::Identifier, std::map< core::Gender, std::map< std::string, std::map< std::string, double > > > > & ethnicity_data )

overridevirtual

Register ethnicity prevalence data.

Parameters

ethnicity_data Map of age group, gender, and region-specific ethnicity probabilities

Implements hgps::Repository.

Here is the caller graph for this function:

◆ register_region_prevalence()

void hgps::CachedRepository::register_region_prevalence ( const std::map< core::Identifier, std::map< core::Gender, std::map< std::string, double > > > & region_data )

overridevirtual

Register region prevalence data.

Parameters

region_data Map of age-specific region probabilities by gender

Implements hgps::Repository.

Here is the caller graph for this function:

◆ register_risk_factor_model_definition()

void hgps::CachedRepository::register_risk_factor_model_definition	(	const RiskFactorModelType &	model_type,
		std::unique_ptr< RiskFactorModelDefinition >	definition
	)

Register a user provided risk factor model definition.

Parameters

model_type	Static or Dynamic
definition	The risk factor model definition instance

Here is the caller graph for this function:

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

HealthGPS/repository.h
HealthGPS/repository.cpp

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ CachedRepository() [1/2]

◆ CachedRepository() [2/2]

Member Function Documentation

◆ clear_cache()

◆ get_disease_definition()

◆ get_disease_info()

◆ get_diseases()

◆ get_ethnicity_prevalence()

◆ get_lms_definition()

◆ get_region_prevalence()

◆ get_risk_factor_model_definition()

◆ manager()

◆ register_ethnicity_prevalence()

◆ register_region_prevalence()

◆ register_risk_factor_model_definition()