javawrapper::Allometry Class Reference

This holds all data relating to allometry. More...

Inheritance diagram for javawrapper::Allometry:

javawrapper::WorkerBase List of all members.

Public Member Functions

 Allometry (GUIManager oManager)
 Constructor.
void DoSetup (TreePopulation oPop) throws ModelException
 Does setup.
void ValidateData (TreePopulation oPop) throws ModelException
 This makes sure all data is valid and can be used to run the model.
boolean SetVectorValueByXMLTag (String sXMLTag, String sXMLParentTag, java.util.Vector p_oData, String[] p_sChildXMLTags, boolean[] p_bAppliesTo, org.xml.sax.Attributes oParentAttributes, org.xml.sax.Attributes[] p_oAttributes) throws ModelException
 Overridden for backwards compatibility after changing XML tag names.

Protected Attributes

ModelVector mp_fMaxCanopyHeight
 Species-specific - maximum crown height.
ModelVector mp_fSlopeOfAsymptoticHeight
 Species-specific - slope of asymptotic height.
ModelVector mp_fCrownRadExp
 Species-specific - exponent in crown radius equation.
ModelVector mp_fCrownHtExp
 Species-specific - exponent in crown height equation.
ModelVector mp_fSlopeOfAsympCrownRad
 Species-specific - slope of asymptotic crown radius.
ModelVector mp_fSlopeOfAsympCrownHt
 Species-specific - slope of the asymptotic crown height.
ModelVector mp_fSlopeOfHeightDiam10
 Species-specific - slope of the height-diam10 relationship.
ModelVector mp_fDiam10ToDbhSlope
 Species-specific - slope of relationship of diam10 to dbh.
ModelVector mp_fDiam10ToDbhIntercept
 Species-specific - intercept of relationship of diam10 to dbh.
ModelVector mp_fAdultLinearSlope
 Slope of linear height-DBH relationship for adults - not required if the linear relationship isn't used.
ModelVector mp_fAdultLinearIntercept
 Intercept of linear height-DBH relationship for adults - not required if the linear relationship isn't used.
ModelVector mp_fSaplingLinearSlope
 Slope of linear height-DBH relationship for saplings - not required if the linear relationship isn't used.
ModelVector mp_fSaplingLinearIntercept
 Intercept of linear height-DBH relationship for saplings - not required if the linear relationship isn't used.
ModelVector mp_fSeedlingLinearSlope
 Slope of linear height-DBH relationship for seedlings - not required if the linear relationship isn't used.
ModelVector mp_fSeedlingLinearIntercept
 Intercept of linear height-DBH relationship for seedlings - not required if the linear relationship isn't used.
ModelVector mp_fAdultReverseLinearSlope
 Slope of reverse linear height-DBH relationship for adults - not required if the reverse linear relationship isn't used.
ModelVector mp_fAdultReverseLinearIntercept
 Intercept of reverse linear height-DBH relationship for adults - not required if the reverse linear relationship isn't used.
ModelVector mp_fSaplingReverseLinearSlope
 Slope of reverse linear height-DBH relationship for saplings - not required if the reverse linear relationship isn't used.
ModelVector mp_fSaplingReverseLinearIntercept
 Intercept of reverse linear height-DBH relationship for saplings - not required if the reverse linear relationship isn't used.
ModelVector mp_fSeedlingReverseLinearSlope
 Slope of reverse linear height-DBH relationship for seedlings - not required if the reverse linear relationship isn't used.
ModelVector mp_fSeedlingReverseLinearIntercept
 Intercept of reverse linear height-DBH relationship for seedlings - not required if the reverse linear relationship isn't used.
ModelVector mp_iWhatSeedlingHDFunction
 Which relationship to use to relate height to diam10 for seedlings - 0 = standard, 1 = linear, 2 = reverse linear.
ModelVector mp_iWhatSaplingHDFunction
 Which relationship to use to relate height to DBH for saplings - 0 = standard, 1 = linear, 2 = reverse linear.
ModelVector mp_iWhatAdultHDFunction
 Which relationship to use to relate height to DBH for adults - 0 = standard, 1 = linear, 2 = reverse linear.
