SORTIE Core C++ Documentation
Public Member Functions | List of all members
clPrecipitationEffectNone Class Reference

Provides no precipitation effect (returns a value of 1). More...

#include <PrecipitationEffectNone.h>

Inheritance diagram for clPrecipitationEffectNone:
clPrecipitationEffectBase

Public Member Functions

double CalculatePrecipitationEffect (clPlot *p_oPlot, int iSpecies)
 Calculates precipitation effect for a particular species. More...
 
void DoSetup (clTreePopulation *p_oPop, clBehaviorBase *p_oNCI, xercesc::DOMElement *p_oElement)
 Does any desired setup. More...
 
- Public Member Functions inherited from clPrecipitationEffectBase
 clPrecipitationEffectBase ()
 Constructor. More...
 
virtual ~clPrecipitationEffectBase ()
 Destructor. More...
 
bool DoesRequireTargetDiam ()
 

Additional Inherited Members

- Public Types inherited from clPrecipitationEffectBase
enum  precipType { mean_precip, seasonal_precip, water_deficit }
 Precipitation type. More...
 
- Protected Attributes inherited from clPrecipitationEffectBase
bool bRequiresTargetDiam
 Whether or not this effect depends on a target diameter being available. More...
 

Detailed Description

Provides no precipitation effect (returns a value of 1).

Copyright 2013 Charles D. Canham.

Author
Lora E. Murphy


Edit history:
--------------—
June 13, 2013 - Created for transferal of Weibull Climate Growth to the NCI framework (LEM)

Member Function Documentation

◆ CalculatePrecipitationEffect()

double clPrecipitationEffectNone::CalculatePrecipitationEffect ( clPlot p_oPlot,
int  iSpecies 
)
inlinevirtual

Calculates precipitation effect for a particular species.

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

Implements clPrecipitationEffectBase.

◆ DoSetup()

void clPrecipitationEffectNone::DoSetup ( clTreePopulation p_oPop,
clBehaviorBase p_oNCI,
xercesc::DOMElement *  p_oElement 
)
inlinevirtual

Does any desired setup.

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

Implements clPrecipitationEffectBase.


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