SORTIE Core C++ Documentation
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
clCarbonValueCalculator Class Reference

Carbon Value Calculator Version 1.0. More...

#include <CarbonValueCalculator.h>

Inheritance diagram for clCarbonValueCalculator:
clBehaviorBase clWorkerBase

Public Member Functions

 clCarbonValueCalculator (clSimManager *p_oSimManager)
 Constructor. More...
 
 ~clCarbonValueCalculator ()
 Destructor. More...
 
void Action ()
 Makes value calculations. More...
 
void GetData (xercesc::DOMDocument *p_oDoc)
 Does setup for this behavior. More...
 
void RegisterTreeDataMembers ()
 Registers the "Carbon" tree float data member. 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 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...
 
clSimManagerGetSimManager ()
 
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 GetBiomassCodes (clTreePopulation *p_oPop)
 Retrieves the "Biomass" float data member. More...
 
void GetParameterFileData (xercesc::DOMDocument *p_oDoc, clTreePopulation *p_oPop)
 Reads values from the parameter file. More...
 
void FormatQueryString (clTreePopulation *p_oPop)
 Formats the string in m_cQuery. More...
 
void SetupGrid ()
 Sets up the "Carbon Value" grid. 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

clGridmp_oValueGrid
 Grid holding total values for each species. More...
 
double * mp_fCPercentBiomass
 Percent of biomass that is carbon. More...
 
std::string m_sQuery
 String to pass to clTreePopulation::Find() in order to get the trees for which to calculate volume. More...
 
short int ** mp_iBiomassCodes
 Holds data member codes for "Biomass" float data member (registered by the clDimensionAnalysis class). More...
 
short int ** mp_iTreeCarbonCodes
 Holds data member codes for "Carbon" float data member. More...
 
short int * mp_iValueCodes
 Holds data member codes for the "value_x" float data members of the "Carbon Value" grid. More...
 
short int * mp_iCarbonCodes
 Holds data member codes for the "carbon_x" float data members of the "Carbon Value" grid. More...
 
double m_fPricePerTonCarbon
 Price per metric ton of carbon - currency unimportant. More...
 
short int m_iNumTotalSpecies
 Total number of species. 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...
 
stcSpeciesTypeCombomp_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...
 
clSimManagermp_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

Carbon Value Calculator Version 1.0.

This behavior calculates carbon value per species. The amount of carbon is given by the user as a percent of biomass for each species. This behavior expects the Dimension Analysis behavior (clDimensionAnalysis) to calculate tree biomass.

The user also supplies a price per metric ton of carbon. This is multipled by the amount of carbon and added up into a total value of carbon per species. The species carbon totals and carbon value totals are stored in a grid called "Carbon Value".

Each tree gets a data member called "Carbon". This contains the tree's own carbon value.

This class's namestring and parameter call string are both "CarbonValueCalculator".

This behavior may not be applied to seedlings.


Edit history:
--------------—
October 20, 2011 - Wiped the slate clean for SORTIE 7.0 (LEM)

Constructor & Destructor Documentation

◆ clCarbonValueCalculator()

clCarbonValueCalculator::clCarbonValueCalculator ( clSimManager p_oSimManager)

Constructor.

Parameters
p_oSimManagerclSimManager object.

◆ ~clCarbonValueCalculator()

clCarbonValueCalculator::~clCarbonValueCalculator ( )

Destructor.

Deletes arrays.

Member Function Documentation

◆ Action()

void clCarbonValueCalculator::Action ( )
virtual

Makes value calculations.

First, the values in the "Carbon Value" grid are cleared. Then a query is sent to the tree population to get all trees to which this behavior is applied. For each, the amount of biomass (in metric tons) is retrieved, and the carbon amount and value calculated. Then the species values are totaled and placed in the "Carbon Value" grid.

Reimplemented from clBehaviorBase.

◆ FormatQueryString()

void clCarbonValueCalculator::FormatQueryString ( clTreePopulation p_oPop)
protected

