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
void javawrapper::HarvestData::AddCell | ( | Cell | oNewCell | ) | [inline] |
Adds a cell to the harvest cut range's area.
Duplicates will not be added.
oNewCell | Cell object to add. |
void javawrapper::HarvestData::AddCell | ( | int | iX, | |
int | iY, | |||
Plot | oPlot | |||
) | throws ModelException [inline] |
Adds a cell to the harvest cut range's area.
Duplicates will not be added.
iX | X cell number. | |
iY | Y cell number. | |
oPlot | a Plot object. |
ModelException | if the cell coordinates are invalid. |
void javawrapper::HarvestData::AddCutRange | ( | float | fLow, | |
float | fHigh, | |||
float | fAmountToCut | |||
) | throws ModelException [inline] |
Adds a new cut range.
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. |
ModelException | if any of the following are true:
|
void javawrapper::HarvestData::AddSpecies | ( | int | iSpecies | ) | [inline] |
Adds a new species to apply this harvest cut to.
If this species is already on the list, it is not added again.
iSpecies | Species index. |
Cell javawrapper::HarvestData::GetCell | ( | int | iIndex | ) | throws ModelException [inline] |
Gets a cell in a harvest's cut area.
iIndex | The index of the object. |
ModelException | If the index is not valid. |
float javawrapper::HarvestData::GetCutAmount | ( | int | iCutRangeIndex | ) | throws ModelException [inline] |
Gets the cut amount for a cut range.
iCutRangeIndex | The cut range index. |
ModelException | If the cut range is invalid. |
int javawrapper::HarvestData::GetCutAmountType | ( | ) | [inline] |
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.
int javawrapper::HarvestData::GetCutType | ( | ) | [inline] |
Gets the cut type.
float javawrapper::HarvestData::GetLowerBound | ( | int | iCutRangeIndex | ) | throws ModelException [inline] |
Gets the lower dbh bound value for a cut range.
iCutRangeIndex | The cut range index. |
ModelException | If the cut range is invalid. |
int javawrapper::HarvestData::GetNumberOfCells | ( | ) | [inline] |
Gets the number of cells in the cut range's cut area.
int javawrapper::HarvestData::GetNumberOfCutRanges | ( | ) | [inline] |
Gets the number of cut ranges.
int javawrapper::HarvestData::GetNumberOfSpecies | ( | ) | [inline] |
Gets the number of species to which this cut has been applied.
int javawrapper::HarvestData::GetSpecies | ( | int | iIndex | ) | throws ModelException [inline] |
Gets a species at a certain index within the species list.
iIndex | The species index. |
ModelException | If the index is not valid. |
int javawrapper::HarvestData::GetTimestep | ( | ) | [inline] |
Gets the timestep for this cut event.
float javawrapper::HarvestData::GetUpperBound | ( | int | iCutRangeIndex | ) | throws ModelException [inline] |
Gets the upper dbh bound value for a cut range.
iCutRangeIndex | The cut range index. |
ModelException | If the cut range is invalid. |
void javawrapper::HarvestData::RemoveSpecies | ( | int | iSpecies | ) | [inline] |
Removes a species from the list to which to apply this harvest.
If this species is not on the list, the function quietly exits.
iSpecies | Species number (number identifying the species, NOT the index number in the vector). |
void javawrapper::HarvestData::SetCutAmountType | ( | int | iCut | ) | throws ModelException [inline] |
Sets the cut amount type.
iCut | the cut amount type. Possible values come from DisturbanceBehaviors and are PERCENTAGE_BASAL_AREA, ABSOLUTE_BASAL_AREA, PERCENTAGE_DENSITY, and ABSOLUTE_DENSITY. |
ModelException | if the cut amount type is unrecognized. |
void javawrapper::HarvestData::SetCutType | ( | int | iCut | ) | throws ModelException [inline] |
Sets the cut type.
iCut | The cut type. Values come from DisturbanceBehaviors and are PARTIAL_CUT, GAP_CUT, and CLEAR_CUT. |
ModelException | if the cut type is unrecognized. |
void javawrapper::HarvestData::SetTimestep | ( | int | iTimestep | ) | throws ModelException [inline] |
Sets the timestep for this cut event.
iTimestep | The timestep to set. |
ModelException | if the timestep is less than 0. |
void javawrapper::HarvestData::ValidateCut | ( | TreePopulation | oPop, | |
Plot | oPlot | |||
) | throws ModelException [inline] |
Validates the current set of data in this cut.
This makes sure the following are all true:
oPop | TreePopulation object, to help verify data | |
oPlot | Plot object for timestep verification |
ModelException | if any of the above conditions is not true |