clGermination Class Reference

Germination - version 1.0. More...

#include <Germination.h>

Inheritance diagram for clGermination:

clBehaviorBase clWorkerBase List of all members.

Public Member Functions

 clGermination (clSimManager *p_oSimManager)
 Constructor.
 ~clGermination ()
 Destructor.
void GetData (xercesc::DOMDocument *p_oDoc)
 Reads in values from the parameter file.
void Action ()
 Performs germination.

Protected Attributes

clGridBasemp_oSeedGrid
 Pointer to the "Dispersed Seeds" grid created by disperse behaviors.
float * mp_fProportionGerminating
 Substrate proportion.
short int * mp_iSeedGridCode
 Data member codes for seed grid for number of seeds.

Detailed Description

Germination - version 1.0.

This performs germination. For a species subjected to germination, its number of seeds is reduced to a set proportion of the total.

A fatal error is thrown if a disperse behavior is not also defined for the run.

This class's namestring and parameter call string are both "germination". Copyright 2003 Charles D. Canham.

Author:
Lora E. Murphy

Edit history:
-----------------
April 28, 2004 - Submitted as beta (LEM)


Constructor & Destructor Documentation

clGermination::clGermination ( clSimManager p_oSimManager  ) 

Constructor.

Parameters:
p_oSimManager Sim Manager object.


Member Function Documentation

void clGermination::GetData ( xercesc::DOMDocument *  p_oDoc  )  [virtual]

Reads in values from the parameter file.

Parameters:
p_oDoc DOM tree of parsed input file.
Exceptions:
modelErr if the values in proportion germinating are not between 0 and 1.

Implements clWorkerBase.

void clGermination::Action (  )  [virtual]

Performs germination.

For each grid cell in the seed grid, the number of seeds for a germinating species is multiplied by the germinating proportion for that species. A random round is used to take care of fractional parts of seeds.

Reimplemented from clBehaviorBase.


Member Data Documentation

clGridBase* clGermination::mp_oSeedGrid [protected]

Pointer to the "Dispersed Seeds" grid created by disperse behaviors.

float* clGermination::mp_fProportionGerminating [protected]

Substrate proportion.

Size is # total species.

short int* clGermination::mp_iSeedGridCode [protected]

Data member codes for seed grid for number of seeds.

Array size is # total species.


The documentation for this class was generated from the following file:
Generated on Thu May 24 09:30:42 2007 for SORTIE Core C++ Documentation by  doxygen 1.5.2