clGhostTreePopulation Class Reference

GHOST TREE POPULATION CLASS - Version 1. More...

#include <GhostTreePopulation.h>

Inheritance diagram for clGhostTreePopulation:

clPopulationBase clWorkerBase

List of all members.

Public Member Functions

 ~clGhostTreePopulation ()
 Destructor.
 clGhostTreePopulation (clSimManager *p_oSimManager)
 Constructor.
void AddTree (clTree *p_oTree, deadCode iDeadReasonCode)
 Creates a copy of a tree and adds it to this population.
clDeadTreeGetFirstTree ()
 Gets the first tree in the linked list.
void GetData (xercesc::DOMDocument *p_oDoc)
 Not needed.

Protected Member Functions

void TimestepCleanup ()
 Deletes all trees.

Protected Attributes

clDeadTreemp_oTrees
 Linked list of dead trees.

Private Member Functions

 clGhostTreePopulation (const clGhostTreePopulation &oldPop)
 Copy constructor.


Detailed Description

GHOST TREE POPULATION CLASS - Version 1.

This holds dead trees. They are held for a single timestep then eliminated at the end of the timestep. This holds seedlings through snags. Stumps are not kept.

The trees are not sorted, just held in a simple linked list.

Copyright 2010 Charles D. Canham.

Author:
Lora E. Murphy

Edit history:
-----------------
December 21, 2010 - Created (LEM)

Constructor & Destructor Documentation

clGhostTreePopulation::clGhostTreePopulation ( const clGhostTreePopulation oldPop  )  [private]

Copy constructor.

Off limits! It's too much to try to copy all the trees, and too dangerous to allow two objects running around with pointers to the same trees.

clGhostTreePopulation::~clGhostTreePopulation (  ) 

Destructor.

clGhostTreePopulation::clGhostTreePopulation ( clSimManager p_oSimManager  ) 

Constructor.

Parameters:
p_oSimManager Sim Manager object.


Member Function Documentation

void clGhostTreePopulation::AddTree ( clTree p_oTree,
deadCode  iDeadReasonCode 
)

Creates a copy of a tree and adds it to this population.

The original tree is not touched or removed from the old population.

Parameters:
p_oTree tree to copy and add.
iDeadReasonCode Why the tree died.

clDeadTree* clGhostTreePopulation::GetFirstTree (  )  [inline]

Gets the first tree in the linked list.

Returns:
First tree in the list, or NULL if there are no trees.

void clGhostTreePopulation::GetData ( xercesc::DOMDocument *  p_oDoc  )  [inline, virtual]

Not needed.

Parameters:
p_oDoc DOM tree of parsed input file.

Implements clWorkerBase.

void clGhostTreePopulation::TimestepCleanup (  )  [protected, virtual]

Deletes all trees.

Reimplemented from clWorkerBase.


Member Data Documentation

Linked list of dead trees.


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

Generated on Tue Apr 19 13:56:10 2011 for SORTIE Core C++ Documentation by  doxygen 1.5.6