hgps::RiskFactorHostModule Class Referenceabstract
Generic risk factors module interface to host hierarchical models. More...
#include <interfaces.h>
Inheritance diagram for hgps::RiskFactorHostModule:
Collaboration diagram for hgps::RiskFactorHostModule:
Public Member Functions | |
| virtual std::size_t | size () const noexcept=0 |
| Gets the number of diseases model hosted. More... | |
| virtual bool | contains (const HierarchicalModelType &modelType) const noexcept=0 |
| Indicates whether the host contains a model of type. More... | |
| virtual void | apply_baseline_adjustments (RuntimeContext &context)=0 |
| Apply baseline risk factor adjustments to population. 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 risk factors module interface to host hierarchical models.
Member Function Documentation
◆ apply_baseline_adjustments()
|
pure virtual |
Apply baseline risk factor adjustments to population.
- Parameters
-
context The simulation run-time context
Implemented in hgps::RiskFactorModule.
◆ contains()
|
pure virtualnoexcept |
Indicates whether the host contains a model of type.
- Parameters
-
modelType The hierarchical model type identifier
- Returns
- true if the hierarchical model is found, otherwise false.
Implemented in hgps::RiskFactorModule.
◆ size()
|
pure virtualnoexcept |
Gets the number of diseases model hosted.
- Returns
- Number of hosted diseases models
Implemented in hgps::RiskFactorModule.
The documentation for this class was generated from the following file:
- HealthGPS/interfaces.h
