hgps::input::Configuration Struct Reference

Defines the application configuration data structure. More...

#include <configuration.h>

Collaboration diagram for hgps::input::Configuration:

Public Attributes
std::filesystem::path	root_path
	The root path for configuration files.
std::unique_ptr< DataSource >	data_source
	Static data source for the simulation (either URL or path)
FileInfo	file
	The input data file details.
SettingsInfo	settings
	Experiment population settings.
SESInfo	ses
	Socio-economic status (SES) model inputs.
ModellingInfo	modelling
	User defined model and parameters information.
std::vector< std::string >	diseases
	List of diseases to include in experiment.
std::optional< unsigned int >	custom_seed
	Simulation initialisation custom seed value, optional.
unsigned int	start_time {}
	The experiment start time (simulation clock)
unsigned int	stop_time {}
	The experiment stop time (simulation clock)
unsigned int	trial_runs {}
	The number of simulation runs (replications) to execute.
unsigned int	sync_timeout_ms {}
	Baseline to intervention data synchronisation time out (milliseconds)
std::optional< PolicyScenarioInfo >	active_intervention
	The active intervention policy definition.
OutputInfo	output
	Experiment output folder and file information.
hgps::core::VerboseMode	verbosity {}
	Application logging verbosity mode.
int	job_id {}
	Experiment batch job identifier.
const char *	app_name = PROJECT_NAME
	Experiment model name.
const char *	app_version = PROJECT_VERSION
	Experiment model version.
ProjectRequirements	project_requirements {}
	Per-project requirements (demographics, income, PA, risk factors, trend, two-stage). Parsed from project_requirements; legacy root trend_type / income_categories map here when project_requirements is absent.
nlohmann::json	config_data
	Original config.json data for additional fields not mapped into Configuration.
PIFInfo	population_impact_fraction {}
	Population Impact Fraction (PIF) configuration.

Detailed Description

Defines the application configuration data structure.

Member Data Documentation

active_intervention

std::optional<PolicyScenarioInfo> hgps::input::Configuration::active_intervention

The active intervention policy definition.

app_name

const char* hgps::input::Configuration::app_name = PROJECT_NAME

Experiment model name.

app_version

const char* hgps::input::Configuration::app_version = PROJECT_VERSION

Experiment model version.

config_data

nlohmann::json hgps::input::Configuration::config_data

Original config.json data for additional fields not mapped into Configuration.

custom_seed

std::optional<unsigned int> hgps::input::Configuration::custom_seed

Simulation initialisation custom seed value, optional.

data_source

std::unique_ptr<DataSource> hgps::input::Configuration::data_source

Static data source for the simulation (either URL or path)

diseases

std::vector<std::string> hgps::input::Configuration::diseases

List of diseases to include in experiment.

file

FileInfo hgps::input::Configuration::file

The input data file details.

job_id

int hgps::input::Configuration::job_id {}

Experiment batch job identifier.

modelling

ModellingInfo hgps::input::Configuration::modelling

User defined model and parameters information.

output

OutputInfo hgps::input::Configuration::output

Experiment output folder and file information.

population_impact_fraction

PIFInfo hgps::input::Configuration::population_impact_fraction {}

Population Impact Fraction (PIF) configuration.

project_requirements

ProjectRequirements hgps::input::Configuration::project_requirements {}

Per-project requirements (demographics, income, PA, risk factors, trend, two-stage). Parsed from project_requirements; legacy root trend_type / income_categories map here when project_requirements is absent.

root_path

std::filesystem::path hgps::input::Configuration::root_path

The root path for configuration files.

ses

SESInfo hgps::input::Configuration::ses

Socio-economic status (SES) model inputs.

settings

SettingsInfo hgps::input::Configuration::settings

Experiment population settings.

start_time

unsigned int hgps::input::Configuration::start_time {}

The experiment start time (simulation clock)

stop_time

unsigned int hgps::input::Configuration::stop_time {}

The experiment stop time (simulation clock)

sync_timeout_ms

unsigned int hgps::input::Configuration::sync_timeout_ms {}

Baseline to intervention data synchronisation time out (milliseconds)

trial_runs

unsigned int hgps::input::Configuration::trial_runs {}

The number of simulation runs (replications) to execute.

verbosity

hgps::core::VerboseMode hgps::input::Configuration::verbosity {}

Application logging verbosity mode.

---

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

• HealthGPS.Input/configuration.h