javawrapper::CutRange Class Reference

This class defines a cut range for a harvest event. More...

List of all members.

Public Member Functions

 CutRange (float fLow, float fHigh, float fAmountToCut, HarvestData oParent) throws ModelException
 Constructor.
float GetLowBound ()
 Gets the lower bound value of the dbh cut range.
float GetHighBound ()
 Gets the upper bound value of the dbh cut range.
float GetAmountToCut ()
 Gets the amount to cut.

Private Attributes

float m_fLowDbh
 Low end of the dbh range.
float m_fHighDbh
 High end of the dbh range.
float m_fAmountToCut
 Amount to cut, according to the cut type.


Detailed Description

This class defines a cut range for a harvest event.

Copyright: Copyright (c) Charles D. Canham 2003

Company: Institute of Ecosystem Studies

Author:
Lora E. Murphy
Version:
1.0

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


Constructor & Destructor Documentation

javawrapper::CutRange::CutRange float  fLow,
float  fHigh,
float  fAmountToCut,
HarvestData  oParent
throws ModelException [inline]
 

Constructor.

Parameters:
fLow Lower bound of the cut range, as a dbh in cm.
fHigh Upper bound of the cut range, as a dbh in cm.
fAmountToCut Amount to cut. If the amount cut type is as a percentage of either basal area or density, this is a percentage value between 0 and 100. If it is amount of basal area, this is basal area in square meters per hectare. If this is amount of density, this is number of trees per hectare.
oParent Parent HarvestData object.
Exceptions:
ModelException if any of the following are true:
  • A dbh bound value is less than 0
  • The upper bound value is less than the lower bound value
  • The amount to cut is negative
  • If the amount to cut is a percentage, the value is either less than 0 or greater than 100

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


Member Function Documentation

float javawrapper::CutRange::GetAmountToCut  )  [inline]
 

Gets the amount to cut.

Returns:
The amount to cut.

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

float javawrapper::CutRange::GetHighBound  )  [inline]
 

Gets the upper bound value of the dbh cut range.

Returns:
The upper dbh.

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

float javawrapper::CutRange::GetLowBound  )  [inline]
 

Gets the lower bound value of the dbh cut range.

Returns:
The lower dbh.

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


The documentation for this class was generated from the following file:
Generated on Mon Mar 27 15:15:40 2006 for SORTIE Java Interface by  doxygen 1.4.6-NO