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

Class that provides no NCI term (value of 1). More...

#include <NCITermNone.h>

Inheritance diagram for clNCITermNone:
clNCITermBase

Public Member Functions

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

Additional Inherited Members

- Protected Attributes inherited from clNCITermBase
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

Class that provides no NCI term (value of 1).

Member Function Documentation

◆ CalculateNCITerm()

ncivals clNCITermNone::CalculateNCITerm ( clTree p_oTree,
clTreePopulation p_oPop,
clPlot p_oPlot,
const float &  fX,
const float &  fY,
const int &  iSpecies 
)
inlinevirtual

Calculates NCI term.

Parameters
p_oTreeTree for which to calculate NCI. If bRequiresTargetDiam is false, be prepared for this to be NULL.
p_oPopTree population.
p_oPlotPlot object.
fXX coordinate for which to calculate NCI. Needed if p_oTree is NULL.
fYY coordinate for which to calculate NCI. Needed if p_oTree is NULL.
iSpeciesSpecies for which to calculate NCI. Needed if p_oTree is NULL.

Implements clNCITermBase.

◆ DoSetup()

void clNCITermNone::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 clNCITermBase.


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