javawrapper.EpiphyticEstablishmentBehaviors Class Reference

Manages treefern establishment. More...

Inheritance diagram for javawrapper.EpiphyticEstablishmentBehaviors:

javawrapper.BehaviorTypeBase javawrapper.WorkerBase

List of all members.

Public Member Functions

 EpiphyticEstablishmentBehaviors (GUIManager oManager) throws ModelException
 Constructor.
void DoSetup (TreePopulation oPop)
 Adds all species to the species seedling choice.
void ValidateData (TreePopulation oPop) throws ModelException
 Validates the data in preparation for parameter file writing or some such.
void EndOfParameterFileRead ()
 Checks to see if there are light parameters that could be grabbed as defaults.
boolean SetSingleValueByXMLTag (String sXMLTag, String sXMLParentTag, org.xml.sax.Attributes oAttributes, Object oData) throws ModelException
 Find light values for epiphytic establishment and reject those for light behaviors.
boolean SetVectorValueByXMLTag (String sXMLTag, String sXMLParentTag, Vector< String > p_oData, String[] p_sChildXMLTags, boolean[] p_bAppliesTo, org.xml.sax.Attributes oParentAttributes, org.xml.sax.Attributes[] p_oAttributes) throws ModelException
 Find light values for epiphytic establishment and reject those for light behaviors.

Protected Attributes

ModelVector mp_fTreeFernRecruitA
 Treefern Establishment - a in the seedling probability equation.
ModelVector mp_fTreeFernRecruitB
 Treefern Establishment - b in the seedling probability equation.
ModelVector mp_fTreeFernRecruitC
 Treefern Establishment - c in the seedling probability equation.
ModelVector mp_fTreeFernRecruitM
 Treefern Establishment - m in the seedling probability equation.
ModelVector mp_fTreeFernRecruitN
 Treefern Establishment - n in the seedling probability equation.
ModelVector mp_fSnagClass1LightTransmissionCoefficient
 Species-specific - snag age class 1 amount of light transmission.
ModelVector mp_fSnagClass2LightTransmissionCoefficient
 Species-specific - snag age class 2 light transmission coefficient.
ModelVector mp_fSnagClass3LightTransmissionCoefficient
 Species-specific - snag age class 3 light transmission coefficient.
ModelFloat m_fBeamFractionOfGlobalRadiation
 Treefern Establishment - Beam fraction of global radiation.
ModelFloat m_fClearSkyTransmissionCoefficient
 Treefern Establishment - Clear sky transmission coefficient.
ModelVector mp_fLightTransmissionCoefficient
 Treefern Establishment - Light extinction coefficient.
ModelFloat m_fMinSunAngle
 Treefern Establishment - Minimum sun angle in radians for GLI.
ModelInt m_iNumAziDiv
 Treefern Establishment - Number of azimuth divisions for GLI.
ModelInt m_iNumAltDiv
 Treefern Establishment - Number of altitude divisions for GLI.
ModelInt m_iSnagAgeClass1
 Upper age limit of snag size class 1.
ModelInt m_iSnagAgeClass2
 Upper age limit of snag size class 2.
ModelInt m_iJulianDayGrowthStarts
 Start of growing season as Julian day.
ModelInt m_iJulianDayGrowthEnds
 End of growing season as Julian day.


Detailed Description

Manages treefern establishment.

Copyright: Copyright (c) 2009 Charles D. Canham

Company: Institute of Ecosystem Studies

Author:
Lora E. Murphy

Edit history:
------------------
December 16, 2009: Created (LEM)

Constructor & Destructor Documentation

javawrapper.EpiphyticEstablishmentBehaviors.EpiphyticEstablishmentBehaviors ( GUIManager  oManager  )  throws ModelException

Constructor.

Parameters:
oManager GUIManager object.
Exceptions:
ModelException won't.


Member Function Documentation

void javawrapper.EpiphyticEstablishmentBehaviors.DoSetup ( TreePopulation  oPop  )  [virtual]

Adds all species to the species seedling choice.

Parameters:
oPop Tree population

Implements javawrapper.WorkerBase.

void javawrapper.EpiphyticEstablishmentBehaviors.ValidateData ( TreePopulation  oPop  )  throws ModelException [virtual]

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

Exceptions:
ModelException if any of the probabilities are not proportions, or if the probabilities for a class don't add up to 1.
Parameters:
oPop Not used.

Implements javawrapper.WorkerBase.

void javawrapper.EpiphyticEstablishmentBehaviors.EndOfParameterFileRead (  ) 

Checks to see if there are light parameters that could be grabbed as defaults.

Reimplemented from javawrapper.WorkerBase.

boolean javawrapper.EpiphyticEstablishmentBehaviors.SetSingleValueByXMLTag ( String  sXMLTag,
String  sXMLParentTag,
org.xml.sax.Attributes  oAttributes,
Object  oData 
) throws ModelException

Find light values for epiphytic establishment and reject those for light behaviors.

