clNCITermBase Class Reference

Provides a base for objects that calculate the NCI term(s). More...

#include <NCITermBase.h>

Inheritance diagram for clNCITermBase:

Classes
struct	ncivals
	Holds multiple values for NCI. More...

Public Member Functions
	clNCITermBase ()
	Constructor. More...
int	GetNumberNCIs ()
virtual void	PreCalcs (clTreePopulation *p_oPop)
	Performs calculations like either clGrowthBase::PreGrowthCalcs or clMortalityBase::PreMortCalcs. More...
virtual ncivals	CalculateNCITerm (clTree *p_oTree, clTreePopulation *p_oPop, clPlot *p_oPlot, const float &fX, const float &fY, const int &iSpecies)=0
	Calculates NCI term. More...
virtual void	DoSetup (clTreePopulation *p_oPop, clBehaviorBase *p_oNCI, xercesc::DOMElement *p_oElement)=0
	Does any desired setup. More...
virtual	~clNCITermBase ()
	Destructor. More...
bool	DoesRequireTargetDiam ()

Protected Attributes
bool	bRequiresTargetDiam
	Whether or not this effect depends on a target diameter being available. More...
int	iNumNCIs
	Number of NCI values calculated and populated into ncivals. More...

Detailed Description

Provides a base for objects that calculate the NCI term(s).

The default is that objects descended from this class can handle any tree type. If this is not the case, child objects must throw the appropriate error during setup.

Constructor & Destructor Documentation

clNCITermBase()

clNCITermBase::clNCITermBase ( )

inline

Constructor.

Sets defaults.

~clNCITermBase()

virtual clNCITermBase::~clNCITermBase ( )

inlinevirtual

Destructor.

Member Function Documentation

CalculateNCITerm()

virtual ncivals clNCITermBase::CalculateNCITerm ( clTree *  p_oTree, clTreePopulation *  p_oPop, clPlot *  p_oPlot, const float &  fX, const float &  fY, const int &  iSpecies  )

pure virtual

Calculates NCI term.

Parameters

p_oTree	Tree for which to calculate NCI. If bRequiresTargetDiam is false, be prepared for this to be NULL.
p_oPop	Tree population.
p_oPlot	Plot object.
fX	X coordinate for which to calculate NCI. Needed if p_oTree is NULL.
fY	Y coordinate for which to calculate NCI. Needed if p_oTree is NULL.
iSpecies	Species for which to calculate NCI. Needed if p_oTree is NULL.

Implemented in clNCITermWithNeighborDamage, clNCITermNCIBARatio, clNCIWithSeedlings, clNCITermDefault, clNCITermBARatioDBHDefault, clNCITermBARatio, clNCINeighborBA, clNCILargerNeighbors, and clNCITermNone.

DoesRequireTargetDiam()

bool clNCITermBase::DoesRequireTargetDiam ( )

inline

DoSetup()

virtual void clNCITermBase::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 clNCITermNCITempDepBARatio, clNCITermWithNeighborDamage, clNCITermNCIBARatio, clNCIWithSeedlings, clNCITermDefault, clNCITermBARatioDBHDefault, clNCITermBARatio, clNCINeighborBA, clNCILargerNeighbors, and clNCITermNone.

GetNumberNCIs()

int clNCITermBase::GetNumberNCIs ( )

inline

PreCalcs()

virtual void clNCITermBase::PreCalcs ( clTreePopulation *  p_oPop )

inlinevirtual

Performs calculations like either clGrowthBase::PreGrowthCalcs or clMortalityBase::PreMortCalcs.

Reimplemented in clNCITermNCITempDepBARatio.

Member Data Documentation

bRequiresTargetDiam

bool clNCITermBase::bRequiresTargetDiam

protected

Whether or not this effect depends on a target diameter being available.

iNumNCIs

int clNCITermBase::iNumNCIs

protected

Number of NCI values calculated and populated into ncivals.

---

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

• NCITermBase.h