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

#include <PrecipitationEffectBase.h>

Inheritance diagram for clPrecipitationEffectBase:

Public Types
enum	precipType { mean_precip, seasonal_precip, water_deficit }
	Precipitation type. More...

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

virtual	~clPrecipitationEffectBase ()
	Destructor. More...

virtual double	CalculatePrecipitationEffect (clPlot *p_oPlot, int iSpecies)=0
	Calculates precipitation 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...

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 precipitation effect.

Member Enumeration Documentation

◆ precipType

enum clPrecipitationEffectBase::precipType

Precipitation type.

Enumerator
mean_precip	Mean annual precipitation.
seasonal_precip	Seasonal precipitation.
water_deficit	Water deficit.

Constructor & Destructor Documentation

◆ clPrecipitationEffectBase()

clPrecipitationEffectBase::clPrecipitationEffectBase ( )

inline

Constructor.

Sets defaults.

◆ ~clPrecipitationEffectBase()

virtual clPrecipitationEffectBase::~clPrecipitationEffectBase ( )

inlinevirtual

Destructor.

Member Function Documentation

◆ CalculatePrecipitationEffect()

virtual double clPrecipitationEffectBase::CalculatePrecipitationEffect	(	clPlot *	p_oPlot,
		int	iSpecies
	)

pure virtual

Calculates precipitation effect for a particular species.

Parameters

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

Implemented in clPrecipitationEffectDoubleLogistic, clPrecipitationEffectWeibull, and clPrecipitationEffectNone.

◆ DoesRequireTargetDiam()

bool clPrecipitationEffectBase::DoesRequireTargetDiam ( )

inline

◆ DoSetup()

virtual void clPrecipitationEffectBase::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 clPrecipitationEffectDoubleLogistic, clPrecipitationEffectWeibull, and clPrecipitationEffectNone.

Member Data Documentation

◆ bRequiresTargetDiam

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

PrecipitationEffectBase.h

Public Types

Public Member Functions

Protected Attributes