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

#include <NitrogenEffectBase.h>

Inheritance diagram for clNitrogenEffectBase:

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

virtual	~clNitrogenEffectBase ()
	Destructor. More...

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

Constructor & Destructor Documentation

◆ clNitrogenEffectBase()

clNitrogenEffectBase::clNitrogenEffectBase ( )

inline

Constructor.

Sets defaults.

◆ ~clNitrogenEffectBase()

virtual clNitrogenEffectBase::~clNitrogenEffectBase ( )

inlinevirtual

Destructor.

Member Function Documentation

◆ CalculateNitrogenEffect()

virtual double clNitrogenEffectBase::CalculateNitrogenEffect	(	clPlot *	p_oPlot,
		int	iSpecies
	)

pure virtual

Calculates nitrogen effect for a particular species.

Parameters

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

Implemented in clNitrogenEffectGaussian, and clNitrogenEffectNone.

◆ DoesRequireTargetDiam()

bool clNitrogenEffectBase::DoesRequireTargetDiam ( )

inline

◆ DoSetup()

virtual void clNitrogenEffectBase::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 clNitrogenEffectGaussian, and clNitrogenEffectNone.

Member Data Documentation

◆ bRequiresTargetDiam

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

NitrogenEffectBase.h

Public Member Functions

Protected Attributes