Mortality base - Version 1.1. More...

#include <MortalityBase.h>

Inheritance diagram for clMortalityBase:

Public Member Functions
	clMortalityBase (clSimManager *p_oSimManager)
	Constructor. More...

virtual	~clMortalityBase ()
	Destructor. More...

void	Action ()
	Performs mortality calculations. More...

virtual deadCode	DoMort (clTree *p_oTree, const float &fDbh, const short int &iSpecies)=0
	Determines whether or not a tree dies. More...

clMortalityOrg *	GetMortOrg ()
	Gets the mortality org object. More...

void	RegisterTreeDataMembers ()
	Triggers the mortality data member registrations. More...

short int	GetNewTreeInts ()
	Overridden from clBehaviorBase. More...

bool	UsesThisMortality (short int iSp, short int iTp)
	Whether or not a species/type combo uses this mortality object. More...

virtual void	PreMortCalcs (clTreePopulation *p_oPop)
	Performs calculations before any trees have been killed. More...

Public Member Functions inherited from clBehaviorBase
virtual float	GetBehaviorVersion ()
	Gets the behavior version number. More...

	clBehaviorBase (clSimManager *p_oSimManager)
	Constructor. More...

virtual	~clBehaviorBase ()
	Destructor. More...

virtual short int	ValidateVersionNumber (float fTestVersion)
	Makes sure that the version number of a file passed is between the minimum and current version numbers. More...

virtual void	SetSpeciesTypeCombos (short int iNumCombos, stcSpeciesTypeCombo *p_whatCombos)
	Sets the species/type combos for a behavior. More...

virtual void	SetNameData (std::string sNameString)
	Sets the string for the parameter file behavior. More...

virtual short int	GetNewTreeFloats ()
	Gets the number of new tree float data members this behavior wants to register. More...

virtual short int	GetNewTreeChars ()
	Gets the number of new tree character data members this behavior wants to register. More...

virtual short int	GetNewTreeBools ()
	Gets the number of new tree bool data members this behavior wants to register. More...

virtual short int	GetNumSpeciesTypeCombos ()
	Gets the number of species/type combos to which this behavior applies. More...

virtual short int	GetNumBehaviorSpecies ()
	Gets the number of unique tree species to which this behavior applies. More...

struct stcSpeciesTypeCombo	GetSpeciesTypeCombo (short int iIndex)
	Gets one of this behavior's type/species combos. More...

virtual short int	GetBehaviorSpecies (short int iIndex)
	Gets one of the behavior's species. More...

short int	GetBehaviorListNumber ()
	Gets the behavior list number for this behavior, which differentiates between multiple copies of the behavior in the behavior list. More...

void	SetBehaviorListNumber (short int iNumber)
	Sets the behavior list number for this behavior, which differentiates between multiple copies of the behavior in the behavior list. More...

std::string	FormatSpeciesTypeQueryString ()
	Formats the string for species/types query. More...

virtual DOMElement *	GetParentParametersElement (xercesc::DOMDocument *p_oDoc)
	This will get the correct set of parameters for this behavior based on the behavior list position number. More...

Public Member Functions inherited from clWorkerBase
	clWorkerBase (clSimManager *p_oSimManager)
	Constructor. More...

virtual	~clWorkerBase ()
	Destructor. More...

std::string	GetName ()
	Gets the object's namestring. More...

clSimManager *	GetSimManager ()

void	DoObjectSetup (xercesc::DOMDocument *p_oDoc, fileType iFileType)
	Triggers the setup process. More...

virtual void	TimestepCleanup ()
	Performs any necessary cleanup operations at the end of a timestep. More...

virtual void	EndOfRunCleanup ()
	Performs any necessary cleanup operations at the end of a run. More...

Protected Member Functions
void	GetData (xercesc::DOMDocument *p_oDoc)
	Triggers all mortality setup. More...

void	PopulateUsesThisMortality ()
	Declares and populates the mp_bUsesThisMortality array. More...

virtual void	DoShellSetup (xercesc::DOMDocument *p_oDoc)
	If a descendent class has specific setup needs, it can overload this function. More...

Protected Member Functions inherited from clWorkerBase
void	AssembleFileCode (int iFileType, int iFileVersion, char *cCode)
	Creates the proper identifying filecode for an XML file. More...

Protected Attributes
short int	m_iNumTotalSpecies
	Keep a copy for the constructor. More...

bool	m_bHooked
	Whether or not this shell object is hooked to clMortalityOrg. More...

bool **	mp_bUsesThisMortality
	2D array, species by type, of whether or not this mortality shell applies to a given species/type combo. More...

Protected Attributes inherited from clBehaviorBase
short int	m_iNumSpeciesTypeCombos
	How many type/species combos a behavior will act on. More...

short int	m_iNumBehaviorSpecies
	How many distinct species are in the combo list - important for filling species-specific values from parameter file. More...

