Provides a base for objects that calculate a size effect. More...

#include <SizeEffectBase.h>

Inheritance diagram for clSizeEffectBase:

Public Member Functions
virtual double	CalculateSizeEffect (clTree *p_oTree, const float &fDiam)=0
	Calculates size effect. More...

virtual void	DoSetup (clTreePopulation p_oPop, clBehaviorBase p_oNCI, xercesc::DOMElement *p_oElement)=0
	Does any desired setup. More...

virtual void	PreCalcs (clTreePopulation *p_oPop)
	Performs calculations like either clGrowthBase::PreGrowthCalcs or clMortalityBase::PreMortCalcs. More...

virtual	~clSizeEffectBase ()
	Destructor. More...

Detailed Description

Provides a base for objects that calculate a size effect.

The default is that objects descended from this class can handle any tree type. If this is not the case, child objects must throw the appropriate error during setup.

Constructor & Destructor Documentation

◆ ~clSizeEffectBase()

virtual clSizeEffectBase::~clSizeEffectBase ( )

inlinevirtual

Destructor.

Member Function Documentation

◆ CalculateSizeEffect()

virtual double clSizeEffectBase::CalculateSizeEffect	(	clTree *	p_oTree,
		const float &	fDiam
	)

pure virtual

Calculates size effect.

Parameters

p_oTree	Tree for which to calculate size effect.
fDiam	Diameter of tree. Diameter at 10 cm for seedlings, DBH for all other types. This can be got from the tree but it's already been extracted so let's pass it in.

Implemented in clSizeEffectLowerBounded, clSizeEffectShiftedLogInf, clSizeEffectCompoundExpInf, clSizeEffectPowerFunction, clSizeEffectShiftedLognormal, clSizeEffectDefault, clSizeEffectCompoundExponential, and clSizeEffectNone.