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. | |
Private Attributes | |
Vector | mp_iSpecies |
Species codes to which to apply this planting. | |
Vector | mp_oCells |
The list of cells to which to apply this plant (vector of Cell objects). | |
Vector | mp_oAbundance |
The amount of each species to plant. | |
float | m_fDistanceOrDensity |
If planting is GRIDDED - distance between trees in m. | |
int | m_iTimestep |
Timestep to which to apply this planting. | |
int | m_iPlantSpacing |
The plant spacing - possible values come from PlantingBehaviors and are GRIDDED and RANDOM. | |
Classes | |
class | PlantingAbundance |
This encapsulates a species with its planting abundance. More... |
Copyright: Copyright (c) Charles D. Canham 2003
Company: Institute of Ecosystem Studies
|
Constructor.
|
|
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.
Edit history: ------------------ April 28, 2004: Submitted in beta version (LEM) |
|
Adds a cell to the planting area. Duplicates will not be added.
Edit history: ------------------ April 28, 2004: Submitted in beta version (LEM) |
|
Adds a cell to the planting area. Duplicates will not be added.
Edit history: ------------------ April 28, 2004: Submitted in beta version (LEM) |
|
Adds a new species to apply this planting 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 an abundance value for a particular species.
Edit history: ------------------ April 28, 2004: Submitted in beta version (LEM) |
|
Gets a cell in the planting's area.
Edit history: ------------------ April 28, 2004: Submitted in beta version (LEM) |
|
Gets the total density of trees for a random planting.
Edit history: ------------------ April 28, 2004: Submitted in beta version (LEM) |
|
Gets the number of cells in the planting's area.
Edit history: ------------------ April 28, 2004: Submitted in beta version (LEM) |
|
Gets the number of species to which this planting has been applied.
|
|
Gets the plant spacing. Possible values come from PlantingBehaviors and are GRIDDED, RANDOM, or -1 if the value has not yet been set.
|
|
Get the distance between trees for a gridded planting.
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 planting event.
|
|
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 total tree density for a random planting.
Edit history: ------------------ April 28, 2004: Submitted in beta version (LEM) |
|
Sets the plant spacing.
Edit history: ------------------ April 28, 2004: Submitted in beta version (LEM) |
|
Sets the distance between trees for a gridded planting.
Edit history: ------------------ April 28, 2004: Submitted in beta version (LEM) |
|
Sets the timestep for this planting event.
Edit history: ------------------ April 28, 2004: Submitted in beta version (LEM) |
|
Validates the current set of data in this planting. This makes sure the following are all true:
Edit history: ------------------ April 28, 2004: Submitted in beta version (LEM) |
|
If planting is GRIDDED - distance between trees in m. If RANDOM, total number of trees/ha for all species |