SORTIE Core C++ Documentation
Public Member Functions | Protected Attributes | List of all members
clTemperatureEffectBase Class Referenceabstract

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

#include <TemperatureEffectBase.h>

Inheritance diagram for clTemperatureEffectBase:
clTemperatureEffectDoubleLogistic clTemperatureEffectNone clTemperatureEffectWeibull

Public Member Functions

 clTemperatureEffectBase ()
 Constructor.
 
virtual float CalculateTemperatureEffect (clPlot *p_oPlot, int iSpecies)=0
 Calculates temperature effect for a particular species.
 
virtual void DoSetup (clTreePopulation *p_oPop, clBehaviorBase *p_oNCI, xercesc::DOMElement *p_oElement)=0
 Does any desired setup.
 
virtual ~clTemperatureEffectBase ()
 Destructor.
 
bool DoesRequireTargetDiam ()
 

Protected Attributes

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

Detailed Description

Provides a base for objects that calculate a temperature effect.

Constructor & Destructor Documentation

clTemperatureEffectBase::clTemperatureEffectBase ( )
inline

Constructor.

Sets defaults.

virtual clTemperatureEffectBase::~clTemperatureEffectBase ( )
inlinevirtual

Destructor.

Member Function Documentation

virtual float clTemperatureEffectBase::CalculateTemperatureEffect ( clPlot p_oPlot,
int  iSpecies 
)
pure virtual

Calculates temperature effect for a particular species.

Parameters
p_oPlotPlot object for querying for temperature values.
iSpeciesSpecies for which to calculate temperature effect.

Implemented in clTemperatureEffectDoubleLogistic, clTemperatureEffectWeibull, and clTemperatureEffectNone.

bool clTemperatureEffectBase::DoesRequireTargetDiam ( )
inline
virtual void clTemperatureEffectBase::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 clTemperatureEffectDoubleLogistic, clTemperatureEffectWeibull, and clTemperatureEffectNone.

Member Data Documentation

bool clTemperatureEffectBase::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: