Class that provides no crowding effect (value of 1). More...

#include <CrowdingEffectNone.h>

Inheritance diagram for clCrowdingEffectNone:

Public Member Functions
double	CalculateCrowdingEffect (clTree *p_oTree, const float &fDiam, const clNCITermBase::ncivals nci, const int &iSpecies)
	Returns a constant crowding effect of 1. More...

void	DoSetup (clTreePopulation p_oPop, clBehaviorBase p_oNCI, clNCIBehaviorBase p_oNCIBase, xercesc::DOMElement p_oElement)
	No setup required. More...

Public Member Functions inherited from clCrowdingEffectBase
	clCrowdingEffectBase ()
	Constructor. More...

virtual	~clCrowdingEffectBase ()
	Destructor. More...

virtual void	PreCalcs (clTreePopulation *p_oPop)
	Performs calculations like either clGrowthBase::PreGrowthCalcs or clMortalityBase::PreMortCalcs. More...

bool	DoesRequireTargetDiam ()

Additional Inherited Members
Protected Attributes inherited from clCrowdingEffectBase
bool	m_bRequiresTargetDiam
	Whether or not this effect depends on a target diameter being available. More...

bool	m_b2ValNCI
	Whether it's a two-value NCI. More...

Detailed Description

Class that provides no crowding effect (value of 1).

Member Function Documentation

double clCrowdingEffectNone::CalculateCrowdingEffect	(	clTree *	p_oTree,
		const float &	fDiam,
		const clNCITermBase::ncivals	nci,
		const int &	iSpecies
	)

inlinevirtual

Returns a constant crowding effect of 1.

Parameters

p_oTree	Tree for which to calculate crowding effect. If bRequiresTargetDiam is false, be prepared for this to be NULL.
fDiam	Diameter of tree. May not be the same as the one recorded in the tree record if it is being updated for consecutive years in a timestep.
nci	NCI term. May be 0 if NCI not used.
iSpecies	Species for which to calculate effect. This is separate in case p_oTree is NULL because there is no target.

void clCrowdingEffectNone::DoSetup	(	clTreePopulation *	p_oPop,
		clBehaviorBase *	p_oNCI,
		clNCIBehaviorBase *	p_oNCIBase,
		xercesc::DOMElement *	p_oElement
	)

inlinevirtual

No setup required.

Parameters

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