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

#include <TemperatureEffectBase.h>

Inheritance diagram for clTemperatureEffectBase:

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

virtual double	CalculateTemperatureEffect (clPlot *p_oPlot, int iSpecies)=0
	Calculates temperature 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	~clTemperatureEffectBase ()
	Destructor. More...

bool	DoesRequireTargetDiam ()

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 a temperature effect.

Constructor & Destructor Documentation

◆ clTemperatureEffectBase()

clTemperatureEffectBase::clTemperatureEffectBase ( )

inline

Constructor.

Sets defaults.

◆ ~clTemperatureEffectBase()

virtual clTemperatureEffectBase::~clTemperatureEffectBase ( )

inlinevirtual

Destructor.

Member Function Documentation

◆ CalculateTemperatureEffect()

virtual double clTemperatureEffectBase::CalculateTemperatureEffect	(	clPlot *	p_oPlot,
		int	iSpecies
	)

pure virtual

Calculates temperature effect for a particular species.

Parameters

p_oPlot	Plot object for querying for temperature values.
iSpecies	Species for which to calculate temperature effect.

Implemented in clTemperatureEffectDoubleLogistic, clTemperatureEffectWeibull, and clTemperatureEffectNone.

◆ DoesRequireTargetDiam()

bool clTemperatureEffectBase::DoesRequireTargetDiam ( )

inline

◆ DoSetup()

virtual void clTemperatureEffectBase::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 clTemperatureEffectDoubleLogistic, clTemperatureEffectWeibull, and clTemperatureEffectNone.

Member Data Documentation

◆ bRequiresTargetDiam

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:

TemperatureEffectBase.h

Public Member Functions

Protected Attributes