|
SORTIE Core C++ Documentation
|
State reporter. More...
#include <StateReporter.h>
Public Member Functions | |
| clStateReporter (clSimManager *p_oSimManager) | |
| Constructor. | |
| void | Action () |
| Destructor. | |
| void | GetData (xercesc::DOMDocument *p_oDoc) |
| Does setup for this behavior. | |
Public Member Functions inherited from clBehaviorBase | |
| virtual float | GetBehaviorVersion () |
| Gets the behavior version number. | |
| clBehaviorBase (clSimManager *p_oSimManager) | |
| Constructor. | |
| virtual | ~clBehaviorBase () |
| Destructor. | |
| virtual short int | ValidateVersionNumber (float fTestVersion) |
| Makes sure that the version number of a file passed is between the minimum and current version numbers. | |
| virtual void | RegisterTreeDataMembers () |
| Registers tree data members. | |
| virtual void | SetSpeciesTypeCombos (short int iNumCombos, stcSpeciesTypeCombo *p_whatCombos) |
| Sets the species/type combos for a behavior. | |
| virtual void | SetNameData (char *cNameString) |
| Sets the string for the parameter file behavior. | |
| virtual short int | GetNewTreeInts () |
| Gets the number of new tree integer data members this behavior wants to register. | |
| virtual short int | GetNewTreeFloats () |
| Gets the number of new tree float data members this behavior wants to register. | |
| virtual short int | GetNewTreeChars () |
| Gets the number of new tree character data members this behavior wants to register. | |
| virtual short int | GetNewTreeBools () |
| Gets the number of new tree bool data members this behavior wants to register. | |
| virtual short int | GetNumSpeciesTypeCombos () |
| Gets the number of species/type combos to which this behavior applies. | |
| virtual short int | GetNumBehaviorSpecies () |
| Gets the number of unique tree species to which this behavior applies. | |
| struct stcSpeciesTypeCombo | GetSpeciesTypeCombo (short int iIndex) |
| Gets one of this behavior's type/species combos. | |
| virtual short int | GetBehaviorSpecies (short int iIndex) |
| Gets one of the behavior's species. | |
| short int | GetBehaviorListNumber () |
| Gets the behavior list number for this behavior, which differentiates between multiple copies of the behavior in the behavior list. | |
| 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. | |
| virtual DOMElement * | GetParentParametersElement (xercesc::DOMDocument *p_oDoc) |
| Formats the string for species/types query. | |
Public Member Functions inherited from clWorkerBase | |
| clWorkerBase (clSimManager *p_oSimManager) | |
| Constructor. | |
| virtual | ~clWorkerBase () |
| Destructor. | |
| char * | GetName () |
| Gets the object's namestring. | |
| void | DoObjectSetup (xercesc::DOMDocument *p_oDoc, fileType iFileType) |
| Triggers the setup process. | |
| virtual void | TimestepCleanup () |
| Performs any necessary cleanup operations at the end of a timestep. | |
| virtual void | EndOfRunCleanup () |
| Performs any necessary cleanup operations at the end of a run. | |
| virtual void | DoCommand (char *cCommand, char *cArguments) |
| If a behavior has registered a command line command with the sim manager, this allows it to be called. | |
Protected Member Functions | |
| void | SetupGrid () |
| Sets up the "State Variables" grid and registers the data members. | |
Protected Attributes | |
| clGrid * | mp_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. | |
Protected Attributes inherited from clBehaviorBase | |
| short int | m_iNumSpeciesTypeCombos |
| How many type/species combos a behavior will act on. | |
| short int | m_iNumBehaviorSpecies |
| How many distinct species are in the combo list - important for filling species-specific values from parameter file. | |
| short int * | mp_iWhatSpecies |
| List of distinct species - for filling species-specific values from parameter file. | |
| stcSpeciesTypeCombo * | mp_whatSpeciesTypeCombos |
| Array of species/type combos that the behavior will act on. | |
| short int | m_iNewTreeInts |
| The number of new tree integer data members this behavior wants to add. | |
| short int | m_iNewTreeFloats |
| The number of new tree float data members this behavior wants to add. | |
| short int | m_iNewTreeChars |
| The number of new tree character data members this behavior wants to add. | |
| short int | m_iNewTreeBools |
| The number of new tree boolean data members this behavior wants to add. | |
| short int | m_iBehaviorListNumber |
| The number of this behavior in the behavior list, to differentiate between possible multiple copies of this behavior. | |
| float | m_fVersionNumber |
| Version number - this will be rounded to 2 digits after the decimal place. | |
| std::string | m_sXMLRoot |
| XML root that encloses the parameters for this behavior. | |
| 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. | |
Protected Attributes inherited from clWorkerBase | |
| char | m_cNameString [MAX_NAMESTRING_SIZE] |
| Object's identifying namestring. | |
| int * | mp_iAllowedFileTypes |
| List of the input file types this object can handle. | |
| int | m_iNumAllowedTypes |
| Number of input file types this object can handle. | |
Additional Inherited Members | |
Static Protected Attributes inherited from clWorkerBase | |
| static clSimManager * | mp_oSimManager |
| Pointer to the simulation manager object. | |
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)
| clStateReporter::clStateReporter | ( | clSimManager * | p_oSimManager | ) |
Constructor.
| p_oSimManager | clSimManager object. |
|
virtual |
Destructor.
Not needed. Retrieves and stores climate information in the "State Variables" grid.
Reimplemented from clBehaviorBase.
|
inlinevirtual |
Does setup for this behavior.
Calls Action() so that the initial conditions value will be added.
| p_oDoc | DOM tree of parsed input file. |
Implements clWorkerBase.
|
protected |
Sets up the "State Variables" grid and registers the data members.
|
protected |
Holds the code for the "Precip.mm" data member of the "State Variables" grid.
|
protected |
Holds the code for the "Temp.C" data member of the "State Variables" grid.
|
protected |
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.
1.8.2