javawrapper.AnalysisBehaviors Class Reference

Manages analysis behaviors and data. More...

Inheritance diagram for javawrapper.AnalysisBehaviors:

javawrapper.BehaviorTypeBase javawrapper.WorkerBase

List of all members.

Public Member Functions

 AnalysisBehaviors (GUIManager oManager) throws ModelException
 Constructor.
void DoSetup (TreePopulation oPop) throws javawrapper.ModelException
 Sets up the enum parameters and grids.
void ValidateData (TreePopulation oPop) throws ModelException
 Validates the data before writing to a parameter file.

Protected Attributes

ModelVector mp_fTaperA
 Volume calculator - a in the taper equation (also known as a0).
ModelVector mp_fTaperB
 Volume calculator - b in the taper equation (also known as a1).
ModelVector mp_fTaperC
 Volume calculator - c in the taper equation (also known as a2).
ModelVector mp_fTaperD
 Volume calculator - d in the taper equation (also known as b1).
ModelVector mp_fTaperF
 Volume calculator - f in the taper equation (also known as b2).
ModelVector mp_fTaperG
 Volume calculator - g in the taper equation (also known as b3).
ModelVector mp_fTaperI
 Volume calculator - i in the taper equation (also known as b4).
ModelVector mp_fTaperJ
 Volume calculator - j in the taper equation (also known as b5).
ModelVector mp_fTaperK
 Volume calculator - k in the taper equation (also known as b6).
ModelVector mp_fBarkA
 Volume calculator - a for the diameter-outside-bark (also known as a1).
ModelVector mp_fBarkB
 Volume calculator - b for the diameter-outside-bark (also known as a2).
ModelVector mp_fBarkC
 Volume calculator - c for the diameter-outside-bark (also known as a3).
ModelVector mp_iEquationID
 Dimension analysis - equation ID.
ModelVector mp_iDbhUnits
 Dimension analysis - DBH units.
ModelVector mp_iBiomassUnits
 Dimension analysis - biomass units.
ModelVector mp_iUseCorrectionFactor
 Dimension analysis - whether or not to use a correction factor.
ModelVector mp_fCorrectionFactor
 Dimension analysis - correction factor value.
ModelVector mp_fBiomassA
 Dimension analysis - a in the biomass equation.
ModelVector mp_fBiomassB
 Dimension analysis - b in the biomass equation.
ModelVector mp_fBiomassC
 Dimension analysis - c in the biomass equation.
ModelVector mp_fBiomassD
 Dimension analysis - d in the biomass equation.
ModelVector mp_fBiomassE
 Dimension analysis - e in the biomass equation.
ModelVector mp_fBoleVolumeB0
 Bole volume - b0 in the volume equation.
ModelVector mp_fBoleVolumeB1
 Bole volume - b1 in the volume equation.
ModelVector mp_fBoleVolumeB2
 Bole volume - b2 in the volume equation.
ModelVector mp_fBoleVolumeB3
 Bole volume - b3 in the volume equation.
ModelVector mp_fBoleVolumeB4
 Bole volume - b4 in the volume equation.
ModelVector mp_fBoleVolumeB5
 Bole volume - b5 in the volume equation.
ModelVector mp_fBoleVolumeFormClasses
 Bole volume - form classes.
ModelVector mp_fMerchValueFormClasses
 Merchantable timber value - form classes.
ModelVector mp_fMerchValuePricePer1K
 Merchantable timber value - price per thousand board feet.
ModelVector mp_fCarbonValuePercentBiomassCarbon
 Carbon value - % of biomass that is carbon.
ModelVector mp_fPartBioDbhLeafA
 Partitioned DBH biomass - Leaf DBH-biomass "a".
ModelVector mp_fPartBioDbhLeafB
 Partitioned DBH biomass - Leaf DBH-biomass "b".
ModelVector mp_fPartBioDbhBranchA
 Partitioned DBH biomass - Branch DBH-biomass "a".
