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_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.

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)


Constructor & Destructor Documentation

javawrapper::AnalysisBehaviors::AnalysisBehaviors ( GUIManager  oManager  )  throws ModelException [inline]

Constructor.

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

Edit history:
------------------
October 27, 2004: Created (LEM)
February 1, 2004: Added biomass behavior (LEM)
March 23, 3005: Replaced biomass behavior with dimension analysis (LEMO
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)


Member Function Documentation

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

Sets up the enum parameters and grids.

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

Edit history:
------------------
October 27, 2004: Submitted in beta version (LEM)
March 23, 2005: Added enum dimension analysis parameters
March 10, 2006: Added enum and grid for merchantable timber value form classes (LEM)
March 15, 2006: Added grid for carbon value (LEM)

Implements javawrapper::WorkerBase.

void javawrapper::AnalysisBehaviors::ValidateData ( TreePopulation  oPop  )  throws ModelException [inline, 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.
Parameters:
oPop Not used.

Edit history:
------------------
October 27, 2004: Created (LEM)
November 30, 2004: Made segment length validation to a positive number (LEM)
March 28, 2005: Added bole volume data validation (LEM)
March 15, 2006: Added carbon value data validation (LEM)

Implements javawrapper::WorkerBase.


Member Data Documentation

ModelFloat javawrapper::AnalysisBehaviors::m_fStumpHeight [protected]

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

ModelFloat javawrapper::AnalysisBehaviors::m_fMinUsableDiam [protected]

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


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