Parameters:
sXMLTag XML tag of object to assign.
sXMLParentTag The immediate parent tag that sXMLTag is within.
oAttributes Ignored.
oData Data to assign.
Returns:
true if assigned, or false if not.
Exceptions:
ModelException not thrown here.

boolean javawrapper.EpiphyticEstablishmentBehaviors.SetVectorValueByXMLTag ( String  sXMLTag,
String  sXMLParentTag,
Vector< String >  p_oData,
String[]  p_sChildXMLTags,
boolean[]  p_bAppliesTo,
org.xml.sax.Attributes  oParentAttributes,
org.xml.sax.Attributes[]  p_oAttributes 
) throws ModelException

Find light values for epiphytic establishment and reject those for light behaviors.

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.
Exceptions:
ModelException if the value could not be assigned to the data object.


Member Data Documentation

Initial value:

 new ModelVector(
      "Tree Fern Establishment Seedling Prob \"a\"", "ep_epiphyticA", "ep_eaVal", 0,
      ModelVector.FLOAT)
Treefern Establishment - a in the seedling probability equation.

Initial value:

 new ModelVector(
      "Tree Fern Establishment Seedling Prob \"b\"", "ep_epiphyticB", "ep_ebVal", 0,
      ModelVector.FLOAT)
Treefern Establishment - b in the seedling probability equation.

Initial value:

 new ModelVector(
      "Tree Fern Establishment Seedling Prob \"c\"", "ep_epiphyticC", "ep_ecVal", 0,
      ModelVector.FLOAT)
Treefern Establishment - c in the seedling probability equation.

Initial value:

 new ModelVector(
      "Tree Fern Establishment Seedling Height \"m\"", "ep_epiphyticM", 
      "ep_emVal", 0, ModelVector.FLOAT)
Treefern Establishment - m in the seedling probability equation.

Initial value:

 new ModelVector(
      "Tree Fern Establishment Seedling Height \"n\"", "ep_epiphyticN", 
      "ep_enVal", 0, ModelVector.FLOAT)
Treefern Establishment - n in the seedling probability equation.

Initial value:

 new
      ModelVector("Snag Age Class 1 Amount Canopy Light Transmission (0-1)",
                  "li_snag1LightExtinctionCoefficient", "li_s1lecVal", 0,
                  ModelVector.FLOAT, true)
Species-specific - snag age class 1 amount of light transmission.

Initial value:

 new
      ModelVector("Snag Age Class 2 Amount Canopy Light Transmission (0-1)",
                  "li_snag2LightExtinctionCoefficient", "li_s2lecVal", 0,
                  ModelVector.FLOAT, true)
Species-specific - snag age class 2 light transmission coefficient.

Initial value:

 new
      ModelVector("Snag Age Class 3 Amount Canopy Light Transmission (0-1)",
                  "li_snag3LightExtinctionCoefficient", "li_s3lecVal", 0,
                  ModelVector.FLOAT, true)
Species-specific - snag age class 3 light transmission coefficient.

Initial value:

 new ModelFloat(0,
      "Beam Fraction of Global Radiation", "li_beamFractGlobalRad")
Treefern Establishment - Beam fraction of global radiation.

Initial value:

 new ModelFloat(0,
      "Clear Sky Transmission Coefficient", "li_clearSkyTransCoeff")
Treefern Establishment - Clear sky transmission coefficient.

Initial value:

 new ModelVector(
      "Amount Canopy Light Transmission (0-1)",
      "li_lightExtinctionCoefficient", "li_lecVal", 0,
      ModelVector.FLOAT, true)
Treefern Establishment - Light extinction coefficient.

Initial value:

 new ModelFloat(0,
      "Minimum Solar Angle for GLI Calculations, in rad", "li_minSunAngle")
Treefern Establishment - Minimum sun angle in radians for GLI.

Initial value:

 new ModelInt(0,
         "Number of Azimuth Sky Divisions for GLI Light Calculations",
                                                 "li_numAziGrids")
Treefern Establishment - Number of azimuth divisions for GLI.

Initial value:

 new ModelInt(0,
         "Number of Altitude Sky Divisions for GLI Light Calculations",
                                                 "li_numAltGrids")
Treefern Establishment - Number of altitude divisions for GLI.

Initial value:

 new ModelInt(0,
      "Upper Age (Yrs) of Snag Light Transmission Class 1", "li_snagAgeClass1")
Upper age limit of snag size class 1.

Initial value:

 new ModelInt(0,
      "Upper Age (Yrs) of Snag Light Transmission Class 2", "li_snagAgeClass2")
Upper age limit of snag size class 2.

Initial value:

 new ModelInt(0,
      "First Day of Growing Season for GLI Light Calculations",
      "li_julianDayGrowthStarts")
Start of growing season as Julian day.

Initial value:

 new ModelInt(0,
      "Last Day of Growing Season for GLI Light Calculations",
      "li_julianDayGrowthEnds")
End of growing season as Julian day.


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

Generated on Tue Apr 19 13:59:39 2011 for SORTIE Java Interface by  doxygen 1.5.6