ModelVector mp_fPartBioDbhBranchB
 Partitioned DBH biomass - Branch DBH-biomass "b".
ModelVector mp_fPartBioDbhBoleA
 Partitioned DBH biomass - Bole DBH-biomass "a".
ModelVector mp_fPartBioDbhBoleB
 Partitioned DBH biomass - Bole DBH-biomass "b".
ModelVector mp_fFoliarChemA
 Foliar chemistry - foliar weight "a".
ModelVector mp_fFoliarChemB
 Foliar chemistry - foliar weight "b".
ModelVector mp_fFoliarChemN
 Foliar chemistry - N concentration.
ModelVector mp_fFoliarChemP
 Foliar chemistry - P concentration.
ModelVector mp_fFoliarChemLignin
 Foliar chemistry - lignin concentration.
ModelVector mp_fFoliarChemFiber
 Foliar chemistry - fiber concentration.
ModelVector mp_fFoliarChemCellulose
 Foliar chemistry - cellulose concentration.
ModelVector mp_fFoliarChemTannins
 Foliar chemistry - tannins concentration.
ModelVector mp_fFoliarChemPhenolics
 Foliar chemistry - phenolics concentration.
ModelVector mp_fFoliarChemSLA
 Foliar chemistry - SLA concentration.
ModelVector mp_fPartBioHeightLeafA
 Partitioned height biomass - Leaf height-biomass "a".
ModelVector mp_fPartBioHeightLeafB
 Partitioned height biomass - Leaf height-biomass "b".
ModelVector mp_fPartBioHeightBoleA
 Partitioned height biomass - Bole height-biomass "a".
ModelVector mp_fPartBioHeightBoleB
 Partitioned height biomass - Bole height-biomass "b".
ModelFloat m_fStumpHeight
 Volume calculator - stump height, in cm.
ModelFloat m_fMinUsableDiam
 Volume calculator - minimum usable diameter, in cm.
ModelFloat m_fSegmentLength
 Volume calculator - Length of tree trunk volume segments, in m.
ModelFloat m_fCarbonValueCarbonPrice
 Carbon value - value of metric ton of carbon.
ModelFloat m_fRipleysKMaxDistance
 Ripley's K - maximum distance.
ModelFloat m_fRipleysKDistanceInc
 Ripley's K - distance increment.
