Public Member Functions | |
PlantingData () | |
Constructor. | |
int | GetPlantSpacing () |
Gets the plant spacing. | |
void | SetPlantSpacing (int iSpacing) throws ModelException |
Sets the plant spacing. | |
int | GetTimestep () |
Gets the timestep for this planting event. | |
void | RemoveSpecies (int iSpecies) |
Removes a species from the list to which to apply this harvest. | |
void | ClearSpecies () |
Clears the list of species. | |
void | SetTimestep (int iTimestep) throws ModelException |
Sets the timestep for this planting event. | |
int | GetNumberOfSpecies () |
Gets the number of species to which this planting 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 planting to. | |
int | GetNumberOfCells () |
Gets the number of cells in the planting's area. | |
void | AddCell (int iX, int iY, Plot oPlot) throws ModelException |
Adds a cell to the planting area. | |
void | AddCell (Cell oNewCell) |
Adds a cell to the planting area. | |
Cell | GetCell (int iIndex) throws ModelException |
Gets a cell in the planting's area. | |
float | GetSpacingDistance () |
Get the distance between trees for a gridded planting. | |
float | GetDensity () |
Gets the total density of trees for a random planting. | |
void | SetSpacingDistance (float fSpace) throws ModelException |
Sets the distance between trees for a gridded planting. | |
void | SetDensity (float fSpace) throws ModelException |
Sets the total tree density for a random planting. | |
void | AddAbundance (int iSpecies, float fAbundance) throws ModelException |
Adds an abundance value for a given species. | |
float | GetAbundance (int iSpecies) throws ModelException |
Gets an abundance value for a particular species. | |
void | ValidatePlant (TreePopulation oPop, Plot oPlot) throws ModelException |
Validates the current set of data in this planting. | |
void | RemoveCell (int iIndex) |
Removes a cell from the harvest cut range's area. | |
Classes | |
class | PlantingAbundance |
This encapsulates a species with its planting abundance. More... |
Copyright: Copyright (c) Charles D. Canham 2003
Company: Institute of Ecosystem Studies
javawrapper::PlantingData::PlantingData | ( | ) | [inline] |
Constructor.
Edit history:
------------------
April 28, 2004: Submitted in beta version (LEM)
int javawrapper::PlantingData::GetPlantSpacing | ( | ) | [inline] |
Gets the plant spacing.
Possible values come from PlantingBehaviors and are GRIDDED, RANDOM, or -1 if the value has not yet been set.
void javawrapper::PlantingData::SetPlantSpacing | ( | int | iSpacing | ) | throws ModelException [inline] |
Sets the plant spacing.
iSpacing | the plant spacing. Possible values come from PlantingBehaviors and are GRIDDED and RANDOM. |
ModelException | if the spacing is unrecognized. |
int javawrapper::PlantingData::GetTimestep | ( | ) | [inline] |
Gets the timestep for this planting event.
void javawrapper::PlantingData::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::PlantingData::SetTimestep | ( | int | iTimestep | ) | throws ModelException [inline] |
Sets the timestep for this planting event.
iTimestep | The timestep to set. |
ModelException | if the timestep is less than 0. |
int javawrapper::PlantingData::GetNumberOfSpecies | ( | ) | [inline] |
Gets the number of species to which this planting has been applied.
int javawrapper::PlantingData::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. |
void javawrapper::PlantingData::AddSpecies | ( | int | iSpecies | ) | [inline] |
Adds a new species to apply this planting to.
If this species is already on the list, it is not added again.
iSpecies | Species index. |
int javawrapper::PlantingData::GetNumberOfCells | ( | ) | [inline] |
Gets the number of cells in the planting's area.
void javawrapper::PlantingData::AddCell | ( | int | iX, | |
int | iY, | |||
Plot | oPlot | |||
) | throws ModelException [inline] |
Adds a cell to the planting 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::PlantingData::AddCell | ( | Cell | oNewCell | ) | [inline] |
Adds a cell to the planting area.
Duplicates will not be added.
oNewCell | Cell object to add. |
Cell javawrapper::PlantingData::GetCell | ( | int | iIndex | ) | throws ModelException [inline] |
Gets a cell in the planting's area.
iIndex | The index of the object. |
ModelException | If the index is not valid. |
float javawrapper::PlantingData::GetSpacingDistance | ( | ) | [inline] |
Get the distance between trees for a gridded planting.
float javawrapper::PlantingData::GetDensity | ( | ) | [inline] |
Gets the total density of trees for a random planting.
void javawrapper::PlantingData::SetSpacingDistance | ( | float | fSpace | ) | throws ModelException [inline] |
Sets the distance between trees for a gridded planting.
fSpace | The spacing distance. |
ModelException | if the value is negative. |
void javawrapper::PlantingData::SetDensity | ( | float | fSpace | ) | throws ModelException [inline] |
Sets the total tree density for a random planting.
fSpace | The total stems/ha for all species. |
ModelException | if the value is negative. |
void javawrapper::PlantingData::AddAbundance | ( | int | iSpecies, | |
float | fAbundance | |||
) | throws ModelException [inline] |
Adds an abundance value for a given species.
If a value for that species already exists, then the value is replaced with the new value.
iSpecies | The species number. | |
fAbundance | The abundance value, as a percentage (between 0 and 100) |
ModelException | if the abundance value is negative or not a percentage. |
float javawrapper::PlantingData::GetAbundance | ( | int | iSpecies | ) | throws ModelException [inline] |
Gets an abundance value for a particular species.
iSpecies | The species number. |
ModelException | if the species doesn't exist. |
void javawrapper::PlantingData::ValidatePlant | ( | TreePopulation | oPop, | |
Plot | oPlot | |||
) | throws ModelException [inline] |
Validates the current set of data in this planting.
This makes sure the following are all true:
oPop | TreePopulation object, to help verify data | |
oPlot | Plot object |
ModelException | if any of the above conditions is not true |
void javawrapper::PlantingData::RemoveCell | ( | int | iIndex | ) | [inline] |
Removes a cell from the harvest cut range's area.
iIndex | int Cell index. Invalid values are ignored. |