Public Member Functions | |
| int | GetCutAmountType () |
| Gets the cut amount type. | |
| void | SetCutAmountType (int iCut) throws ModelException |
| Sets the cut amount type. | |
| int | GetCutType () |
| Gets the cut type. | |
| void | SetCutType (int iCut) throws ModelException |
| Sets the cut type. | |
| int | GetTimestep () |
| Gets the timestep for this cut event. | |
| void | SetTimestep (int iTimestep) throws ModelException |
| Sets the timestep for this cut event. | |
| int | GetNumberOfSpecies () |
| Gets the number of species to which this cut has been applied. | |
| int | GetSpecies (int iIndex) throws ModelException |
| Gets a species at a certain index within the species list. | |
| void | AddSpecies (int iSpecies) |
| Adds a new species to apply this harvest cut to. | |
| void | RemoveSpecies (int iSpecies) |
| Removes a species from the list to which to apply this harvest. | |
| void | ClearSpecies () |
| Clears the list of species. | |
| int | GetNumberOfCutRanges () |
| Gets the number of cut ranges. | |
| void | AddCutRange (float fLow, float fHigh, float fAmountToCut) throws ModelException |
| Adds a new cut range. | |
| float | GetLowerBound (int iCutRangeIndex) throws ModelException |
| Gets the lower dbh bound value for a cut range. | |
| float | GetUpperBound (int iCutRangeIndex) throws ModelException |
| Gets the upper dbh bound value for a cut range. | |
| float | GetCutAmount (int iCutRangeIndex) throws ModelException |
| Gets the cut amount for a cut range. | |
| int | GetNumberOfCells () |
| Gets the number of cells in the cut range's cut area. | |
| void | AddCell (int iX, int iY, Plot oPlot) throws ModelException |
| Adds a cell to the harvest cut range's area. | |
| void | AddCell (Cell oNewCell) |
| Adds a cell to the harvest cut range's area. | |
| Cell | GetCell (int iIndex) throws ModelException |
| Gets a cell in a harvest's cut area. | |
| void | ValidateCut (TreePopulation oPop, Plot oPlot) throws ModelException |
| Validates the current set of data in this cut. | |
Static Public Attributes | |
| static int | NUMBER_ALLOWED_CUT_RANGES = 4 |
| Maximum number of allowed cut ranges. | |
Private Attributes | |
| Vector | mp_iSpecies = new Vector(0) |
| Species codes to which to apply this harvest cut. | |
| Vector | mp_oCells = new Vector(0) |
| The list of cells to which to apply this cut (vector of Cell objects). | |
| Vector | mp_oCutRanges = new Vector(0) |
| The list of cut ranges and cut amounts (CutRange objects). | |
| int | m_iTimestep = -1 |
| Timestep to which to apply this harvest cut. | |
| int | m_iCutType = -1 |
| The cut type - possible values come from DisturbanceBehaviors and are PARTIAL_CUT, GAP_CUT, and CLEAR_CUT. | |
| int | m_iCutAmountType = -1 |
| How the cut amount is specified - possible values come from DisturbanceBehaviors and are PERCENTAGE_BASAL_AREA, ABSOLUTE_BASAL_AREA, PERCENTAGE_DENSITY, and ABSOLUTE_DENSITY. | |
Copyright: Copyright (c) Charles D. Canham 2003
Company: Institute of Ecosystem Studies
|
|
Adds a cell to the harvest cut range's area. Duplicates will not be added.
Edit history: ------------------ April 28, 2004: Submitted in beta version (LEM) |
|
||||||||||||||||
|
Adds a cell to the harvest cut range's area. Duplicates will not be added.
Edit history: ------------------ April 28, 2004: Submitted in beta version (LEM) |
|
||||||||||||||||
|
Adds a new cut range.
Edit history: ------------------ April 28, 2004: Submitted in beta version (LEM) |
|
|
Adds a new species to apply this harvest cut to. If this species is already on the list, it is not added again.
Edit history: ------------------ April 28, 2004: Submitted in beta version (LEM) |
|
|
Gets a cell in a harvest's cut area.
Edit history: ------------------ April 28, 2004: Submitted in beta version (LEM) |
|
|
Gets the cut amount for a cut range.
Edit history: ------------------ April 28, 2004: Submitted in beta version (LEM) |
|
|
Gets the cut amount type. Possible values come from DisturbanceBehaviors and are PERCENTAGE_BASAL_AREA, ABSOLUTE_BASAL_AREA, PERCENTAGE_DENSITY, and ABSOLUTE_DENSITY, or -1 if the value has not yet been set.
Edit history: ------------------ April 28, 2004: Submitted in beta version (LEM) |
|
|
Gets the cut type.
Edit history: ------------------ April 28, 2004: Submitted in beta version (LEM) |
|
|
Gets the lower dbh bound value for a cut range.
Edit history: ------------------ April 28, 2004: Submitted in beta version (LEM) |
|
|
Gets the number of cells in the cut range's cut area.
Edit history: ------------------ April 28, 2004: Submitted in beta version (LEM) |
|
|
Gets the number of cut ranges.
Edit history: ------------------ April 28, 2004: Submitted in beta version (LEM) |
|
|
Gets the number of species to which this cut has been applied.
Edit history: ------------------ April 28, 2004: Submitted in beta version (LEM) |
|
|
Gets a species at a certain index within the species list.
Edit history: ------------------ April 28, 2004: Submitted in beta version (LEM) |
|
|
Gets the timestep for this cut event.
Edit history: ------------------ April 28, 2004: Submitted in beta version (LEM) |
|
|
Gets the upper dbh bound value for a cut range.
Edit history: ------------------ April 28, 2004: Submitted in beta version (LEM) |
|
|
Removes a species from the list to which to apply this harvest. If this species is not on the list, the function quietly exits.
|
|
|
Sets the cut amount type.
Edit history: ------------------ April 28, 2004: Submitted in beta version (LEM) |
|
|
Sets the cut type.
Edit history: ------------------ April 28, 2004: Submitted in beta version (LEM) |
|
|
Sets the timestep for this cut event.
Edit history: ------------------ April 28, 2004: Submitted in beta version (LEM) |
|
||||||||||||
|
Validates the current set of data in this cut. This makes sure the following are all true:
Edit history: ------------------ April 28, 2004: Submitted in beta version (LEM) |
1.4.6-NO