hgps::SimulationModule Class Reference

Simulation modules interface. More...

#include <interfaces.h>

Inheritance diagram for hgps::SimulationModule:

Public Member Functions
virtual	~SimulationModule ()=default
	Destroys a SimulationModule instance. More...
virtual SimulationModuleType	type () const noexcept=0
	Gets the module type identifier. More...
virtual const std::string &	name () const noexcept=0
	Gets the module name. More...
virtual void	initialise_population (RuntimeContext &context)=0
	Initialises the virtual population. More...

Detailed Description

Simulation modules interface.

Constructor & Destructor Documentation

~SimulationModule()

virtual hgps::SimulationModule::~SimulationModule ( )

virtualdefault

Destroys a SimulationModule instance.

Member Function Documentation

initialise_population()

virtual void hgps::SimulationModule::initialise_population ( RuntimeContext &  context )

pure virtual

Initialises the virtual population.

Parameters

context

The simulation shared runtime context instance

Implemented in hgps::SESNoiseModule, hgps::RiskFactorModule, hgps::DiseaseModule, hgps::PopulationModule, and hgps::AnalysisModule.

name()

virtual const std::string& hgps::SimulationModule::name ( ) const

pure virtualnoexcept

Gets the module name.

Returns

The human-readable module name

Implemented in hgps::SESNoiseModule, hgps::RiskFactorModule, hgps::DiseaseModule, hgps::PopulationModule, and hgps::AnalysisModule.

type()

virtual SimulationModuleType hgps::SimulationModule::type ( ) const

pure virtualnoexcept

Gets the module type identifier.

Returns

The module type identifier

Implemented in hgps::SESNoiseModule, hgps::RiskFactorModule, hgps::DiseaseModule, hgps::PopulationModule, and hgps::AnalysisModule.

---

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

• HealthGPS/interfaces.h