clNCIBehaviorBase Class Reference

NCI behavior base. More...

#include <NCIBehaviorBase.h>

Inheritance diagram for clNCIBehaviorBase:

Public Member Functions
	clNCIBehaviorBase ()
	Constructor. More...
	~clNCIBehaviorBase ()
	Destructor. More...
clShadingEffectBase *	GetShadingEffect ()
	Get the shading effect object. More...
clDamageEffectBase *	GetDamageEffect ()
	Get the damage effect object. More...
clSizeEffectBase *	GetSizeEffect ()
	Get the size effect object. More...
clCrowdingEffectBase *	GetCrowdingEffect ()
	Get the crowding effect object. More...
clNCITermBase *	GetNCITerm ()
	Get the NCI term object. More...
clPrecipitationEffectBase *	GetPrecipEffect ()
	Get the precipitation effect object. More...
clTemperatureEffectBase *	GetTempEffect ()
	Get the temperature effect object. More...
clNitrogenEffectBase *	GetNEffect ()
	Get the nitrogen effect object. More...
clInfectionEffectBase *	GetInfectionEffect ()
	Get the infection effect object. More...

Protected Member Functions
void	ReadParameterFile (xercesc::DOMElement *p_oElement, clTreePopulation *p_oPop, clBehaviorBase *p_oNCI, bool bUsingDiam)
	Reads data from the parameter file for the effects objects. More...

Protected Attributes
clShadingEffectBase *	mp_oShadingEffect
	The shading effect object. More...
clDamageEffectBase *	mp_oDamageEffect
	The damage effect object. More...
clSizeEffectBase *	mp_oSizeEffect
	The size effect object. More...
clCrowdingEffectBase *	mp_oCrowdingEffect
	The crowding effect object. More...
clNCITermBase *	mp_oNCITerm
	The NCI term object. More...
clPrecipitationEffectBase *	mp_oPrecipEffect
	The precipitation effect object. More...
clTemperatureEffectBase *	mp_oTempEffect
	The temperature effect object. More...
clNitrogenEffectBase *	mp_oNEffect
	The nitrogen effect object. More...
clInfectionEffectBase *	mp_oInfectionEffect
	The infection effect object. More...

Detailed Description

NCI behavior base.

This is a base class for classes that are going to implement NCI functions.

Copyright 2012 Charles D. Canham.

Author

Lora E. Murphy

Edit history:
--------------—
December 18, 2013: Created (LEM)

Constructor & Destructor Documentation

clNCIBehaviorBase()

clNCIBehaviorBase::clNCIBehaviorBase

(

)

Constructor.

~clNCIBehaviorBase()

clNCIBehaviorBase::~clNCIBehaviorBase

(

)

Destructor.

Frees memory.

Member Function Documentation

GetCrowdingEffect()

clCrowdingEffectBase* clNCIBehaviorBase::GetCrowdingEffect ( )

inline

Get the crowding effect object.

GetDamageEffect()

clDamageEffectBase* clNCIBehaviorBase::GetDamageEffect ( )

inline

Get the damage effect object.

GetInfectionEffect()

clInfectionEffectBase* clNCIBehaviorBase::GetInfectionEffect ( )

inline

Get the infection effect object.

GetNCITerm()

clNCITermBase* clNCIBehaviorBase::GetNCITerm ( )

inline

Get the NCI term object.

GetNEffect()

clNitrogenEffectBase* clNCIBehaviorBase::GetNEffect ( )

inline

Get the nitrogen effect object.

GetPrecipEffect()

clPrecipitationEffectBase* clNCIBehaviorBase::GetPrecipEffect ( )

inline

Get the precipitation effect object.

GetShadingEffect()

clShadingEffectBase* clNCIBehaviorBase::GetShadingEffect ( )

inline

Get the shading effect object.

GetSizeEffect()

clSizeEffectBase* clNCIBehaviorBase::GetSizeEffect ( )

inline

Get the size effect object.

GetTempEffect()

clTemperatureEffectBase* clNCIBehaviorBase::GetTempEffect ( )

inline

Get the temperature effect object.

ReadParameterFile()

void clNCIBehaviorBase::ReadParameterFile ( xercesc::DOMElement *  p_oElement, clTreePopulation *  p_oPop, clBehaviorBase *  p_oNCI, bool  bUsingDiam  )

protected

Reads data from the parameter file for the effects objects.

This allows for a child behavior that does not use individual targets with diameters. If that is the case, this will not set a size effect and will throw errors for all effects that depend on a target diameter.

Parameters

p_oElement	Parent element for this behavior.
p_oPop	Tree population object.
p_oNCI	Parent behavior.
bUsingDiam	If false, a behavior has no target diameter.

Exceptions

modelErr

if bUsingDiam is false and a user requests an effect that depends on a target diameter.

Member Data Documentation

mp_oCrowdingEffect

clCrowdingEffectBase* clNCIBehaviorBase::mp_oCrowdingEffect

protected

The crowding effect object.

mp_oDamageEffect

clDamageEffectBase* clNCIBehaviorBase::mp_oDamageEffect

protected

The damage effect object.

mp_oInfectionEffect

clInfectionEffectBase* clNCIBehaviorBase::mp_oInfectionEffect

protected

The infection effect object.

mp_oNCITerm

clNCITermBase* clNCIBehaviorBase::mp_oNCITerm

protected

The NCI term object.

mp_oNEffect

clNitrogenEffectBase* clNCIBehaviorBase::mp_oNEffect

protected

The nitrogen effect object.

mp_oPrecipEffect

clPrecipitationEffectBase* clNCIBehaviorBase::mp_oPrecipEffect

protected

The precipitation effect object.

mp_oShadingEffect

clShadingEffectBase* clNCIBehaviorBase::mp_oShadingEffect

protected

The shading effect object.

mp_oSizeEffect

clSizeEffectBase* clNCIBehaviorBase::mp_oSizeEffect

protected

The size effect object.

mp_oTempEffect

clTemperatureEffectBase* clNCIBehaviorBase::mp_oTempEffect

protected

The temperature effect object.

---

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

• NCIBehaviorBase.h