hgps::ModelInput Class Reference

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

#include <modelinput.h>

Public Member Functions
	ModelInput ()=delete
	ModelInput (core::DataTable &data, const Settings &settings, const RunInfo &run_info, const SESDefinition &ses_info, const HierarchicalMapping &risk_mapping, const std::vector< core::DiseaseInfo > &diseases)
	Initialise a new instance of the ModelInput class. More...
const Settings &	settings () const noexcept
	Gets the simulation experiment settings definition. More...
const core::DataTable &	data () const noexcept
	Gets the risk factors model dataset. More...
const unsigned int &	start_time () const noexcept
	Gets the experiment start time. More...
const unsigned int &	stop_time () const noexcept
	Gets the experiment stop time. More...
const unsigned int &	sync_timeout_ms () const noexcept
	Gets the scenarios data synchronisation timeout (milliseconds) More...
const std::optional< unsigned int > &	seed () const noexcept
	Gets the user custom seed to initialise the pseudo-number generator. More...
const RunInfo &	run () const noexcept
	Gets the simulation run information. More...
const SESDefinition &	ses_definition () const noexcept
	Gets the Socio-economic status (SES) model information. More...
const HierarchicalMapping &	risk_mapping () const noexcept
	Gets the Hierarchical risk factors model mappings definition. More...
const std::vector< core::DiseaseInfo > &	diseases () const noexcept
	Gets the collection of diseases to include in experiment. More...

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,
		const Settings &	settings,
		const RunInfo &	run_info,
		const SESDefinition &	ses_info,
		const HierarchicalMapping &	risk_mapping,
		const std::vector< core::DiseaseInfo > &	diseases
	)

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

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:

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.

Here is the caller graph for this function:

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()

const 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()

const 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()

const 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