short int *	mp_iWhatSpecies
	List of distinct species - for filling species-specific values from parameter file. More...

stcSpeciesTypeCombo *	mp_whatSpeciesTypeCombos
	Array of species/type combos that the behavior will act on. More...

short int	m_iNewTreeInts
	The number of new tree integer data members this behavior wants to add. More...

short int	m_iNewTreeFloats
	The number of new tree float data members this behavior wants to add. More...

short int	m_iNewTreeChars
	The number of new tree character data members this behavior wants to add. More...

short int	m_iNewTreeBools
	The number of new tree boolean data members this behavior wants to add. More...

short int	m_iBehaviorListNumber
	The number of this behavior in the behavior list, to differentiate between possible multiple copies of this behavior. More...

float	m_fVersionNumber
	Version number - this will be rounded to 2 digits after the decimal place. More...

std::string	m_sXMLRoot
	XML root that encloses the parameters for this behavior. More...

float	m_fMinimumVersionNumber
	Minimum version number - this behavior will run parameter data for a file marked between this number and the current version number, inclusive. More...

Protected Attributes inherited from clWorkerBase
std::string	m_sNameString
	If a behavior has registered a command line command with the sim manager, this allows it to be called. More...

clSimManager *	mp_oSimManager
	Pointer to the simulation manager object. More...

int *	mp_iAllowedFileTypes
	List of the input file types this object can handle. More...

int	m_iNumAllowedTypes
	Number of input file types this object can handle. More...

Static Protected Attributes
static clMortalityOrg *	mp_oMortalityOrg
	clMortalityOrg object. More...

Friends
class	clMortalityOrg

Detailed Description

Mortality base - Version 1.1.

This is the base class for mortality behavior shell classes. These shells each evaluate different kinds mortality for a tree.

The bulk of the organizational work is done by the class clMortalityOrg, which calls the needed shell functions for each tree. The clMortalityOrg object hooks into one particular growth shell object, which calls clMortalityOrg when it is triggered by the behavior manager. It does not particularly matter which shell object is hooked; the first one will suffice. Any non-hooked shells do nothing when their Action() and other functions are called.

Every object made from this class or a descendent class must have the string "mortshell" in its namestring somewhere.

Author: Lora E. Murphy

Edit history:
--------------—
April 28, 2004 - Submitted as beta (LEM)
April 29, 2004 - Updated to version 1.1 by adding a new mortality tree data member code for a death flag
July 21, 2004 - Fixed a bug in data member registrations (LEM)
April 5, 2005 - Added a pre-calculation stage for the sake of NCI (LEM)
February 8, 2008 - Changed mortality flags from simple booleans to reason codes (LEM)

Constructor & Destructor Documentation

◆ clMortalityBase()

clMortalityBase::clMortalityBase ( clSimManager * p_oSimManager )

Constructor.

Checks to see if the mortality org object has been created - if not, it creates it.

Parameters

p_oSimManager Sim Manager object.

◆ ~clMortalityBase()

virtual clMortalityBase::~clMortalityBase ( )

virtual

Destructor.

Deletes the growth org object if it was the hooked object.

Member Function Documentation

◆ Action()

void clMortalityBase::Action ( )

virtual

Performs mortality calculations.

This will be the same for all descendent classes - they do not need to override. If a particular object is hooked, it calls the growth org object's DoGrowthAssignments. Otherwise it does nothing.

Reimplemented from clBehaviorBase.

◆ DoMort()

virtual deadCode clMortalityBase::DoMort	(	clTree *	p_oTree,
		const float &	fDbh,
		const short int &	iSpecies
	)

pure virtual

Determines whether or not a tree dies.

This must be overridden by all child classes.

Parameters

p_oTree	Tree being evaluated. It should not be modified, but will be available in case extra data is needed.
fDbh	DBH of tree being evaluated - for seedlings will be 0
iSpecies	Species of the tree being evaluated

Returns: Why the tree is dead (including the code meaning "not dead").

Implemented in clAggregatedMortality, clResourceMortality, clExpResourceMortality, clInsectInfestationMortality, clClimateCompDepNeighborhoodSurvival, clLogisticBiLevelMortality, clDensitySelfThinning, clTempDependentNeighborhoodSurvival, clWeibullSnagMort, clHeightGLIWeibullMortality, clSuppressionDurationMort, clStochasticBiLevelMortality, clBrowsedStochasticMortality, clDensitySelfThinningGompertz, clGMFMort, clSelfThinMort, clPostHarvestSkiddingMort, clNCIMasterMortality, clSenescenceMort, clSizeDependentLogisticMortality, clBCMort, clCompetitionMort, and clStochasticMort.

◆ DoShellSetup()

virtual void clMortalityBase::DoShellSetup ( xercesc::DOMDocument * p_oDoc )

