SORTIE Core C++ Documentation
Public Member Functions | List of all members
clDamageEffectBase Class Referenceabstract

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

#include <DamageEffectBase.h>

Inheritance diagram for clDamageEffectBase:
clDamageEffectDefault clDamageEffectNone

Public Member Functions

virtual double CalculateDamageEffect (clTree *p_oTree)=0
 Calculates damage effect. More...
 
virtual void DoSetup (clTreePopulation *p_oPop, clBehaviorBase *p_oNCI, xercesc::DOMElement *p_oElement)=0
 Does any desired setup. More...
 
virtual void PreCalcs (clTreePopulation *p_oPop)
 Performs calculations like either clGrowthBase::PreGrowthCalcs or clMortalityBase::PreMortCalcs. More...
 
virtual ~clDamageEffectBase ()
 Destructor. More...
 

Detailed Description

Provides a base for objects that calculate a damage effect.

Constructor & Destructor Documentation

◆ ~clDamageEffectBase()

virtual clDamageEffectBase::~clDamageEffectBase ( )
inlinevirtual

Destructor.

Member Function Documentation

◆ CalculateDamageEffect()

virtual double clDamageEffectBase::CalculateDamageEffect ( clTree p_oTree)
pure virtual

Calculates damage effect.

Parameters
p_oTreeTree for which to calculate damage effect.

Implemented in clDamageEffectDefault, and clDamageEffectNone.

◆ DoSetup()

virtual void clDamageEffectBase::DoSetup ( clTreePopulation p_oPop,
clBehaviorBase p_oNCI,
xercesc::DOMElement *  p_oElement 
)
pure virtual

Does any desired setup.

Parameters
p_oPopTree population.
p_oNCINCI behavior object.
p_oElementRoot element of the behavior.

Implemented in clDamageEffectDefault, and clDamageEffectNone.

◆ PreCalcs()

virtual void clDamageEffectBase::PreCalcs ( clTreePopulation p_oPop)
inlinevirtual

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


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