hgps::DiseaseHostModule Class Referenceabstract
Generic disease module interface to host multiple disease models. More...
#include <interfaces.h>
Inheritance diagram for hgps::DiseaseHostModule:
Collaboration diagram for hgps::DiseaseHostModule:
Public Member Functions | |
| virtual std::size_t | size () const noexcept=0 |
| Gets the number of diseases model hosted. More... | |
| virtual bool | contains (const core::Identifier &disease_id) const noexcept=0 |
| Indicates whether the host contains an disease identified by code. More... | |
| virtual double | get_excess_mortality (const core::Identifier &disease_id, const Person &entity) const noexcept=0 |
| Gets the mortality rate associated with a disease for an individual. More... | |
 Public Member Functions inherited from hgps::UpdatableModule | |
| virtual void | update_population (RuntimeContext &context)=0 |
| Updates the virtual population status. More... | |
| Public Member Functions inherited from hgps::SimulationModule | |
| 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
Generic disease module interface to host multiple disease models.
Member Function Documentation
◆ contains()
|
pure virtualnoexcept |
Indicates whether the host contains an disease identified by code.
- Parameters
-
disease_id The disease unique identifier
- Returns
- true if the disease is found, otherwise false.
Implemented in hgps::DiseaseModule.
◆ get_excess_mortality()
|
pure virtualnoexcept |
Gets the mortality rate associated with a disease for an individual.
- Parameters
-
disease_id The disease unique identifier entity The entity associated with the mortality value
- Returns
- the mortality rate value, if found, otherwise zero.
Implemented in hgps::DiseaseModule.
◆ size()
|
pure virtualnoexcept |
Gets the number of diseases model hosted.
- Returns
- Number of hosted diseases models
Implemented in hgps::DiseaseModule.
The documentation for this class was generated from the following file:
- HealthGPS/interfaces.h
