Health-GPS scripted intervention policy scenario interface. More...

#include <intervention_scenario.h>

Inheritance diagram for hgps::InterventionScenario:

Collaboration diagram for hgps::InterventionScenario:

Public Member Functions
virtual const PolicyInterval &	active_period () const noexcept=0
	Gets the intervention active period. More...

virtual const std::vector< PolicyImpact > &	impacts () const noexcept=0
	Gets the intervention impacts by risk factor and age range. More...

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

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

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

virtual SyncChannel &	channel ()=0
	Gets the Scenario communication channel. More...

virtual void	clear () noexcept=0
	Clear the scenario log book data. More...

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

Detailed Description

Health-GPS scripted intervention policy scenario interface.

The intervention scenario interface must be implemented by all intervention policies, the interface identify the type as ScenarioType::intervention and name, and extends the Scenario with common intervention properties: active period and impacts.

Member Function Documentation

◆ active_period()

virtual const PolicyInterval& hgps::InterventionScenario::active_period ( ) const

pure virtualnoexcept

Gets the intervention active period.

Returns: Intervention period

Implemented in hgps::SimplePolicyScenario, hgps::PhysicalActivityScenario, hgps::MarketingPolicyScenario, hgps::MarketingDynamicScenario, hgps::FoodLabellingScenario, and hgps::FiscalPolicyScenario.

◆ impacts()

virtual const std::vector<PolicyImpact>& hgps::InterventionScenario::impacts ( ) const

pure virtualnoexcept

Gets the intervention impacts by risk factor and age range.

Returns: Intervention impact on risk factors

Implemented in hgps::SimplePolicyScenario, hgps::PhysicalActivityScenario, hgps::MarketingPolicyScenario, hgps::MarketingDynamicScenario, hgps::FoodLabellingScenario, and hgps::FiscalPolicyScenario.

◆ name()

const std::string& hgps::InterventionScenario::name ( ) const

inlineoverridevirtualnoexcept

Gets the scenario type name.

Returns: Scenario type name

Implements hgps::Scenario.

◆ type()

ScenarioType hgps::InterventionScenario::type ( ) const