clTreeRemover Class Reference

Tree Killer - Version 2.0. More...

#include <TreeRemover.h>

Inheritance diagram for clTreeRemover:

clBehaviorBase clWorkerBase

List of all members.

Public Member Functions

 clTreeRemover (clSimManager *p_oSimManager)
 Constructor.
 ~clTreeRemover ()
 Destructor.
void Action ()
 Does all the tree killin'.
void GetData (xercesc::DOMDocument *p_oDoc)
 Gets the data member codes for the "dead" data member.

Protected Attributes

clTreePopulationmp_oPop
 Stashed pointer to avoid having to keep getting it.
short int ** mp_iDeadCodes
 Return codes for the "dead" tree int data member variable.
short int m_iNumTotalSpecies
 Total number of species - for destructor.


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".

Copyright 2003 Charles D. Canham.

Author:
Lora E. Murphy

Edit history:
-----------------
April 28, 2004 - Submitted as beta, as clLGMTreeKiller (LEM)
April 29, 2004 - Released version 2 (LEM) - based on mortality's tree data member instead of light's - renamed this class
February 8, 2008 - Changed mortality flags from simple booleans to reason codes (LEM)

Constructor & Destructor Documentation

clTreeRemover::clTreeRemover ( clSimManager p_oSimManager  ) 

Constructor.

Parameters:
p_oSimManager Sim Manager object.

clTreeRemover::~clTreeRemover (  ) 

Destructor.


Member Function Documentation

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.

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

Stashed pointer to avoid having to keep getting it.

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)

short int clTreeRemover::m_iNumTotalSpecies [protected]

Total number of species - for destructor.


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

Generated on Wed Oct 28 13:58:50 2009 for SORTIE Core C++ Documentation by  doxygen 1.5.6