PesticideStore Class Reference

#include <PesticideToxicity.h>

Inheritance diagram for PesticideStore:

Public Member Functions
	PesticideStore ()
void	addPesticide (double eating_amount, double amount_per_square, double(Landscape::*a_supply_pest_func_pointer)(int, int, PlantProtectionProducts), int loc_x, int loc_y)
	The function to add pesticide based on the eating amount and the amount of food per square meter. More...
void	addPesticide (double a_mount, PlantProtectionProducts a_type)
	The function to add pesticide based on the given amount and the given type. More...
virtual void	reset (void)
	The function to reset the pesticide to zero. More...
std::vector< double > *	supplyPesticide (void)
	The function to return the pesticide amount array. More...
double	supplyPesticide (PlantProtectionProducts a_type)
	The function to return the pesticide amount. More...
double	supplyTotalPesticide (void)
	The function to return the total pesticide amount. More...
void	doDecay (void)
	The default fuction to decay the pesticide body burden. More...
virtual void	tick (int a_step_counter_in_a_day)
	The function to update pesticide contamination every time step. More...

Static Public Member Functions
static void	setLandscapePointer (Landscape *a_landscape)
	The function to set the static landscape pointer. More...

Protected Attributes
std::vector< double >	m_pest_amount_vec
	The vector to store the pesticide amount for each pesticide. More...

Static Protected Attributes
static Landscape *	m_ALandscape = nullptr
	The static landscape pointer. More...

Constructor & Destructor Documentation

PesticideStore()

PesticideStore::PesticideStore

(

)

                                {
    if(!l_pest_enable_pesticide_engine.value()) return;
    m_pest_amount_vec.resize(l_pest_NoPPPs.value());
    for (int i = 0; i<l_pest_NoPPPs.value(); i++){
        m_pest_amount_vec[i] = 0.0;
    } 
}

References l_pest_enable_pesticide_engine, l_pest_NoPPPs, m_pest_amount_vec, CfgInt::value(), and CfgBool::value().

Member Function Documentation

addPesticide() [1/2]

void PesticideStore::addPesticide ( double  a_mount, PlantProtectionProducts  a_type  )

inline

The function to add pesticide based on the given amount and the given type.

{m_pest_amount_vec[a_type] += a_mount;}

References m_pest_amount_vec.

addPesticide() [2/2]

void PesticideStore::addPesticide	(	double	eating_amount,
		double	amount_per_square,
		double(Landscape::*)(int, int, PlantProtectionProducts)	a_supply_pest_func_pointer,
		int	loc_x,
		int	loc_y
	)

The function to add pesticide based on the eating amount and the amount of food per square meter.

                                                                                                                                                                                           {
    for (int i = 0; i<l_pest_NoPPPs.value(); i++){
        m_pest_amount_vec[i] += (m_ALandscape->*a_supply_pest_func_pointer)(loc_x, loc_y, PlantProtectionProducts(i));
    }
}

References l_pest_NoPPPs, m_ALandscape, m_pest_amount_vec, and CfgInt::value().

Referenced by PesticideToxicity::eatingFromStorePest(), and Osmia_Female::st_ReproductiveBehaviour().

doDecay()

void PesticideStore::doDecay

(

void

)

The default fuction to decay the pesticide body burden.

                                    {
 
    for (int i = 0; i<l_pest_NoPPPs.value(); i++){
        if(m_pest_amount_vec[i] > 0){
            m_pest_amount_vec[i] *= pest_decay_rate_animal.value(i);
        }
        
        if(m_pest_amount_vec[i] < l_pest_zero_threshold.value()){
            m_pest_amount_vec[i] = 0.0;
        }
    } 
 
}

References l_pest_NoPPPs, l_pest_zero_threshold, m_pest_amount_vec, pest_decay_rate_animal, CfgInt::value(), CfgFloat::value(), and CfgArray_Double::value().

Referenced by PesticideToxicity::PesticideToxicity(), and tick().

reset()

void PesticideStore::reset ( void  )

virtual

The function to reset the pesticide to zero.

Reimplemented in PesticideToxicity.

                                {
    for (int i = 0; i<l_pest_NoPPPs.value(); i++){
        m_pest_amount_vec[i] = 0.0;
    }
}

References l_pest_NoPPPs, m_pest_amount_vec, and CfgInt::value().

setLandscapePointer()

static void PesticideStore::setLandscapePointer ( Landscape *  a_landscape )

inlinestatic

The function to set the static landscape pointer.

{m_ALandscape = a_landscape;}

References m_ALandscape.

Referenced by Population_Manager_Base::Population_Manager_Base().

supplyPesticide() [1/2]

double PesticideStore::supplyPesticide ( PlantProtectionProducts  a_type )

inline

The function to return the pesticide amount.

{return(m_pest_amount_vec[a_type]);}

References m_pest_amount_vec.

supplyPesticide() [2/2]

std::vector<double>* PesticideStore::supplyPesticide ( void  )

inline

The function to return the pesticide amount array.

{return &m_pest_amount_vec;}

References m_pest_amount_vec.

Referenced by PesticideToxicity::eatingFromStorePest().

supplyTotalPesticide()

double PesticideStore::supplyTotalPesticide ( void  )

inline

The function to return the total pesticide amount.

{return std::accumulate(m_pest_amount_vec.begin(), m_pest_amount_vec.end(), 0.0);}

References m_pest_amount_vec.

Referenced by Osmia_Female::BeginStep().

tick()

void PesticideStore::tick ( int  a_step_counter_in_a_day )

virtual

The function to update pesticide contamination every time step.

                                                       {
    if(!l_pest_enable_pesticide_engine.value()) return;
    //These only be done once per day even for the species with finer time step, e.g., 1 hr
    if(a_step_counter_in_a_day == 0){
        doDecay();
    }
}

References doDecay(), l_pest_enable_pesticide_engine, and CfgBool::value().

Member Data Documentation

m_ALandscape

Landscape * PesticideStore::m_ALandscape = nullptr

staticprotected

The static landscape pointer.

Referenced by addPesticide(), PesticideToxicity::doContact(), PesticideToxicity::doOverspray(), and setLandscapePointer().

m_pest_amount_vec

std::vector<double> PesticideStore::m_pest_amount_vec

protected

The vector to store the pesticide amount for each pesticide.

Referenced by addPesticide(), PesticideToxicity::doContact(), doDecay(), PesticideToxicity::doOverspray(), PesticideToxicity::doToxicity(), PesticideToxicity::eatingFromStorePest(), PesticideStore(), reset(), PesticideToxicity::reset(), PesticideToxicity::SetPesticideVector(), supplyPesticide(), PesticideToxicity::supplyPesticide(), PesticideToxicity::supplyPesticideVector(), and supplyTotalPesticide().

---

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

• /builds/ALMaSS/ALMaSS_MIDox/Landscape/PesticideToxicity.h
• /builds/ALMaSS/ALMaSS_MIDox/Landscape/PesticideToxicity.cpp