Tree Killer - Version 2.0. More...

#include <TreeRemover.h>

Inheritance diagram for clTreeRemover:

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

	~clTreeRemover ()
	Destructor. More...

void	Action ()
	Does all the tree killin'. More...

void	GetData (xercesc::DOMDocument *p_oDoc)
	Gets the data member codes for the "dead" data member. 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	RegisterTreeDataMembers ()
	Registers tree data members. 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	GetNewTreeInts ()
	Gets the number of new tree integer data members this behavior wants to register. 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 Attributes
clTreePopulation *	mp_oPop
	Stashed pointer to avoid having to keep getting it. More...

short int **	mp_iDeadCodes
	Return codes for the "dead" tree int data member variable. More...

short int	m_iNumTotalSpecies
	Total number of species - for destructor. 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...

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

Detailed Description

Tree Killer - Version 2.0.

This behavior will remove all trees that have been marked for death by mortality. If a tree has a non-not dead value in its "dead" data member, this will direct it to be removed from the tree population by calling clTreePopulation::KillTree(). The reason code is that which is set in "dead".

If this is applied to any species/type combo that does not have "dead" registered, an error will be thrown during setup.

The namestring and parameter call string for this behavior are both "removedead".

Author: Lora E. Murphy

Edit history:
--------------—
October 20, 2011 - Wiped the slate clean for SORTIE 7.0 (LEM)

Constructor & Destructor Documentation

◆ clTreeRemover()

clTreeRemover::clTreeRemover ( clSimManager * p_oSimManager )

Constructor.

Parameters

p_oSimManager Sim Manager object.

◆ ~clTreeRemover()

clTreeRemover::~clTreeRemover ( )

Destructor.

Member Function Documentation

◆ Action()

void clTreeRemover::Action ( )

virtual

Does all the tree killin'.

This goes through all trees in the tree population to which this behavior is applied, and if any have a non-notdead value in their "dead" data member, they are passed to clTreePopulation::KillTree() with that reason code.

Reimplemented from clBehaviorBase.

◆ GetData()

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

virtual

Gets the data member codes for the "dead" data member.

Parameters

p_oDoc DOM tree of parsed input file.

Exceptions

modelErr if a tree type/species combo to which this behavior is applied has no "dead" code.

Implements clWorkerBase.

Member Data Documentation

◆ m_iNumTotalSpecies

short int clTreeRemover::m_iNumTotalSpecies

protected

Total number of species - for destructor.

◆ mp_iDeadCodes

short int** clTreeRemover::mp_iDeadCodes

protected

Return codes for the "dead" tree int data member variable.

Array size is species by type (even if not every species and type is represented)

◆ mp_oPop

clTreePopulation* clTreeRemover::mp_oPop

protected

Stashed pointer to avoid having to keep getting it.

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

TreeRemover.h

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ clTreeRemover()

◆ ~clTreeRemover()

Member Function Documentation

◆ Action()

◆ GetData()

Member Data Documentation

◆ m_iNumTotalSpecies

◆ mp_iDeadCodes

◆ mp_oPop