FRED
Antivirals Class Reference

#include <Antivirals.h>

List of all members.

Public Member Functions

 Antivirals ()
bool do_av () const
int get_number_antivirals () const
int get_total_current_stock () const
vector< Antiviral * > const get_AV_vector () const
Antiviral *const get_AV (int nav) const
void print () const
void print_stocks () const
void reset ()
void update (int day)
void report (int day) const
void quality_control (int ndiseases) const
vector< Antiviral * > find_applicable_AVs (int disease) const
vector< Antiviral * > prophylaxis_AVs () const

Detailed Description

Antivirals is a class to contain a group of Antiviral classes


Constructor & Destructor Documentation

Antivirals::Antivirals ( )

Default constructor
Reads all important values from parameter file


Member Function Documentation

bool Antivirals::do_av ( ) const [inline]
Returns:
true if there are Antivirals, false if not
vector< Antiviral * > Antivirals::find_applicable_AVs ( int  disease) const

This method looks through the vector of Antiviral objects and checks to see if each one is effective against the particular disease and if it also has some in stock. If so, then that particular AV is added to the return vector.

Parameters:
thedisease to poll for
Returns:
a vector of pointers to Antiviral objects
Antiviral* const Antivirals::get_AV ( int  nav) const [inline]

Return a pointer to a specific Antiviral in this group's vector

vector<Antiviral *> const Antivirals::get_AV_vector ( ) const [inline]
Returns:
a pointer to this groups Antiviral vector
int Antivirals::get_number_antivirals ( ) const [inline]
Returns:
the count of antivirals
int Antivirals::get_total_current_stock ( ) const
Returns:
the total current stock of all Antivirals in this group
void Antivirals::print ( ) const

Print out information about this object

void Antivirals::print_stocks ( ) const

Print out current stock information for each Anitviral in this group's vector

vector< Antiviral * > Antivirals::prophylaxis_AVs ( ) const
Returns:
a vector of pointers to all Antiviral objects in this group that are prophylaxis
void Antivirals::quality_control ( int  ndiseases) const

Used during debugging to verify that code is functioning properly.
Checks the quality_control of each Antiviral in this group's vector of AVs

Parameters:
ndiseasesthe bumber of diseases
Returns:
1 if there is a problem, 0 otherwise
void Antivirals::report ( int  day) const

Print out a daily report

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

Put this object back to its original state

void Antivirals::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