inlineprotectedvirtual

If a descendent class has specific setup needs, it can overload this function.

Parameters

p_oDoc DOM tree of parsed input file.

Reimplemented in clClimateCompDepNeighborhoodSurvival, clAggregatedMortality, clResourceMortality, clTempDependentNeighborhoodSurvival, clExpResourceMortality, clInsectInfestationMortality, clNCIMasterMortality, clLogisticBiLevelMortality, clHeightGLIWeibullMortality, clWeibullSnagMort, clDensitySelfThinning, clSuppressionDurationMort, clBrowsedStochasticMortality, clStochasticBiLevelMortality, clGMFMort, clSelfThinMort, clPostHarvestSkiddingMort, clDensitySelfThinningGompertz, clSenescenceMort, clCompetitionMort, clSizeDependentLogisticMortality, clBCMort, and clStochasticMort.

◆ GetData()

void clMortalityBase::GetData ( xercesc::DOMDocument * p_oDoc )

protectedvirtual

Triggers all mortality setup.

This will be the same for all descendent classes. If a particular object is hooked, it calls the growth org object's DoSetup() function, which calls the function DoShellSetup() - if a descendent class has specific setup needs, it can overload that function.

Parameters

p_oDoc DOM tree of parsed input file.

Implements clWorkerBase.

◆ GetMortOrg()

clMortalityOrg* clMortalityBase::GetMortOrg ( )

inline

Gets the mortality org object.

Returns: Mortality org object.

◆ GetNewTreeInts()

short int clMortalityBase::GetNewTreeInts ( )

virtual

Overridden from clBehaviorBase.

We want to register one int data member for each species/type combo that is applied to mortality. If this is a hooked object, this calls clMortalityOrg::UpdateDataMemberRegistrations(). Hooked or not, it then returns m_iNewTreeInts as usual.

Returns: Number of new tree ints, or zero if no new members are to be registered.

Reimplemented from clBehaviorBase.

◆ PopulateUsesThisMortality()

void clMortalityBase::PopulateUsesThisMortality ( )

protected

Declares and populates the mp_bUsesThisMortality array.

◆ PreMortCalcs()

virtual void clMortalityBase::PreMortCalcs ( clTreePopulation * p_oPop )

inlinevirtual

Performs calculations before any trees have been killed.

Override this function to perform some processing before any mortality has been applied. There are no guarantees as to what order the behaviors will be called for this function, but it is guaranteed that no trees will have been killed for mortality. To make this guarantee worth something, DO NOT KILL ANY TREES in this function!

Reimplemented in clAggregatedMortality, clClimateCompDepNeighborhoodSurvival, clTempDependentNeighborhoodSurvival, clNCIMasterMortality, and clPostHarvestSkiddingMort.

◆ RegisterTreeDataMembers()

void clMortalityBase::RegisterTreeDataMembers ( )

virtual

Triggers the mortality data member registrations.

If this is the hooked mortality object, then clMortalityOrg::DoDataMemberRegistrations is called.

Reimplemented from clBehaviorBase.

◆ UsesThisMortality()

bool clMortalityBase::UsesThisMortality	(	short int	iSp,
		short int	iTp
	)

inline

Whether or not a species/type combo uses this mortality object.

Parameters

iSp	Species.
iTp	Tree type.

Returns: True if this combo uses this mortality object, false if not.

Friends And Related Function Documentation

◆ clMortalityOrg

friend class clMortalityOrg

friend

Member Data Documentation

◆ m_bHooked

bool clMortalityBase::m_bHooked

protected

Whether or not this shell object is hooked to clMortalityOrg.

clMortalityOrg will set this flag.

◆ m_iNumTotalSpecies

short int clMortalityBase::m_iNumTotalSpecies

protected

Keep a copy for the constructor.

◆ mp_bUsesThisMortality

bool** clMortalityBase::mp_bUsesThisMortality

protected

2D array, species by type, of whether or not this mortality shell applies to a given species/type combo.

◆ mp_oMortalityOrg

clMortalityOrg* clMortalityBase::mp_oMortalityOrg

staticprotected

clMortalityOrg object.

This pointer is held in common by all shells.

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

MortalityBase.h

Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ clMortalityBase()

◆ ~clMortalityBase()

Member Function Documentation

◆ Action()

◆ DoMort()

◆ DoShellSetup()

◆ GetData()

◆ GetMortOrg()

◆ GetNewTreeInts()

◆ PopulateUsesThisMortality()

◆ PreMortCalcs()

◆ RegisterTreeDataMembers()

◆ UsesThisMortality()

Friends And Related Function Documentation

◆ clMortalityOrg

Member Data Documentation

◆ m_bHooked

◆ m_iNumTotalSpecies

◆ mp_bUsesThisMortality

◆ mp_oMortalityOrg