Defines the Simulation model inputs data type. More...

#include <modelinput.h>

Public Member Functions
	ModelInput ()=delete

	ModelInput (core::DataTable &data, Settings settings, const RunInfo &run_info, SESDefinition ses_info, HierarchicalMapping risk_mapping, std::vector< core::DiseaseInfo > diseases, hgps::input::ProjectRequirements project_requirements, hgps::input::PIFInfo pif_info=hgps::input::PIFInfo{}, std::optional< hgps::input::IndividualIdTrackingConfig > individual_id_tracking_config=std::nullopt)
	Initialise a new instance of the ModelInput class.

const Settings &	settings () const noexcept
	Gets the simulation experiment settings definition.

const core::DataTable &	data () const noexcept
	Gets the risk factors model dataset.

unsigned int	start_time () const noexcept
	Gets the experiment start time.

unsigned int	stop_time () const noexcept
	Gets the experiment stop time.

unsigned int	sync_timeout_ms () const noexcept
	Gets the scenarios data synchronisation timeout (milliseconds)

const std::optional< unsigned int > &	seed () const noexcept
	Gets the user custom seed to initialise the pseudo-number generator.

const RunInfo &	run () const noexcept
	Gets the simulation run information.

const SESDefinition &	ses_definition () const noexcept
	Gets the Socio-economic status (SES) model information.

const HierarchicalMapping &	risk_mapping () const noexcept
	Gets the Hierarchical risk factors model mappings definition.

const std::vector< core::DiseaseInfo > &	diseases () const noexcept
	Gets the collection of diseases to include in experiment.

bool	enable_income_analysis () const noexcept
	Gets whether income-based analysis is enabled.

const hgps::input::PIFInfo &	population_impact_fraction () const noexcept
	Gets the Population Impact Fraction configuration.

const hgps::input::ProjectRequirements &	project_requirements () const noexcept
	Gets the per-project requirements (demographics, income, PA, risk factors, trend, two-stage)

const std::optional< hgps::input::IndividualIdTrackingConfig > &	individual_id_tracking_config () const noexcept
	Gets optional individual ID tracking config (MAHIMA: per-person CSV output).

Detailed Description

Defines the Simulation model inputs data type.

Constructor & Destructor Documentation

◆ ModelInput() [1/2]

hgps::ModelInput::ModelInput ( )

delete

◆ ModelInput() [2/2]

hgps::ModelInput::ModelInput	(	core::DataTable &	data,
		Settings	settings,
		const RunInfo &	run_info,
		SESDefinition	ses_info,
		HierarchicalMapping	risk_mapping,
		std::vector< core::DiseaseInfo >	diseases,
		hgps::input::ProjectRequirements	project_requirements,
		hgps::input::PIFInfo	pif_info = `hgps::input::PIFInfo{}`,
		std::optional< hgps::input::IndividualIdTrackingConfig >	individual_id_tracking_config = `std::nullopt`
	)

Initialise a new instance of the ModelInput class.

Parameters

data	The risk factors fitted dataset
settings	Experiment settings definition
run_info	Simulation run information
ses_info	Socio-economic status (SES) model information
risk_mapping	Hierarchical risk factors model mappings
diseases	Selected diseases to include in experiment
project_requirements	Per-project requirements (demographics, income, PA, etc.)
pif_info	Population Impact Fraction configuration
individual_id_tracking_config	MAHIMA: optional per-person CSV tracking (output)

Member Function Documentation

◆ data()

const core::DataTable & hgps::ModelInput::data ( ) const

noexcept

Gets the risk factors model dataset.

Returns: Risk factors dataset

◆ diseases()

const std::vector< core::DiseaseInfo > & hgps::ModelInput::diseases ( ) const

noexcept

Gets the collection of diseases to include in experiment.

Returns: Diseases to include in experiment

Here is the caller graph for this function:

◆ enable_income_analysis()

bool hgps::ModelInput::enable_income_analysis ( ) const

noexcept

Gets whether income-based analysis is enabled.

Returns: true if income analysis is enabled, false otherwise

◆ individual_id_tracking_config()

const std::optional< hgps::input::IndividualIdTrackingConfig > & hgps::ModelInput::individual_id_tracking_config ( ) const

noexcept

Gets optional individual ID tracking config (MAHIMA: per-person CSV output).

Returns: Optional tracking config, or nullopt if not set

◆ population_impact_fraction()

const hgps::input::PIFInfo & hgps::ModelInput::population_impact_fraction ( ) const

noexcept

Gets the Population Impact Fraction configuration.

Returns: PIF configuration

◆ project_requirements()

const hgps::input::ProjectRequirements & hgps::ModelInput::project_requirements ( ) const

noexcept

Gets the per-project requirements (demographics, income, PA, risk factors, trend, two-stage)

Returns: Project requirements

Here is the caller graph for this function:

◆ risk_mapping()

const HierarchicalMapping & hgps::ModelInput::risk_mapping ( ) const

noexcept

Gets the Hierarchical risk factors model mappings definition.

Returns: Risk factors model mappings

◆ run()

const RunInfo & hgps::ModelInput::run ( ) const

noexcept

Gets the simulation run information.

Returns: simulation run information

Here is the caller graph for this function:

◆ seed()

const std::optional< unsigned int > & hgps::ModelInput::seed ( ) const

noexcept

Gets the user custom seed to initialise the pseudo-number generator.

Returns: User custom seed value, if provide; otherwise empty.

◆ ses_definition()

const SESDefinition & hgps::ModelInput::ses_definition ( ) const

noexcept

Gets the Socio-economic status (SES) model information.

Returns: SES model information

Here is the caller graph for this function:

◆ settings()

const Settings & hgps::ModelInput::settings ( ) const

noexcept

Gets the simulation experiment settings definition.

Returns: Experiment settings definition

Here is the caller graph for this function:

◆ start_time()

unsigned int hgps::ModelInput::start_time ( ) const

noexcept

Gets the experiment start time.

Returns: Experiment start time

Here is the caller graph for this function:

◆ stop_time()

unsigned int hgps::ModelInput::stop_time ( ) const

noexcept

Gets the experiment stop time.

Returns: Experiment stop time

Here is the caller graph for this function:

◆ sync_timeout_ms()

unsigned int hgps::ModelInput::sync_timeout_ms ( ) const

noexcept

Gets the scenarios data synchronisation timeout (milliseconds)

Returns: Scenarios synchronisation timeout

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

HealthGPS/modelinput.h
HealthGPS/modelinput.cpp

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ModelInput() [1/2]

◆ ModelInput() [2/2]

Member Function Documentation

◆ data()

◆ diseases()

◆ enable_income_analysis()

◆ individual_id_tracking_config()

◆ population_impact_fraction()

◆ project_requirements()

◆ risk_mapping()

◆ run()

◆ seed()

◆ ses_definition()

◆ settings()

◆ start_time()

◆ stop_time()

◆ sync_timeout_ms()