Provides a base for objects that calculate an infection effect. More...

#include <InfectionEffectBase.h>

Inheritance diagram for clInfectionEffectBase:

Public Member Functions
	clInfectionEffectBase ()
	Constructor. More...

virtual double	CalculateInfectionEffect (clTree *p_oTree)=0
	Calculates infection effect for a particular species. More...

virtual void	DoSetup (clTreePopulation p_oPop, clBehaviorBase p_oNCI, xercesc::DOMElement *p_oElement)=0
	Does any desired setup. 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
bool	bRequiresTargetDiam
	Whether or not this effect depends on a target diameter being available. More...

Detailed Description

Provides a base for objects that calculate an infection effect.

Constructor & Destructor Documentation

◆ clInfectionEffectBase()

clInfectionEffectBase::clInfectionEffectBase ( )

inline

Constructor.

Sets defaults.

◆ ~clInfectionEffectBase()

virtual clInfectionEffectBase::~clInfectionEffectBase ( )

inlinevirtual

Destructor.

Member Function Documentation

◆ CalculateInfectionEffect()

virtual double clInfectionEffectBase::CalculateInfectionEffect ( clTree * p_oTree )

pure virtual

Calculates infection effect for a particular species.

Parameters

p_oTree Tree for which to calculate infection effect.

Implemented in clInfectionEffectSizeDependent, clInfectionEffect, and clInfectionEffectNone.

◆ DoesRequireTargetDiam()

bool clInfectionEffectBase::DoesRequireTargetDiam ( )

inline

◆ DoSetup()

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

pure virtual

Does any desired setup.

Parameters

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

Implemented in clInfectionEffectSizeDependent, clInfectionEffect, and clInfectionEffectNone.

◆ PreCalcs()

virtual void clInfectionEffectBase::PreCalcs ( clTreePopulation * p_oPop )

inlinevirtual

Performs calculations like either clGrowthBase::PreGrowthCalcs or clMortalityBase::PreMortCalcs.

Member Data Documentation

◆ bRequiresTargetDiam

bool clInfectionEffectBase::bRequiresTargetDiam

protected

Whether or not this effect depends on a target diameter being available.

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

InfectionEffectBase.h

Public Member Functions

Protected Attributes