hgps::PhysicalActivityScenario Class Reference

Implements the physical activity regulation intervention scenario. More...

#include <physical_activity_scenario.h>

Inheritance diagram for hgps::PhysicalActivityScenario:

Collaboration diagram for hgps::PhysicalActivityScenario:

Public Member Functions
	PhysicalActivityScenario ()=delete
	PhysicalActivityScenario (SyncChannel &data_sync, PhysicalActivityDefinition &&definition)
	Initialises a new instance of the MarketingDynamicScenario class. More...
SyncChannel &	channel () override
	Gets the Scenario communication channel. More...
void	clear () noexcept override
	Clear the scenario log book data. More...
double	apply (Random &generator, Person &entity, int time, const core::Identifier &risk_factor_key, double value) override
	Applies this Scenario to the Person instance. More...
const PolicyInterval &	active_period () const noexcept override
	Gets the intervention active period. More...
const std::vector< PolicyImpact > &	impacts () const noexcept override
	Gets the intervention impacts by risk factor and age range. More...
Public Member Functions inherited from hgps::InterventionScenario
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...

Detailed Description

Implements the physical activity regulation intervention scenario.

Constructor & Destructor Documentation

PhysicalActivityScenario() [1/2]

hgps::PhysicalActivityScenario::PhysicalActivityScenario ( )

delete

PhysicalActivityScenario() [2/2]

hgps::PhysicalActivityScenario::PhysicalActivityScenario	(	SyncChannel &	data_sync,
		PhysicalActivityDefinition &&	definition
	)

Initialises a new instance of the MarketingDynamicScenario class.

Parameters

data_sync	The data synchronisation channel instance to use.
definition	The intervention definition

Exceptions

std::invalid_argument	number of impact levels mismatch.
std::out_of_range	for overlapping or non-ordered impact levels.

Member Function Documentation

active_period()

const PolicyInterval & hgps::PhysicalActivityScenario::active_period ( ) const

overridevirtualnoexcept

Gets the intervention active period.

Returns

Intervention period

Implements hgps::InterventionScenario.

apply()

double hgps::PhysicalActivityScenario::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

Returns

The risk factor new value

Implements hgps::Scenario.

Here is the call graph for this function:

channel()

SyncChannel & hgps::PhysicalActivityScenario::channel ( )

overridevirtual

Gets the Scenario communication channel.

Returns

The communication channel

Implements hgps::Scenario.

clear()

void hgps::PhysicalActivityScenario::clear ( )

overridevirtualnoexcept

Clear the scenario log book data.

Implements hgps::Scenario.

impacts()

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

overridevirtualnoexcept

Gets the intervention impacts by risk factor and age range.

Returns

Intervention impact on risk factors

Implements hgps::InterventionScenario.

---

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

• HealthGPS/physical_activity_scenario.h
• HealthGPS/physical_activity_scenario.cpp