javawrapper::SubstrateBehaviors Class Reference

Manages substrate data and behaviors. More...

Inheritance diagram for javawrapper::SubstrateBehaviors:

javawrapper::BehaviorTypeBase javawrapper::WorkerBase List of all members.

Public Member Functions

 SubstrateBehaviors (GUIManager oManager)
 Constructor.
void DoSetup (TreePopulation oPop) throws ModelException
 Sets up the substrate grids.
boolean SetSingleValueByXMLTag (String sXMLTag, String sXMLParentTag, org.xml.sax.Attributes oAttributes, Object oData) throws ModelException
 Overridden to provide backwards compatibility - I changed XML tag names.
void ValidateData (TreePopulation oPop) throws ModelException
 Validates the data in preparation for parameter file writing or some such.

Protected Member Functions

void SetSingleValue (ModelData oDataMember, Object oData) throws ModelException
 Overridden from WorkerBase.

Protected Attributes

ModelVector mp_fProportionOfDeadThatFall
 Proportion of dead that fall for each species.
ModelVector mp_fProportionOfFallenThatUproot
 Proportion of fallen that uproot for each species.
ModelVector mp_fProportionOfSnagsThatUproot
 Proportion of snags that uproot for each species.
ModelFloat m_fScarSoilA
 Scarified soil decay alpha.
ModelFloat m_fScarSoilB
 Scarified soil decay beta.
ModelFloat m_fTipUpA
 Tip-Up Mounds decay alpha.
ModelFloat m_fTipUpB
 Tip-Up Mounds decay beta.
ModelFloat m_fFreshlogA
 Fresh log decay alpha.
ModelFloat m_fFreshlogB
 Fresh log decay beta.
ModelFloat m_fDecayedlogA
 Decayed log decay alpha.
ModelFloat m_fDecayedlogB
 Decayed log decay beta.
ModelFloat m_fInitCondScarSoil
 Scarified soil initial condition proportion.
ModelFloat m_fPartialCutScarSoil
 Scarified soil partial cut proportion.
ModelFloat m_fGapCutScarSoil
 Scarified soil gap cut proportion.
ModelFloat m_fClearCutScarSoil
 Scarified soil clear cut proportion.
ModelFloat m_fInitCondTipup
 Tip-Up Mounds initial condition proportion.
ModelFloat m_fPartialCutTipup
 Tip-Up Mounds partial cut proportion.
ModelFloat m_fGapCutTipup
 Tip-Up Mounds gap cut proportion.
ModelFloat m_fClearCutTipup
 Tip-Up Mounds clear cut proportion.
ModelFloat m_fInitCondFreshLog
 Fresh log initial condition proportion.
ModelFloat m_fPartialCutFreshLog
 Fresh log partial cut proportion.
ModelFloat m_fGapCutFreshLog
 Fresh log gap cut proportion.
ModelFloat m_fClearCutFreshLog
 Fresh log clear cut proportion.
ModelFloat m_fInitCondDecLog
 Decayed log initial condition proportion.
ModelFloat m_fPartialCutDecLog
 Decayed log partial cut proportion.
ModelFloat m_fGapCutDecLog
 Decayed log gap cut proportion.
ModelFloat m_fClearCutDecLog
 Decayed log clear cut proportion.
ModelFloat m_fRootTipupFactor
 Root soil disturbance factor.
ModelFloat m_fMossProportion
 Proportion of litter/moss that is moss.
ModelEnum m_iDirectionalTreeFall
 Whether or not tree fall is directional - LEM 06/03/05.
ModelInt m_iMaxDecayTime
 Maximum number of years a substrate event hangs around.

Detailed Description

Manages substrate data and behaviors.

Copyright: Copyright (c) 2003 Charles D. Canham

Company: Institute of Ecosystem Studies

Author:
Lora E. Murphy

Edit history:
------------------
April 28, 2004: Submitted in beta version (LEM)
July 21, 2004: Added calcs grids (LEM)
April 1, 2005: Changed some substrate names per CDC (LEM)
April 22, 2005: Added new snag uproot parameter (LEM)
June 3, 2005: Added combined substrate (LEM)
November 17, 2005: New decay equation for decayed logs (LEM)


Constructor & Destructor Documentation

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

Constructor.

Parameters:
oManager GUIManager object.

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


Member Function Documentation

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

Sets up the substrate grids.

Parameters:
oPop Tree population.
Exceptions:
ModelException 
Edit history:
------------------
April 28, 2004: Submitted in beta version (LEM)
July 21, 2004: Added calcs grids (LEM)

Implements javawrapper::WorkerBase.

void javawrapper::SubstrateBehaviors::SetSingleValue ( ModelData  oDataMember,
Object  oData 
) throws ModelException [inline, protected]

Overridden from WorkerBase.

This is on the lookout for changes to m_iMaxDecayTime, so DoSetup() can be triggered and the grids recreated.

Parameters:
oDataMember Data member to set.
oData Data value to set into data member.
Exceptions:
ModelException if data is of the wrong type.

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

Reimplemented from javawrapper::WorkerBase.

boolean javawrapper::SubstrateBehaviors::SetSingleValueByXMLTag ( String  sXMLTag,
String  sXMLParentTag,
org.xml.sax.Attributes  oAttributes,
Object  oData 
) throws ModelException [inline]

Overridden to provide backwards compatibility - I changed XML tag names.

This was put in for 6.05 - remove after several more versions.

Parameters:
sXMLTag XML tag of data object whose value is to be set.
sXMLParentTag The immediate parent tag that sXMLTag is within.
oAttributes Attributes of the object. Ignored, but may be needed by overriding objects.
oData Data value, either String or type appropriate to the data type
Returns:
true if the value was set successfully; false if the value could not be found.
Exceptions:
ModelException if the value could not be assigned to the data object.

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

Validates the data in preparation for parameter file writing or some such.

Exceptions:
ModelException if:
  • m_fRootTipupFactor or m_iMaxDecayTime are not positive numbers
  • if the values in mp_fProportionOfDeadThatFall, mp_fProportionOfFallenThatUproot, and mp_fProportionOfSnagsThatUproot are not proportions
  • m_fMossProportion isn't a proportion
  • any initial or harvest conditions value isn't a proportion
  • the total of any set of initial or harvest conditions is greater than 1
Parameters:
oPop Not used.

Edit history:
------------------
April 28, 2004: Submitted in beta version (LEM)
April 22, 2005: Added proportion checking (LEM)

Implements javawrapper::WorkerBase.


Member Data Documentation

ModelVector javawrapper::SubstrateBehaviors::mp_fProportionOfDeadThatFall [protected]

Initial value:

 new ModelVector(
      "Proportion of Dead that Fall", "su_propOfDeadFall", "su_podfVal", 0,
      ModelVector.FLOAT)
Proportion of dead that fall for each species.

ModelVector javawrapper::SubstrateBehaviors::mp_fProportionOfFallenThatUproot [protected]

Initial value:

 new ModelVector(
      "Proportion of Fallen that Uproot", "su_propOfFallUproot", "su_pofuVal",
      0, ModelVector.FLOAT)
Proportion of fallen that uproot for each species.

ModelVector javawrapper::SubstrateBehaviors::mp_fProportionOfSnagsThatUproot [protected]

Initial value:

 new ModelVector(
      "Proportion of Snags that Uproot", "su_propOfSnagsUproot", "su_posuVal",
      0, ModelVector.FLOAT)
Proportion of snags that uproot for each species.

LEM 04/22/05


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