ModelFloat m_fConditsOmegaMaxDistance
 Relative neighborhood density (Condit's omega) - maximum distance.
ModelFloat m_fConditsOmegaDistanceInc
 Relative neighborhood density (Condit's omega) - distance increment.


Detailed Description

Manages analysis behaviors and data.

Analysis behaviors are those whose only purpose is to calculate something for output; they don't change model state.

Copyright: Copyright (c) Charles D. Canham 2003 Company: Institute of Ecosystem Studies

Author:
Lora E. Murphy
Version:
1.0

Edit history:
------------------
October 28, 2004: Created (LEM)
February 1, 2004: Added biomass behavior (LEM)
March 23, 2005: Added dimension analysis behavior (LEM)
March 28, 2005: Added bole volume behavior (LEM)
January 11, 2006: Added tree age calculator behavior (LEM)
March 10, 2006: Added merchantable timber value behavior (LEM)
March 15, 2006: Added carbon value behavior (LEM)
April 25, 2006: Added carbon value tree data member (LEM)
November 7, 2006: Added partitioned biomass behaviors (LEM)
September 13, 2007: Added Ripley's K calculator behavior (LEM)
January 23, 2008: Updated partitioned biomass behavior (LEM)
June 18, 2008: Added crown radius reporter behavior (LEM)
December 11, 2008: Added foliar chemistry behavior (LEM)

Constructor & Destructor Documentation

javawrapper.AnalysisBehaviors.AnalysisBehaviors ( GUIManager  oManager  )  throws ModelException

Constructor.

Parameters:
oManager GUIManager object.
Exceptions:
ModelException passed through from called functions.


Member Function Documentation

void javawrapper.AnalysisBehaviors.DoSetup ( TreePopulation  oPop  )  throws javawrapper.ModelException [virtual]

Sets up the enum parameters and grids.

Parameters:
oPop TreePopulation object.
Exceptions:
javawrapper.ModelException Doesn't throw this exception.

Implements javawrapper.WorkerBase.

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

Validates the data before writing to a parameter file.

Exceptions:
ModelException if:
  • Volume calculator is enabled, and either m_fStumpHeight or m_fMinUsableDiam, is less than 0, or m_fSegmentLength is less than or equal to 0;
  • Bole volume calculator is enabled, and a form class is not between 60 and 100.
  • Carbon value calculator is enabled, and the percent of biomass that is carbon is not between 0 and 100.
  • Carbon value calculator is enabled, and the dimension analysis behavior is not enabled.
  • Ripley's K Calculator behavior is enabled and either the increment or the max distance are less than or equal to zero, or if the increment is less than the max distance
Parameters:
oPop Not used.

Implements javawrapper.WorkerBase.


Member Data Documentation

Initial value:

 new ModelVector(
                        "Taper Equation Initial Multiplier (a0)", "vo_taperA", "vo_taVal", 0,
                        ModelVector.FLOAT)
Volume calculator - a in the taper equation (also known as a0).

Initial value:

 new ModelVector(
                        "Taper Equation DBH Exponent (a1)", "vo_taperB", "vo_tbVal", 0,
                        ModelVector.FLOAT)
Volume calculator - b in the taper equation (also known as a1).

Initial value:

 new ModelVector(
                        "Taper Equation Height Exponent (a2)", "vo_taperC", "vo_tcVal", 0,
                        ModelVector.FLOAT)
Volume calculator - c in the taper equation (also known as a2).

Initial value:

 new ModelVector(
                        "Taper Equation X Exponent 1 (b1)", "vo_taperD", "vo_tdVal", 0,
                        ModelVector.FLOAT)
Volume calculator - d in the taper equation (also known as b1).

Initial value:

 new ModelVector(
                        "Taper Equation X Exponent 2 (b2)", "vo_taperF", "vo_tfVal", 0,
                        ModelVector.FLOAT)
Volume calculator - f in the taper equation (also known as b2).

Initial value:

 new ModelVector(
                        "Taper Equation X Exponent 3 (b3)", "vo_taperG", "vo_tgVal", 0,
                        ModelVector.FLOAT)
Volume calculator - g in the taper equation (also known as b3).

Initial value:

 new ModelVector(
                        "Taper Equation X Exponent 4 (b4)", "vo_taperI", "vo_tiVal", 0,
                        ModelVector.FLOAT)
Volume calculator - i in the taper equation (also known as b4).

Initial value:

 new ModelVector(
                        "Taper Equation X Exponent 5 (b5)", "vo_taperJ", "vo_tjVal", 0,
                        ModelVector.FLOAT)
Volume calculator - j in the taper equation (also known as b5).

Initial value:

 new ModelVector(
                        "Taper Equation X Exponent 6 (b6)", "vo_taperK", "vo_tkVal", 0,
                        ModelVector.FLOAT)
Volume calculator - k in the taper equation (also known as b6).

Initial value:

 new ModelVector(
                        "Diameter-Outside-Bark Constant (a1)", "vo_barkA", "vo_baVal", 0,
                        ModelVector.FLOAT)
Volume calculator - a for the diameter-outside-bark (also known as a1).

Initial value:

 new ModelVector(
                        "Diameter-Outside-Bark First Degree Parameter (a2)", "vo_barkB",
                        "vo_bbVal", 0, ModelVector.FLOAT)
Volume calculator - b for the diameter-outside-bark (also known as a2).

Initial value:

 new ModelVector(
                        "Diameter-Outside-Bark Second Degree Parameter (a3)", "vo_barkC",
                        "vo_bcVal", 0, ModelVector.FLOAT)
Volume calculator - c for the diameter-outside-bark (also known as a3).

Initial value:

 new ModelVector(
                        "Dimension Analysis Equation ID", "bi_eqID", "bi_eiVal", 0,
                        ModelVector.MODEL_ENUM)
Dimension analysis - equation ID.

Initial value:

 new ModelVector(
                        "Dimension Analysis DBH Units", "bi_dbhUnits", "bi_duVal", 0,
                        ModelVector.MODEL_ENUM)
Dimension analysis - DBH units.

Initial value:

 new ModelVector(
                        "Dimension Analysis Biomass Units", "bi_biomassUnits", "bi_buVal", 0,
                        ModelVector.MODEL_ENUM)
Dimension analysis - biomass units.

Initial value:

 new ModelVector(
                        "Dimension Analysis: Use Correction Factor?", "bi_useCorrectionFactor",
                        "bi_ucfVal", 0, ModelVector.MODEL_ENUM)
Dimension analysis - whether or not to use a correction factor.

Initial value:

 new ModelVector(
                        "Dimension Analysis Correction Factor", "bi_correctionFactorValue",
                        "bi_cfvVal ", 0, ModelVector.FLOAT)
Dimension analysis - correction factor value.

Initial value:

 new ModelVector(
                        "Dimension Analysis Parameter (a)", "bi_a", "bi_aVal", 0,
                        ModelVector.FLOAT)
Dimension analysis - a in the biomass equation.

Initial value:

 new ModelVector(
                        "Dimension Analysis Parameter (b)", "bi_b", "bi_bVal", 0,
                        ModelVector.FLOAT)
Dimension analysis - b in the biomass equation.

Initial value:

 new ModelVector(
                        "Dimension Analysis Parameter (c)", "bi_c", "bi_cVal", 0,
                        ModelVector.FLOAT)
Dimension analysis - c in the biomass equation.

Initial value:

 new ModelVector(
                        "Dimension Analysis Parameter (d)", "bi_d", "bi_dVal", 0,
                        ModelVector.FLOAT)
Dimension analysis - d in the biomass equation.

Initial value:

 new ModelVector(
                        "Dimension Analysis Parameter (e)", "bi_e", "bi_eVal", 0,
                        ModelVector.FLOAT)
Dimension analysis - e in the biomass equation.

Initial value:

 new ModelVector(
                        "Bole Volume Parameter (b0)", "an_boleB0", "an_bb0Val", 0,
                        ModelVector.FLOAT)
Bole volume - b0 in the volume equation.

Initial value:

 new ModelVector(
                        "Bole Volume Parameter (b1)", "an_boleB1", "an_bb1Val", 0,
                        ModelVector.FLOAT)
Bole volume - b1 in the volume equation.

Initial value:

 new ModelVector(
                        "Bole Volume Parameter (b2)", "an_boleB2", "an_bb2Val", 0,
                        ModelVector.FLOAT)
Bole volume - b2 in the volume equation.

Initial value:

 new ModelVector(
                        "Bole Volume Parameter (b3)", "an_boleB3", "an_bb3Val", 0,
                        ModelVector.FLOAT)
Bole volume - b3 in the volume equation.

Initial value:

 new ModelVector(
                        "Bole Volume Parameter (b4)", "an_boleB4", "an_bb4Val", 0,
                        ModelVector.FLOAT)
Bole volume - b4 in the volume equation.

Initial value:

 new ModelVector(
                        "Bole Volume Parameter (b5)", "an_boleB5", "an_bb5Val", 0,
                        ModelVector.FLOAT)
Bole volume - b5 in the volume equation.

Initial value:

 new ModelVector(
                        "Bole Volume Form Class, 60% - 100%", "an_boleFormClasses", "an_bfcVal",
                        0, ModelVector.FLOAT)
Bole volume - form classes.

Initial value:

 new ModelVector(
                        "Merchantable Timber Value Form Class", "an_merchValueFormClasses",
                        "an_mvfcVal", 0, ModelVector.MODEL_ENUM)
Merchantable timber value - form classes.

Initial value:

 new ModelVector(
                        "Merchantable Timber Value Price / 1000 Board Feet",
                        "an_merchValuePricePer1KFeet", "an_mvpp1kfVal", 0, ModelVector.FLOAT)
Merchantable timber value - price per thousand board feet.

Initial value:

 new ModelVector(
                        "Carbon Value - Carbon Amount of Biomass (0-100%)",
                        "an_carbonPercentBiomassCarbon", "an_cpbcVal", 0, ModelVector.FLOAT)
Carbon value - % of biomass that is carbon.

Initial value:

 new ModelVector(
                        "Partitioned DBH Biomass - Leaf Slope (a)", "an_partBioDbhLeafA",
                        "an_pbdlaVal", 0, ModelVector.FLOAT)
Partitioned DBH biomass - Leaf DBH-biomass "a".

Initial value:

 new ModelVector(
                        "Partitioned DBH Biomass - Leaf Intercept (b)", "an_partBioDbhLeafB",
                        "an_pbdlbVal", 0, ModelVector.FLOAT)
Partitioned DBH biomass - Leaf DBH-biomass "b".

Initial value:

 new ModelVector(
                        "Partitioned DBH Biomass - Branch Slope (a)", "an_partBioDbhBranchA",
                        "an_pbdbraVal", 0, ModelVector.FLOAT)
Partitioned DBH biomass - Branch DBH-biomass "a".

Initial value:

 new ModelVector(
                        "Partitioned DBH Biomass - Branch Intercept (b)", "an_partBioDbhBranchB",
                        "an_pbdbrbVal", 0, ModelVector.FLOAT)
Partitioned DBH biomass - Branch DBH-biomass "b".

Initial value:

 new ModelVector(
                        "Partitioned DBH Biomass - Bole Slope (a)", "an_partBioDbhBoleA",
                        "an_pbdboaVal", 0, ModelVector.FLOAT)
Partitioned DBH biomass - Bole DBH-biomass "a".

Initial value:

 new ModelVector(
                        "Partitioned DBH Biomass - Bole Intercept (b)", "an_partBioDbhBoleB",
                        "an_pbdbobVal", 0, ModelVector.FLOAT)
Partitioned DBH biomass - Bole DBH-biomass "b".

Initial value:

 new ModelVector(
      "Foliar Chemistry - Foliar Weight (a)", "an_foliarChemWeightA",
      "an_fcwaVal", 0, ModelVector.FLOAT)
Foliar chemistry - foliar weight "a".

Initial value:

 new ModelVector(
      "Foliar Chemistry - Foliar Weight (b)", "an_foliarChemWeightB",
      "an_fcwbVal", 0, ModelVector.FLOAT)
Foliar chemistry - foliar weight "b".

Initial value:

 new ModelVector(
                        "Foliar Chemistry - N Concentration", "an_foliarChemN",
                        "an_fcnVal", 0, ModelVector.FLOAT)
Foliar chemistry - N concentration.

Initial value:

 new ModelVector(
                        "Foliar Chemistry - P Concentration", "an_foliarChemP",
                        "an_fcpVal", 0, ModelVector.FLOAT)
Foliar chemistry - P concentration.

Initial value:

 new ModelVector(
                        "Foliar Chemistry - Lignin Concentration", "an_foliarChemLignin",
                        "an_fclVal", 0, ModelVector.FLOAT)
Foliar chemistry - lignin concentration.

Initial value:

 new ModelVector(
                        "Foliar Chemistry - Fiber Concentration", "an_foliarChemFiber",
                        "an_fcfVal", 0, ModelVector.FLOAT)
Foliar chemistry - fiber concentration.

Initial value:

 new ModelVector(
                        "Foliar Chemistry - Cellulose Concentration", "an_foliarChemCellulose",
                        "an_fccVal", 0, ModelVector.FLOAT)
Foliar chemistry - cellulose concentration.

Initial value:

 new ModelVector(
                        "Foliar Chemistry - Tannins Concentration", "an_foliarChemTannins",
                        "an_fctVal", 0, ModelVector.FLOAT)
Foliar chemistry - tannins concentration.

Initial value:

 new ModelVector(
                        "Foliar Chemistry - Phenolics Concentration", "an_foliarChemPhenolics",
                        "an_fcphVal", 0, ModelVector.FLOAT)
Foliar chemistry - phenolics concentration.

Initial value:

 new ModelVector(
                        "Foliar Chemistry - SLA Concentration", "an_foliarChemSLA",
                        "an_fcsVal", 0, ModelVector.FLOAT)
Foliar chemistry - SLA concentration.

Initial value:

 new ModelVector(
                        "Partitioned Palm Biomass - Leaf Slope (a)", "an_partBioHeightLeafA",
                        "an_pbhlaVal", 0, ModelVector.FLOAT)
Partitioned height biomass - Leaf height-biomass "a".

Initial value:

 new ModelVector(
                        "Partitioned Palm Biomass - Leaf Intercept (b)", "an_partBioHeightLeafB",
                        "an_pbhlbVal", 0, ModelVector.FLOAT)
Partitioned height biomass - Leaf height-biomass "b".

Initial value:

 new ModelVector(
                        "Partitioned Palm Biomass - Bole Slope (a)", "an_partBioHeightBoleA",
                        "an_pbhboaVal", 0, ModelVector.FLOAT)
Partitioned height biomass - Bole height-biomass "a".

Initial value:

 new ModelVector(
                        "Partitioned Palm Biomass - Bole Intercept (b)", "an_partBioHeightBoleB",
                        "an_pbhbobVal", 0, ModelVector.FLOAT)
Partitioned height biomass - Bole height-biomass "b".

Initial value:

 new ModelFloat(0,
                        "Height to Begin Calculating Trunk Volume, in cm", "vo_stumpHeight")
Volume calculator - stump height, in cm.

Point at which to start summing trunk volume

Initial value:

 new ModelFloat(0,
                        "Minimum Trunk Diameter for Volume Calculations, in cm",
                        "vo_minUsableDiam")
Volume calculator - minimum usable diameter, in cm.

Point at which to stop summing trunk volume

Initial value:

 new ModelFloat(0,
                        "Trunk Segment Length for Volume Calculations, in m", "vo_segmentLength")
Volume calculator - Length of tree trunk volume segments, in m.

Initial value:

 new ModelFloat(0,
                        "Carbon Value - Price Per Metric Ton Carbon",
                        "an_carbonPricePerMetricTonCarbon")
Carbon value - value of metric ton of carbon.

Initial value:

 new ModelFloat(50,
                        "Ripley's K - Maximum Distance (m)", "an_RipleysKMaxDistance")
Ripley's K - maximum distance.

Initial value:

 new ModelFloat(1,
                        "Ripley's K - Distance Increment (m)", "an_RipleysKDistanceInc")
Ripley's K - distance increment.

Initial value:

 new ModelFloat(50,
                        "Relative Neighborhood Density - Maximum Distance (m)", "an_ConditsOmegaMaxDistance")
Relative neighborhood density (Condit's omega) - maximum distance.

Initial value:

 new ModelFloat(1,
                        "Relative Neighborhood Density - Distance Increment (m)", "an_ConditsOmegaDistanceInc")
Relative neighborhood density (Condit's omega) - distance increment.


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

Generated on Wed Oct 28 14:01:19 2009 for SORTIE Java Interface by  doxygen 1.5.6