FRED
Antiviral Class Reference

#include <Antiviral.h>

List of all members.

Public Member Functions

 Antiviral (int _disease, int _course_length, double _reduce_infectivity, double _reduce_susceptibility, double _reduce_asymp_period, double _reduce_sympt_period, double _prob_symptoms, int _initial_stock, int _total_avail, int _additional_per_day, double _efficacy, double *_av_cousre_start_day, int _max_av_course_start_day, int _start_day, bool _prophylaxis, double _percent_symptomatics)
int get_disease () const
double get_reduce_infectivity () const
double get_reduce_susceptibility () const
double get_reduce_asymp_period () const
double get_reduce_symp_period () const
double get_prob_symptoms () const
int get_course_length () const
double get_percent_symptomatics () const
double get_efficacy () const
int get_start_day () const
bool is_prophylaxis () const
int roll_will_have_symp () const
int roll_efficacy () const
int roll_course_start_day () const
int get_initial_stock () const
int get_total_avail () const
int get_current_reserve () const
int get_current_stock () const
int get_additional_per_day () const
void add_stock (int amount)
void remove_stock (int remove)
void update (int day)
void print () const
void reset ()
void report (int day) const
int quality_control (int ndiseases) const
void print_stocks () const
void effect (Health *h, int cur_day, AV_Health *av_health)
void modify_susceptiblilty (Health *health, int disease)
void modify_infectivity (Health *health, int disease)
void modify_infectivity_strain (Health *health, int disease, int strain)
void modify_symptomaticity (Health *health, int disease, int cur_day)
void set_policy (Policy *p)
Policyget_policy () const
void add_given_out (int amount)
void add_ineff_given_out (int amount)

Detailed Description

Antiviral is a class to hold all of the parameters to describe a single antiviral


Constructor & Destructor Documentation

Antiviral::Antiviral ( int  _disease,
int  _course_length,
double  _reduce_infectivity,
double  _reduce_susceptibility,
double  _reduce_asymp_period,
double  _reduce_sympt_period,
double  _prob_symptoms,
int  _initial_stock,
int  _total_avail,
int  _additional_per_day,
double  _efficacy,
double *  _av_cousre_start_day,
int  _max_av_course_start_day,
int  _start_day,
bool  _prophylaxis,
double  _percent_symptomatics 
)

Constructor that sets all of the attributes of an Antiviral object


Member Function Documentation

void Antiviral::add_stock ( int  amount) [inline]
Parameters:
amounthow much to add to stock
void Antiviral::effect ( Health h,
int  cur_day,
AV_Health av_health 
)

Used to alter the Health of an agent

Parameters:
hpointer to a Health object
cur_daythe simulation day
av_healthpointer to a specific AV_Health object
int Antiviral::get_additional_per_day ( ) const [inline]
Returns:
the additional_per_day
int Antiviral::get_course_length ( ) const [inline]
Returns:
this Antiviral's course_length
int Antiviral::get_current_reserve ( ) const [inline]
Returns:
the reserve
int Antiviral::get_current_stock ( ) const [inline]
Returns:
the stock
int Antiviral::get_disease ( ) const [inline]
Returns:
this Antiviral's disease
double Antiviral::get_efficacy ( ) const [inline]
Returns:
this Antiviral's efficacy
int Antiviral::get_initial_stock ( ) const [inline]
Returns:
the initial_stock
double Antiviral::get_percent_symptomatics ( ) const [inline]
Returns:
this Antiviral's percent_symptomatics
Policy* Antiviral::get_policy ( ) const [inline]
Returns:
this Antiviral's distribution policy
double Antiviral::get_prob_symptoms ( ) const [inline]
Returns:
this Antiviral's prob_symptoms
double Antiviral::get_reduce_asymp_period ( ) const [inline]
Returns:
this Antiviral's reduce_asymp_period
double Antiviral::get_reduce_infectivity ( ) const [inline]
Returns:
this Antiviral's reduce_infectivity
double Antiviral::get_reduce_susceptibility ( ) const [inline]
Returns:
this Antiviral's reduce_susceptibility
double Antiviral::get_reduce_symp_period ( ) const [inline]
Returns:
this Antiviral's reduce_symp_period
int Antiviral::get_start_day ( ) const [inline]
Returns:
this Antiviral's start_day
int Antiviral::get_total_avail ( ) const [inline]
Returns:
the total_avail
bool Antiviral::is_prophylaxis ( ) const [inline]
Returns:
true if this Antiviral's is prophylaxis, false otherwise
void Antiviral::modify_infectivity ( Health health,
int  disease 
)

Modify the infectivity of an agent (through that agent's Health)

Parameters:
healthpointer to a Health object
diseasewhich disease
void Antiviral::modify_infectivity_strain ( Health health,
int  disease,
int  strain 
)

Modify the infectivity of an agent (through that agent's Health)

Parameters:
healthpointer to a Health object
diseasewhich disease
strainwhich strain of the disease
void Antiviral::modify_susceptiblilty ( Health health,
int  disease 
)

Modify the susceptibility of an agent (through that agent's Health)

Parameters:
healthpointer to a Health object
diseasewhich disease
void Antiviral::modify_symptomaticity ( Health health,
int  disease,
int  cur_day 
)

Modify the symptomaticity of an agent (through that agent's Health)

Parameters:
healthpointer to a Health object
diseasewhich disease
cur_daythe simulation day
void Antiviral::print ( ) const

Print out information about this object

void Antiviral::print_stocks ( ) const

Print out current stock information

int Antiviral::quality_control ( int  ndiseases) const

Used during debugging to verify that code is functioning properly.
Currently, this checks the parsing of the AVs, and it returns 1 if there is a problem

Parameters:
ndiseasesthe bumber of diseases
Returns:
1 if there is a problem, 0 otherwise
void Antiviral::remove_stock ( int  remove) [inline]
Parameters:
removehow much to remove from stock
void Antiviral::report ( int  day) const

Print out a daily report

Parameters:
daythe simulation day
void Antiviral::reset ( )

Put this object back to its original state

int Antiviral::roll_course_start_day ( ) const

Randomly determine the day to start (draw_from_distribution(max_av_course_start_day, av_course_start_day))

Returns:
the number of days drawn
int Antiviral::roll_efficacy ( ) const

Randomly determine if will be effective (determined by efficacy)

Returns:
1 if roll is successful, 0 if false
int Antiviral::roll_will_have_symp ( ) const

Randomly determine if will be symptomatic (determined by prob_symptoms)

Returns:
1 if roll is successful, 0 if false
void Antiviral::set_policy ( Policy p) [inline]

Set the distribution policy for this Antiviral

Parameters:
ppointer to the new Policy
void Antiviral::update ( int  day)

Perform the daily update for this object

Parameters:
daythe simulation day

The documentation for this class was generated from the following files:
 All Classes Functions