ModelVector mp_iWhatAdultCRDFunction
 Which relationship to use to relate DBH to crown radius for adults - 0 = standard, 1 = Chapman-Richards.
ModelVector mp_iWhatSaplingCRDFunction
 Which relationship to use to relate DBH to crown radius for saplings - 0 = standard, 1 = Chapman-Richards.
ModelVector mp_iWhatAdultCHHFunction
 Which relationship to use to relate height to crown height for adults - 0 = standard, 1 = Chapman-Richards.
ModelVector mp_iWhatSaplingCHHFunction
 Which relationship to use to relate height to crown height for saplings - 0 = standard, 1 = Chapman-Richards.
ModelVector mp_fCRCrownRadIntercept
 Intercept of Chapman-Richards crown radius-DBH relationship - not required if the Chapman-Richards crown radius relationship isn't used.
ModelVector mp_fCRAsympCrownRad
 Asymptotic crown radius of Chapman-Richards crown radius-DBH relationship - not required if the Chapman-Richards crown radius relationship isn't used.
ModelVector mp_fCRCrownRadShape1
 Shape parameter 1 (b) of Chapman-Richards crown radius-DBH relationship
  • not required if the C-R crown radius relationship isn't used.

ModelVector mp_fCRCrownRadShape2
 Shape parameter 2 (c) of Chapman-Richards crown radius-DBH relationship
  • not required if the C-R crown radius relationship isn't used.

ModelVector mp_fCRCrownHtIntercept
 Intercept of Chapman-Richards crown height-height relationship - not required if the Chapman-Richards crown height relationship isn't used.
ModelVector mp_fCRAsympCrownHt
 Asymptotic crown radius of Chapman-Richards crown height-height relationship - not required if the Chapman-Richards crown height relationship isn't used.
ModelVector mp_fCRCrownHtShape1
 Shape parameter 1 (b) of Chapman-Richards crown height-height relationship
  • not required if the C-R crown height relationship isn't used.

ModelVector mp_fCRCrownHtShape2
 Shape parameter 2 (c) of Chapman-Richards crown height-height relationship
  • not required if the C-R crown height relationship isn't used.

ModelVector mp_fPowerA
 "a" parameter of power function height-diam relationship - not required if this function isn't used (LEM 1-25-05)
ModelVector mp_fPowerB
 "b" parameter of power function height-diam relationship - not required if this function isn't used (LEM 1-25-05)

Detailed Description

This holds all data relating to allometry.

Copyright: Copyright (c) Charles D. Canham 2003

Company: Institute of Ecosystem Studies

Author:
Lora E. Murphy
Version:
1.0

Edit history:
------------------
April 25, 2005: Created (LEM)


Constructor & Destructor Documentation

javawrapper::Allometry::Allometry ( GUIManager  oManager  )  [inline]

Constructor.

Parameters:
oManager GUIManager object

Edit history:
------------------
April 25, 2005: Created (LEM)


Member Function Documentation

void javawrapper::Allometry::DoSetup ( TreePopulation  oPop  )  throws ModelException [inline, virtual]

Does setup.

Sets up the enums for the function lists.

Parameters:
oPop TreePopulation object.
Exceptions:
ModelException passing through from called functions.

Edit history:
------------------
April 25, 2005: Created (LEM)
January 23, 2007: Updated to preserve values on species change (LEM)

Implements javawrapper::WorkerBase.

void javawrapper::Allometry::ValidateData ( TreePopulation  oPop  )  throws ModelException [inline, virtual]

This makes sure all data is valid and can be used to run the model.

Exceptions:
ModelException in any of the following cases:
  • There is any value less than or equal to zero in any of the following vectors, when used:
    • mp_fSlopeOfAsympCrownRad
    • mp_fDiam10ToDbhConversion
    • mp_fSlopeOfAsympCrownHt
    • mp_fMaxCanopyHeight
    • mp_fSlopeOfAsymptoticHeight
  • A value in any slope is 0 (if it is being used)
Parameters:
oPop Not used.

