clStateReporter Class Reference

State reporter. More...

#include <StateReporter.h>

Inheritance diagram for clStateReporter:

clBehaviorBase clWorkerBase

List of all members.

Public Member Functions

 clStateReporter (clSimManager *p_oSimManager)
 Constructor.
void Action ()
 Destructor.
void GetData (xercesc::DOMDocument *p_oDoc)
 Does setup for this behavior.

Protected Member Functions

void SetupGrid ()
 Sets up the "State Variables" grid and registers the data members.

Protected Attributes

clGridBasemp_oGrid
 Grid holding state variables, named "State Variables".
short int m_iTempGridCode
 Holds the code for the "Temp.C" data member of the "State Variables" grid.
short int m_iPrecipGridCode
 Holds the code for the "Precip.mm" data member of the "State Variables" grid.


Detailed Description

State reporter.

This behavior collects state information variables and stores them in a grid where they are available for output and reporting.

The values are collected into a grid called "State Variables". Currently saved are temperature and precipitation.

This class's namestring and parameter file call string are "State Reporter". Any tree type/species assignments are ignored.


Edit history:
-----------------
January 7, 2010 - Created (LEM)


Constructor & Destructor Documentation

clStateReporter::clStateReporter ( clSimManager p_oSimManager  ) 

Constructor.

Parameters:
p_oSimManager clSimManager object.


Member Function Documentation

void clStateReporter::Action (  )  [virtual]

Destructor.

Not needed. Retrieves and stores climate information in the "State Variables" grid.

Reimplemented from clBehaviorBase.

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

Does setup for this behavior.

Calls Action() so that the initial conditions value will be added.

Parameters:
p_oDoc DOM tree of parsed input file.

Implements clWorkerBase.

void clStateReporter::SetupGrid (  )  [protected]

Sets up the "State Variables" grid and registers the data members.


Member Data Documentation

Grid holding state variables, named "State Variables".

One cell grid for the plot. Two float members: "Temp.C" holds temperature, and "Precip.mm" holds precipitation.

short int clStateReporter::m_iTempGridCode [protected]

Holds the code for the "Temp.C" data member of the "State Variables" grid.

short int clStateReporter::m_iPrecipGridCode [protected]

Holds the code for the "Precip.mm" data member of the "State Variables" grid.


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

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