hgps::SESNoiseModule Class Reference

Implements the socio-economic status (SES) module. More...

#include <ses_noise_module.h>

Inheritance diagram for hgps::SESNoiseModule:

Collaboration diagram for hgps::SESNoiseModule:

Public Member Functions
	SESNoiseModule ()
	Initialise a new instance of the SESNoiseModule class.
	SESNoiseModule (const std::vector< double > &parameters)
	Initialise a new instance of the SESNoiseModule class.
	SESNoiseModule (std::string function, const std::vector< double > &parameters)
	Initialise a new instance of the SESNoiseModule class.
SimulationModuleType	type () const noexcept override
	Gets the module type identifier.
const std::string &	name () const noexcept override
	Gets the module name.
void	initialise_population (RuntimeContext &context) override
	Initialises the virtual population.
void	update_population (RuntimeContext &context) override
	Updates the virtual population status.
Public Member Functions inherited from hgps::SimulationModule
virtual	~SimulationModule ()=default
	Destroys a SimulationModule instance.

Detailed Description

Implements the socio-economic status (SES) module.

Constructor & Destructor Documentation

SESNoiseModule() [1/3]

hgps::SESNoiseModule::SESNoiseModule

(

)

Initialise a new instance of the SESNoiseModule class.

SESNoiseModule() [2/3]

hgps::SESNoiseModule::SESNoiseModule

(

const std::vector< double > &

parameters

)

Initialise a new instance of the SESNoiseModule class.

Parameters

parameters

The model function parameters

Exceptions

std::invalid_argument

for number of parameters mismatch.

SESNoiseModule() [3/3]

hgps::SESNoiseModule::SESNoiseModule	(	std::string	function,
		const std::vector< double > &	parameters
	)

Initialise a new instance of the SESNoiseModule class.

Parameters

function	The model function identifier
parameters	The model function parameters

Exceptions

std::invalid_argument

for unknown model function or number of parameters mismatch.

Here is the call graph for this function:

Member Function Documentation

initialise_population()

void hgps::SESNoiseModule::initialise_population ( RuntimeContext &  context )

overridevirtual

Initialises the virtual population.

Parameters

context

The simulation shared runtime context instance

Implements hgps::SimulationModule.

Here is the call graph for this function:

name()

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

overridevirtualnoexcept

Gets the module name.

Returns

The human-readable module name

Implements hgps::SimulationModule.

type()

SimulationModuleType hgps::SESNoiseModule::type ( ) const

overridevirtualnoexcept

Gets the module type identifier.

Returns

The module type identifier

Implements hgps::SimulationModule.

update_population()

void hgps::SESNoiseModule::update_population ( RuntimeContext &  context )

overridevirtual

Updates the virtual population status.

Parameters

context

The simulation run-time context

Implements hgps::UpdatableModule.

Here is the call graph for this function:

---

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

• HealthGPS/ses_noise_module.h
• HealthGPS/ses_noise_module.cpp