SORTIE Core C++ Documentation
Public Member Functions | List of all members
clSizeEffectBase Class Referenceabstract

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

#include <SizeEffectBase.h>

Inheritance diagram for clSizeEffectBase:
clSizeEffectCompoundExponential clSizeEffectDefault clSizeEffectLowerBounded clSizeEffectNone clSizeEffectPowerFunction clSizeEffectShiftedLognormal

Public Member Functions

virtual float CalculateSizeEffect (int iSpecies, float fDiam)=0
 Calculates size effect.
 
virtual void DoSetup (clTreePopulation *p_oPop, clBehaviorBase *p_oNCI, xercesc::DOMElement *p_oElement)=0
 Does any desired setup.
 
virtual void PreCalcs (clTreePopulation *p_oPop)
 Performs calculations like either clGrowthBase::PreGrowthCalcs or clMortalityBase::PreMortCalcs.
 
virtual ~clSizeEffectBase ()
 Destructor.
 

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

virtual clSizeEffectBase::~clSizeEffectBase ( )
inlinevirtual

Destructor.

Member Function Documentation

virtual float clSizeEffectBase::CalculateSizeEffect ( int  iSpecies,
float  fDiam 
)
pure virtual

Calculates size effect.

Parameters
iSpeciesSpecies of tree.
fDiamDiameter of tree. Diameter at 10 cm for seedlings, DBH for all other types.

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

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

Does any desired setup.

Parameters
p_oPopTree population.
p_oNCINCI behavior object.
p_oElementRoot element of the behavior.

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

virtual void clSizeEffectBase::PreCalcs ( clTreePopulation p_oPop)
inlinevirtual

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


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