Formats the string in m_cQuery.

This value will be used in Action() to pass to clTreePopulation::Find() in order to get the trees to act on.

Parameters
p_oPopTree population object.

◆ GetBiomassCodes()

void clCarbonValueCalculator::GetBiomassCodes ( clTreePopulation p_oPop)
protected

Retrieves the "Biomass" float data member.

The return codes are captured in the mp_iBiomassCodes array.

Exceptions
modelErrif any code comes back -1 for a tree to which this behavior is applied.

◆ GetData()

void clCarbonValueCalculator::GetData ( xercesc::DOMDocument *  p_oDoc)
virtual

Does setup for this behavior.

Calls:

  1. GetParameterFileData()
  2. FormatQueryString()
  3. SetupGrid()
  4. GetBiomassCodes()
  5. Action() so that the initial conditions value will be added
Parameters
p_oDocDOM tree of parsed input file.

Implements clWorkerBase.

◆ GetParameterFileData()

void clCarbonValueCalculator::GetParameterFileData ( xercesc::DOMDocument *  p_oDoc,
clTreePopulation p_oPop 
)
protected

Reads values from the parameter file.

Parameters
p_oDocDOM tree of parsed input file.
p_oPopTree population object.
Exceptions
modelErrif the percentage of biomass that is carbon is less than 0 or greater than 100.

◆ RegisterTreeDataMembers()

void clCarbonValueCalculator::RegisterTreeDataMembers ( )
virtual

Registers the "Carbon" tree float data member.

The return codes are captured in the mp_iTreeCarbonCodes array.

Exceptions
modelErrif this behavior is being applied to any tree type except saplings, adults, and snags.

Reimplemented from clBehaviorBase.

◆ SetupGrid()

void clCarbonValueCalculator::SetupGrid ( )
protected

Sets up the "Carbon Value" grid.

This ignores any maps.

Member Data Documentation

◆ m_fPricePerTonCarbon

double clCarbonValueCalculator::m_fPricePerTonCarbon
protected

Price per metric ton of carbon - currency unimportant.

◆ m_iNumTotalSpecies

short int clCarbonValueCalculator::m_iNumTotalSpecies
protected

Total number of species.

For the destructor.

◆ m_sQuery

std::string clCarbonValueCalculator::m_sQuery
protected

String to pass to clTreePopulation::Find() in order to get the trees for which to calculate volume.

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

◆ mp_fCPercentBiomass

double* clCarbonValueCalculator::mp_fCPercentBiomass
protected

Percent of biomass that is carbon.

In the parameter file, this is as a percentage between 0 and 100. We convert this upon reading to a proportion between 0 and 1. Array size is # total species.

◆ mp_iBiomassCodes

short int** clCarbonValueCalculator::mp_iBiomassCodes
protected

Holds data member codes for "Biomass" float data member (registered by the clDimensionAnalysis class).

First array index is total # species, second is number types (3 - sapling, adult, snag)

◆ mp_iCarbonCodes

short int* clCarbonValueCalculator::mp_iCarbonCodes
protected

Holds data member codes for the "carbon_x" float data members of the "Carbon Value" grid.

Array size is total # species.

◆ mp_iTreeCarbonCodes

short int** clCarbonValueCalculator::mp_iTreeCarbonCodes
protected

Holds data member codes for "Carbon" float data member.

First array index is total # species, second is number types (3 - sapling, adult, snag)

◆ mp_iValueCodes

short int* clCarbonValueCalculator::mp_iValueCodes
protected

Holds data member codes for the "value_x" float data members of the "Carbon Value" grid.

Array size is total # species.

◆ mp_oValueGrid

clGrid* clCarbonValueCalculator::mp_oValueGrid
protected

Grid holding total values for each species.

The grid name is "Carbon Value". The grid contains only 1 grid cell. It has 2 times X float data members, where X = the total number of species. The data member names are "carbon_x" (where "x" is the species number) for amount of carbon, and "value_x" for value of carbon.


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