clCrownRadiusReporter Class Reference

Crown radius reporter, version 1.0. More...

#include <CrownRadiusReporter.h>

Inheritance diagram for clCrownRadiusReporter:

clBehaviorBase clWorkerBase

List of all members.

Public Member Functions

 clCrownRadiusReporter (clSimManager *p_oSimManager)
 Constructor.
 ~clCrownRadiusReporter ()
 Destructor.
void Action ()
 Updates crown radii.
void GetData (xercesc::DOMDocument *p_oDoc)
 Does setup for this behavior.
void RegisterTreeDataMembers ()
 Registers the "Crown Radius" float data member.

Protected Attributes

short int ** mp_iRadiusCodes
 Data member codes for "Crown Radius" data member.
char * m_cQuery
 String to pass to clTreePopulation::Find() in order to get the trees for which to report crown radius.
int m_iNumSpecies
 Number of species, for destructor.


Detailed Description

Crown radius reporter, version 1.0.

This behavior reports crown radius. It adds a float data member to the tree called "Crown_Radius" and updates it each timestep. Then it can be added to output.

This behavior can only be applied to saplings, adults, and snags.

The namestring and parameter file call string for this behavior are both "Crown Radius Reporter".

Copyright 2008 Charles D. Canham.

Author:
Lora E. Murphy

Edit history:
-----------------
June 17, 2008 - Created (LEM)

Constructor & Destructor Documentation

clCrownRadiusReporter::clCrownRadiusReporter ( clSimManager p_oSimManager  ) 

Constructor.

clCrownRadiusReporter::~clCrownRadiusReporter (  ) 

Destructor.

Frees memory.


Member Function Documentation

void clCrownRadiusReporter::Action (  )  [virtual]

Updates crown radii.

A query is sent to the tree population to get all trees to which this behavior is applied.

Reimplemented from clBehaviorBase.

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

Does setup for this behavior.

It formats a query string for finding trees to which this behavior applies. It then finds any initial conditions trees and sets their radii.

Parameters:
p_oDoc DOM tree of parsed input file.

Implements clWorkerBase.

void clCrownRadiusReporter::RegisterTreeDataMembers (  )  [virtual]

Registers the "Crown Radius" float data member.

The return codes are captured in the mp_iRadiusCodes array.

Exceptions:
modelErr if this behavior is being applied to any tree type except saplings and adults.

Reimplemented from clBehaviorBase.


Member Data Documentation

short int** clCrownRadiusReporter::mp_iRadiusCodes [protected]

Data member codes for "Crown Radius" data member.

First array index is # species, second is number types

String to pass to clTreePopulation::Find() in order to get the trees for which to report crown radius.

This will instigate a species/type search for all the species and types to which this behavior applies.

Number of species, for destructor.


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

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