Defines the baseline scenario data type. More...

#include <baseline_scenario.h>

Inheritance diagram for hgps::BaselineScenario:

Collaboration diagram for hgps::BaselineScenario:

Public Member Functions
	BaselineScenario ()=delete

	BaselineScenario (SyncChannel &data_sync)
	Initialises a new instance of the BaselineScenario class.

ScenarioType	type () const noexcept override
	Gets the scenario type identifier.

const std::string &	name () const noexcept override
	Gets the scenario type name.

SyncChannel &	channel () override
	Gets the Scenario communication channel.

void	clear () noexcept override
	Clear the scenario log book data.

double	apply (Random &generator, Person &entity, int time, const core::Identifier &risk_factor_key, double value) override
	Applies this Scenario to the Person instance.

Public Member Functions inherited from hgps::Scenario
virtual	~Scenario ()=default
	Destroys a Scenario instance.

Detailed Description

Defines the baseline scenario data type.

The baseline scenario is a special case, which identify the type as ScenarioType::baseline and when applied to a Person makes no changes to any risk factor value. This implementation is final.

Constructor & Destructor Documentation

◆ BaselineScenario() [1/2]

hgps::BaselineScenario::BaselineScenario ( )

delete

◆ BaselineScenario() [2/2]

hgps::BaselineScenario::BaselineScenario ( SyncChannel & data_sync )

Initialises a new instance of the BaselineScenario class.

Parameters

data_sync The data synchronisation channel instance to use.

Member Function Documentation

◆ apply()

double hgps::BaselineScenario::apply	(	Random &	generator,
		Person &	entity,
		int	time,
		const core::Identifier &	risk_factor_key,
		double	value
	)

overridevirtual

Applies this Scenario to the Person instance.

Parameters

generator	Random number generator instance
entity	Person instance to apply
time	Current simulation time
risk_factor_key	Target risk factor identifier
value	Current risk factor value