clInfectionEffect Class Reference

This returns the infection effect using the function:
Infection Effect = a * ln(T) + b where: More...

#include <InfectionEffect.h>

Inheritance diagram for clInfectionEffect:

Public Member Functions
	clInfectionEffect ()
	Constructor. More...
	~clInfectionEffect ()
	Destructor. More...
double	CalculateInfectionEffect (clTree *p_oTree)
	Calculates infection effect for a particular species. More...
void	DoSetup (clTreePopulation *p_oPop, clBehaviorBase *p_oNCI, xercesc::DOMElement *p_oElement)
	Does setup. More...
Public Member Functions inherited from clInfectionEffectBase
	clInfectionEffectBase ()
	Constructor. More...
virtual	~clInfectionEffectBase ()
	Destructor. More...
bool	DoesRequireTargetDiam ()
virtual void	PreCalcs (clTreePopulation *p_oPop)
	Performs calculations like either clGrowthBase::PreGrowthCalcs or clMortalityBase::PreMortCalcs. More...

Protected Attributes
short int **	mp_iYearsInfestedCodes
	Return codes for the "YearsInfested" int tree data member. More...
double *	mp_fA
	Infection effect a. More...
double *	mp_fB
	Infection effect b. More...
int	m_iTotalNumSpecies
	Total number of species. More...
Protected Attributes inherited from clInfectionEffectBase
bool	bRequiresTargetDiam
	Whether or not this effect depends on a target diameter being available. More...

Detailed Description

This returns the infection effect using the function:
Infection Effect = a * ln(T) + b where:

• T is the time of infestation, as recorded in the "YearsInfested" tree data member
• a and b are parameters

Copyright 2013 Charles D. Canham.

Author

Lora E. Murphy

Edit history:
--------------—
November 1, 2013 - Created (LEM)

Constructor & Destructor Documentation

clInfectionEffect()

clInfectionEffect::clInfectionEffect

(

)

Constructor.

~clInfectionEffect()

clInfectionEffect::~clInfectionEffect

(

)

Destructor.

Member Function Documentation

CalculateInfectionEffect()

double clInfectionEffect::CalculateInfectionEffect ( clTree *  p_oTree )

virtual

Calculates infection effect for a particular species.

Parameters

p_oTree

Tree for which to calculate infection effect.

Implements clInfectionEffectBase.

DoSetup()

void clInfectionEffect::DoSetup ( clTreePopulation *  p_oPop, clBehaviorBase *  p_oNCI, xercesc::DOMElement *  p_oElement  )

virtual

Does setup.

Parameters

p_oPop	Tree population.
p_oNCI	NCI behavior object.
p_oElement	Root element of the behavior.

Exceptions

ModelException

if there is a tree to which this behavior applies that does not have a "YearsInfested" code.

Implements clInfectionEffectBase.

Member Data Documentation

m_iTotalNumSpecies

int clInfectionEffect::m_iTotalNumSpecies

protected

Total number of species.

Primarily for the destructor.

mp_fA

double* clInfectionEffect::mp_fA

protected

Infection effect a.

Array is sized number of species.

mp_fB

double* clInfectionEffect::mp_fB

protected

Infection effect b.

Array is sized number of species.

mp_iYearsInfestedCodes

short int** clInfectionEffect::mp_iYearsInfestedCodes

protected

Return codes for the "YearsInfested" int tree data member.

Array index one is sized m_iTotalNumSpecies; array index two is sized number of total types.

---

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

• InfectionEffect.h