Edit history:
------------------
April 28, 2004: Submitted in beta version (LEM)

Implements javawrapper::WorkerBase.

boolean javawrapper::Allometry::SetVectorValueByXMLTag ( String  sXMLTag,
String  sXMLParentTag,
java.util.Vector  p_oData,
String[]  p_sChildXMLTags,
boolean[]  p_bAppliesTo,
org.xml.sax.Attributes  oParentAttributes,
org.xml.sax.Attributes[]  p_oAttributes 
) throws ModelException [inline]

Overridden for backwards compatibility after changing XML tag names.

This was done in version 6.05 and can be removed after several versions.

Parameters:
sXMLTag Parent XML tag of data vector whose value is to be set.
sXMLParentTag The immediate parent tag that sXMLTag is within.
p_oData Vector of data values appropriate to the data type
p_sChildXMLTags The XML tags of the child elements
p_bAppliesTo Array of booleans saying which of the vector values should be set. This is important in the case of species-specifics - the vector index is the species number but not all species are set.
oParentAttributes Attributes of parent tag. May be useful when overridding this for unusual tags.
p_oAttributes Attributes passed from parser. This may be needed when overriding this function. Basic species-specific values are already handled by this function.
Returns:
true if the value was set successfully; false if the value could not be found. (This would not be an error, because I need a way to cycle through the objects until one of the objects comes up with a match.) If a match to a data object is made via XML tag, but the found object is not a ModelVector, this returns false.
Exceptions:
ModelException if the value could not be assigned to the data object.

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


Member Data Documentation

ModelVector javawrapper::Allometry::mp_fMaxCanopyHeight [protected]

Initial value:

 new ModelVector(
      "Maximum Tree Height, in meters", "tr_canopyHeight", "tr_chVal", 0,
      ModelVector.FLOAT, true)
Species-specific - maximum crown height.

ModelVector javawrapper::Allometry::mp_fSlopeOfAsymptoticHeight [protected]

Initial value:

 new ModelVector(
      "Slope of Asymptotic Height", "tr_slopeOfAsymHeight", "tr_soahVal",
      0, ModelVector.FLOAT, true)
Species-specific - slope of asymptotic height.

ModelVector javawrapper::Allometry::mp_fCrownRadExp [protected]

Initial value:

 new ModelVector(
      "Crown Radius Exponent", "tr_stdCrownRadExp", "tr_screVal", 0,
      ModelVector.FLOAT, true)
Species-specific - exponent in crown radius equation.

ModelVector javawrapper::Allometry::mp_fCrownHtExp [protected]

Initial value:

 new ModelVector(
      "Crown Height Exponent", "tr_stdCrownHtExp", "tr_scheVal", 0,
      ModelVector.FLOAT, true)
Species-specific - exponent in crown height equation.

ModelVector javawrapper::Allometry::mp_fSlopeOfHeightDiam10 [protected]

Initial value:

 new ModelVector(
      "Slope of Height-Diameter at 10 cm Relationship",
      "tr_slopeOfHeight-Diam10", "tr_sohdVal", 0, ModelVector.FLOAT, true)
Species-specific - slope of the height-diam10 relationship.

ModelVector javawrapper::Allometry::mp_fDiam10ToDbhSlope [protected]

Initial value:

 new ModelVector(
      "Slope of DBH to Diameter at 10 cm Relationship",
      "tr_conversionDiam10ToDBH",
      "tr_cdtdVal", 0, ModelVector.FLOAT, true)
Species-specific - slope of relationship of diam10 to dbh.

ModelVector javawrapper::Allometry::mp_fDiam10ToDbhIntercept [protected]

Initial value:

 new ModelVector(
      "Intercept of DBH to Diameter at 10 cm Relationship",
      "tr_interceptDiam10ToDBH", "tr_idtdVal", 0, ModelVector.FLOAT, true)
Species-specific - intercept of relationship of diam10 to dbh.


The documentation for this class was generated from the following file:
Generated on Thu May 24 09:34:53 2007 for SORTIE Java Interface by  doxygen 1.5.2