interfaces.h

Go to the documentation of this file.

#pragma once
#include "HealthGPS.Core/api.h"
#include "randombit_generator.h"
 
#include <map>
#include <memory>
 
namespace hgps {
 
enum class SimulationModuleType : uint8_t {
    RiskFactor,
 
    SES,
 
    Demographic,
 
    Disease,
 
    Analysis,
};
 
enum class HierarchicalModelType : uint8_t {
    Static,
 
    Dynamic,
};
 
template <typename T>
using case_insensitive_map = std::map<std::string, T, core::case_insensitive::comparator>;
 
struct Person;
 
struct PopulationRecord;
 
class RuntimeContext;
 
class SimulationModule {
  public:
    virtual ~SimulationModule() = default;
 
    virtual SimulationModuleType type() const noexcept = 0;
 
    virtual const std::string &name() const noexcept = 0;
 
    virtual void initialise_population(RuntimeContext &context) = 0;
};
 
class UpdatableModule : public SimulationModule {
  public:
    virtual void update_population(RuntimeContext &context) = 0;
};
 
class DiseaseHostModule : public UpdatableModule {
  public:
    virtual std::size_t size() const noexcept = 0;
 
    virtual bool contains(const core::Identifier &disease_id) const noexcept = 0;
 
    virtual double get_excess_mortality(const core::Identifier &disease_id,
                                        const Person &entity) const noexcept = 0;
};
 
class RiskFactorHostModule : public UpdatableModule {
  public:
    virtual std::size_t size() const noexcept = 0;
 
    virtual bool contains(const HierarchicalModelType &modelType) const noexcept = 0;
 
    virtual void apply_baseline_adjustments(RuntimeContext &context) = 0;
};
 
class DemographicModule : public SimulationModule {
  public:
    virtual std::size_t get_total_population_size(int time_year) const noexcept = 0;
 
    virtual const std::map<int, PopulationRecord> &
    get_population_distribution(int time_year) const = 0;
 
    virtual void update_population(RuntimeContext &context,
                                   const DiseaseHostModule &disease_host) = 0;
};
 
class HierarchicalLinearModel {
  public:
    virtual ~HierarchicalLinearModel() = default;
 
    virtual HierarchicalModelType type() const noexcept = 0;
 
    virtual std::string name() const noexcept = 0;
 
    virtual void generate_risk_factors(RuntimeContext &context) = 0;
 
    virtual void update_risk_factors(RuntimeContext &context) = 0;
};
 
class RiskFactorModelDefinition {
  public:
    virtual ~RiskFactorModelDefinition() = default;
 
    virtual std::unique_ptr<HierarchicalLinearModel> create_model() const = 0;
};
 
class DiseaseModel {
  public:
    virtual ~DiseaseModel() = default;
 
    virtual core::DiseaseGroup group() const noexcept = 0;
 
    virtual const core::Identifier &disease_type() const noexcept = 0;
 
    virtual void initialise_disease_status(RuntimeContext &context) = 0;
 
    virtual void initialise_average_relative_risk(RuntimeContext &context) = 0;
 
    virtual void update_disease_status(RuntimeContext &context) = 0;
 
    virtual double get_excess_mortality(const Person &entity) const noexcept = 0;
};
} // namespace hgps