healthgps/api/ses__noise__module_8h_source.html

#pragma once


#include "interfaces.h"

#include "modelinput.h"

#include "repository.h"


namespace hgps {


class SESNoiseModule final : public UpdatableModule {

  public:

    SESNoiseModule();


    SESNoiseModule(const std::vector<double> &parameters);


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


    SimulationModuleType type() const noexcept override;


    const std::string &name() const noexcept override;


    void initialise_population(RuntimeContext &context) override;


    void update_population(RuntimeContext &context) override;


  private:

    std::string function_;

    std::vector<double> parameters_;

    std::string name_{"SES"};

};


std::unique_ptr<SESNoiseModule> build_ses_noise_module(Repository &repository,

                                                       const ModelInput &config);

} // namespace hgps

hgps::ModelInput
Defines the Simulation model inputs data type.
Definition modelinput.h:49

hgps::Repository
Define the data repository interface for input datasets and back-end storage.
Definition repository.h:18

hgps::RuntimeContext
Defines the Simulation runtime context data type.
Definition runtime_context.h:22

hgps::SESNoiseModule
Implements the socio-economic status (SES) module.
Definition ses_noise_module.h:10

hgps::SESNoiseModule::name
const std::string & name() const noexcept override
Gets the module name.
Definition ses_noise_module.cpp:29

hgps::SESNoiseModule::SESNoiseModule
SESNoiseModule()
Initialise a new instance of the SESNoiseModule class.
Definition ses_noise_module.cpp:9

hgps::SESNoiseModule::update_population
void update_population(RuntimeContext &context) override
Updates the virtual population status.
Definition ses_noise_module.cpp:37

hgps::SESNoiseModule::type
SimulationModuleType type() const noexcept override
Gets the module type identifier.
Definition ses_noise_module.cpp:27

hgps::SESNoiseModule::initialise_population
void initialise_population(RuntimeContext &context) override
Initialises the virtual population.
Definition ses_noise_module.cpp:31

hgps::UpdatableModule
Generic disease module interface to host multiple diseases model.
Definition interfaces.h:50

interfaces.h

modelinput.h

hgps
Top-level namespace for Health-GPS Console host application.
Definition command_options.cpp:8

hgps::build_ses_noise_module
std::unique_ptr< SESNoiseModule > build_ses_noise_module(Repository &repository, const ModelInput &config)
Builds a new instance of the SESNoiseModule using the given data infrastructure.
Definition ses_noise_module.cpp:49

hgps::SimulationModuleType
SimulationModuleType
Health GPS simulation modules types enumeration.
Definition interfaces.h:13

repository.h