Class InterventionMeaslesPEP¶
template <typename TSeq>
ClassList > InterventionMeaslesPEP
#include <interventionmeaslespep-bones.hpp>
Inherits the following classes: GlobalEvent
Public Functions¶
| Type | Name |
|---|---|
| InterventionMeaslesPEP (std::string name, epiworld_double mmr_efficacy, epiworld_double ig_efficacy, epiworld_double ig_half_life_mean, epiworld_double ig_half_life_sd, epiworld_double pep_willingness, epiworld_double mmr_window, std::vector< int > target_states, std::vector< int > states_if_pep_effective, std::vector< int > states_if_pep_ineffective) Construct a new Intervention PEP object. |
|
| virtual std::unique_ptr< GlobalEvent< TSeq > > | clone_ptr () override const |
| virtual void | operator() (Model< TSeq > * model, int day) override Apply the intervention to the model. |
Public Functions inherited from GlobalEvent¶
See GlobalEvent
| Type | Name |
|---|---|
| GlobalEvent () |
|
| GlobalEvent (GlobalFun< TSeq > fun, std::string name, int day=-99) Construct a new Global Event object. |
|
| virtual std::unique_ptr< GlobalEvent< TSeq > > | clone_ptr () const |
| int | get_day () const |
| std::string | get_name () const |
| bool | operator!= (const GlobalEvent< TSeq > & other) const |
| virtual void | operator() (Model< TSeq > * m, int day) |
| bool | operator== (const GlobalEvent< TSeq > & other) const |
| void | print () const |
| void | set_day (int day) |
| void | set_name (std::string name) |
| virtual | ~GlobalEvent () = default |
Public Static Functions¶
| Type | Name |
|---|---|
| bool | agent_recovers (Agent< TSeq > & p, Model< TSeq > & m, int next_state) |
Public Functions Documentation¶
function InterventionMeaslesPEP¶
Construct a new Intervention PEP object.
inline InterventionMeaslesPEP::InterventionMeaslesPEP (
std::string name,
epiworld_double mmr_efficacy,
epiworld_double ig_efficacy,
epiworld_double ig_half_life_mean,
epiworld_double ig_half_life_sd,
epiworld_double pep_willingness,
epiworld_double mmr_window,
std::vector< int > target_states,
std::vector< int > states_if_pep_effective,
std::vector< int > states_if_pep_ineffective
)
Parameters:
par_mmr_efficacyThe efficacy of the PEP. Must be between 0 and 1.par_pep_willingnessThe willingness of the agents to receive PEP. Must be between 0 and 1.target_statesThe states to which the intervention applies. For example, if the intervention applies to agents in quarantine, then this should include the states that correspond to quarantine.quarantine_states_for_pepThe states to which the agents will be moved if they receive PEP. Must be the same length asquarantine_states. For example, if agents in state 2 are quarantined and will move to state 5 if they receive PEP, thenquarantine_statesshould include 2 andquarantine_states_for_pepshould include 5 at the corresponding position.
function clone_ptr¶
inline virtual std::unique_ptr< GlobalEvent < TSeq > > InterventionMeaslesPEP::clone_ptr () override const
Implements GlobalEvent::clone_ptr
function operator()¶
Apply the intervention to the model.
This function is called at the end of the day as a global event. It iterates through the agents and gives PEP to those who are willing and applicable.
Agents who receive PEP may then be moved to a different state if the PEP is effective.
Implements GlobalEvent::operator()
Public Static Functions Documentation¶
function agent_recovers¶
static inline bool InterventionMeaslesPEP::agent_recovers (
Agent < TSeq > & p,
Model < TSeq > & m,
int next_state
)
The documentation for this class was generated from the following file epiworld-src/include/epiworld/globalevents/interventionmeaslespep-bones.hpp