State reporter. More...

#include <StateReporter.h>

Inheritance diagram for clStateReporter:

Public Member Functions
	clStateReporter (clSimManager *p_oSimManager)
	Constructor. More...

void	Action ()
	Destructor. More...

void	GetData (xercesc::DOMDocument *p_oDoc)
	Does setup for this behavior. More...

Public Member Functions inherited from clBehaviorBase
virtual float	GetBehaviorVersion ()
	Gets the behavior version number. More...

	clBehaviorBase (clSimManager *p_oSimManager)
	Constructor. More...

virtual	~clBehaviorBase ()
	Destructor. More...

virtual short int	ValidateVersionNumber (float fTestVersion)
	Makes sure that the version number of a file passed is between the minimum and current version numbers. More...

virtual void	RegisterTreeDataMembers ()
	Registers tree data members. More...

virtual void	SetSpeciesTypeCombos (short int iNumCombos, stcSpeciesTypeCombo *p_whatCombos)
	Sets the species/type combos for a behavior. More...

virtual void	SetNameData (std::string sNameString)
	Sets the string for the parameter file behavior. More...

virtual short int	GetNewTreeInts ()
	Gets the number of new tree integer data members this behavior wants to register. More...

virtual short int	GetNewTreeFloats ()
	Gets the number of new tree float data members this behavior wants to register. More...

virtual short int	GetNewTreeChars ()
	Gets the number of new tree character data members this behavior wants to register. More...

virtual short int	GetNewTreeBools ()
	Gets the number of new tree bool data members this behavior wants to register. More...

virtual short int	GetNumSpeciesTypeCombos ()
	Gets the number of species/type combos to which this behavior applies. More...

virtual short int	GetNumBehaviorSpecies ()
	Gets the number of unique tree species to which this behavior applies. More...

struct stcSpeciesTypeCombo	GetSpeciesTypeCombo (short int iIndex)
	Gets one of this behavior's type/species combos. More...

virtual short int	GetBehaviorSpecies (short int iIndex)
	Gets one of the behavior's species. More...

short int	GetBehaviorListNumber ()
	Gets the behavior list number for this behavior, which differentiates between multiple copies of the behavior in the behavior list. More...

void	SetBehaviorListNumber (short int iNumber)
	Sets the behavior list number for this behavior, which differentiates between multiple copies of the behavior in the behavior list. More...

std::string	FormatSpeciesTypeQueryString ()
	Formats the string for species/types query. More...

virtual DOMElement *	GetParentParametersElement (xercesc::DOMDocument *p_oDoc)
	This will get the correct set of parameters for this behavior based on the behavior list position number. More...

Public Member Functions inherited from clWorkerBase
	clWorkerBase (clSimManager *p_oSimManager)
	Constructor. More...

virtual	~clWorkerBase ()
	Destructor. More...

std::string	GetName ()
	Gets the object's namestring. More...

clSimManager *	GetSimManager ()

void	DoObjectSetup (xercesc::DOMDocument *p_oDoc, fileType iFileType)
	Triggers the setup process. More...

virtual void	TimestepCleanup ()
	Performs any necessary cleanup operations at the end of a timestep. More...

virtual void	EndOfRunCleanup ()
	Performs any necessary cleanup operations at the end of a run. More...

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

Protected Member Functions inherited from clWorkerBase
void	AssembleFileCode (int iFileType, int iFileVersion, char *cCode)
	Creates the proper identifying filecode for an XML file. More...

Protected Attributes
clGrid *	mp_oGrid
	Grid holding state variables, named "State Variables". More...

short int	m_iTempGridCode
	Holds the code for the "Temp.C" data member of the "State Variables" grid. More...

short int	m_iPrecipGridCode
	Holds the code for the "Precip.mm" data member of the "State Variables" grid. More...

short int	m_iWDGridCode
	Holds the code for the "WaterDeficit" data member of the "State Variables" grid. More...

short int	m_iSeasonalPrecipGridCode
	Holds the code for the "SeasonalPrecip" data member of the "State Variables" grid. More...

Protected Attributes inherited from clBehaviorBase
short int	m_iNumSpeciesTypeCombos
	How many type/species combos a behavior will act on. More...

short int	m_iNumBehaviorSpecies
	How many distinct species are in the combo list - important for filling species-specific values from parameter file. More...

short int *	mp_iWhatSpecies
	List of distinct species - for filling species-specific values from parameter file. More...

stcSpeciesTypeCombo *	mp_whatSpeciesTypeCombos
	Array of species/type combos that the behavior will act on. More...

short int	m_iNewTreeInts
	The number of new tree integer data members this behavior wants to add. More...

short int	m_iNewTreeFloats
	The number of new tree float data members this behavior wants to add. More...

short int	m_iNewTreeChars
	The number of new tree character data members this behavior wants to add. More...

short int	m_iNewTreeBools
	The number of new tree boolean data members this behavior wants to add. More...

short int	m_iBehaviorListNumber
	The number of this behavior in the behavior list, to differentiate between possible multiple copies of this behavior. More...

float	m_fVersionNumber
	Version number - this will be rounded to 2 digits after the decimal place. More...

std::string	m_sXMLRoot
	XML root that encloses the parameters for this behavior. More...

float	m_fMinimumVersionNumber
	Minimum version number - this behavior will run parameter data for a file marked between this number and the current version number, inclusive. More...

Protected Attributes inherited from clWorkerBase
std::string	m_sNameString
	If a behavior has registered a command line command with the sim manager, this allows it to be called. More...

clSimManager *	mp_oSimManager
	Pointer to the simulation manager object. More...

int *	mp_iAllowedFileTypes
	List of the input file types this object can handle. More...

int	m_iNumAllowedTypes
	Number of input file types this object can handle. More...

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 "StateReporter". Any tree type/species assignments are ignored.

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

Constructor & Destructor Documentation

◆ clStateReporter()

clStateReporter::clStateReporter ( clSimManager * p_oSimManager )

Constructor.

Parameters

p_oSimManager clSimManager object.

Member Function Documentation

◆ Action()

void clStateReporter::Action ( )

virtual

Destructor.

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

Reimplemented from clBehaviorBase.

◆ GetData()

void clStateReporter::GetData ( xercesc::DOMDocument * p_oDoc )

inlinevirtual

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.

◆ SetupGrid()

void clStateReporter::SetupGrid ( )

protected

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

Member Data Documentation

◆ m_iPrecipGridCode

short int clStateReporter::m_iPrecipGridCode

protected

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

◆ m_iSeasonalPrecipGridCode

short int clStateReporter::m_iSeasonalPrecipGridCode

protected

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

◆ m_iTempGridCode

short int clStateReporter::m_iTempGridCode

protected

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

◆ m_iWDGridCode

short int clStateReporter::m_iWDGridCode

protected

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

◆ mp_oGrid

clGrid* clStateReporter::mp_oGrid

protected

Grid holding state variables, named "State Variables".

One cell grid for the plot. Data members (all floats):

"Temp.C" holds mean annual temperature
"Precip.mm" holds mean annual precipitation
"WaterDeficit" holds water deficit
"SeasonalPrecip" holds seasonal precipitation

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

StateReporter.h

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ clStateReporter()

Member Function Documentation

◆ Action()

◆ GetData()

◆ SetupGrid()

Member Data Documentation

◆ m_iPrecipGridCode

◆ m_iSeasonalPrecipGridCode

◆ m_iTempGridCode

◆ m_iWDGridCode

◆ mp_oGrid