
Public Member Functions | |
| Plot (GUIManager oManager) | |
| Default constructor initializes all values to the equivalent of 0. | |
| void | DoSetup (TreePopulation oPop) |
| Does nothing. | |
| void | SetYearsPerTimestep (float fYears) throws ModelException |
| Sets the number of years per timestep. | |
| float | GetNumberOfYearsPerTimestep () |
| Gets the number of years per timestep. | |
| void | SetPlotTitle (String sTitle) |
| Sets the plot title. | |
| void | SetNumberOfTimesteps (int i) throws ModelException |
| Sets the number of timesteps for a run. | |
| int | GetNumberOfTimesteps () |
| Gets the number of timesteps for a run. | |
| void | SetRandomSeed (int i) |
| Sets the random seed for the run. | |
| void | SetPlotXLength (float f) throws ModelException |
| Sets the plot length in the X (East-West) direction. | |
| float | GetPlotXLength () |
| Gets the current plot X (East-West) length. | |
| void | SetPlotYLength (float f) throws ModelException |
| Sets the plot length in the Y (North-South) direction. | |
| float | GetPlotYLength () |
| Gets the current plot Y (North-South) length. | |
| void | SetLatitude (float f) throws ModelException |
| Sets the latitude of the plot. | |
| void | ValidateData (TreePopulation oPop) throws ModelException |
| Validates the data prior to running the model. | |
| void | ReadDataFromDisplay (Vector< TableData > p_oData, TreePopulation oPop) throws ModelException |
| Checks for changes to plot size, and tells the GUIManager if there are any. | |
Static Public Attributes | |
| static final float | CELL_LENGTH = (float)8.0 |
| Length of cells, in meters. | |
Protected Attributes | |
| ModelString | m_sPlotTitle = new ModelString("", "Plot title", "plot_title") |
| Plot title or comment. | |
| ModelFloat | m_fPlotLenX |
| Length of plot in X direction. | |
| ModelFloat | m_fPlotLenY |
| Length of plot in Y direction. | |
| ModelFloat | m_fLatitude |
| Latitude of plot in decimal degrees. | |
| ModelFloat | m_fNumberOfYearsPerTimestep |
| Number of years per timestep - default to 5, the old value. | |
| ModelInt | m_iNumTimesteps |
| Number of timesteps for the run. | |
| ModelInt | m_iRandomSeed |
| Run's random seed. | |
| ModelInt | m_iCurrentTimestep |
| Current timestep, if a detailed output timestep file has been fed in. | |
Copyright: Copyright (c) Charles D. Canham 2003 Company: Institute of Ecosystem Studies
| javawrapper.Plot.Plot | ( | GUIManager | oManager | ) |
Default constructor initializes all values to the equivalent of 0.
| oManager | GUIManager object. |
| void javawrapper.Plot.DoSetup | ( | TreePopulation | oPop | ) | [virtual] |
| void javawrapper.Plot.SetYearsPerTimestep | ( | float | fYears | ) | throws ModelException |
Sets the number of years per timestep.
| fYears | Number of years per timestep. |
| ModelException | if the number of years per timestep is not greater than 0. |
| float javawrapper.Plot.GetNumberOfYearsPerTimestep | ( | ) |
Gets the number of years per timestep.
| void javawrapper.Plot.SetPlotTitle | ( | String | sTitle | ) |
Sets the plot title.
| sTitle | Title of the plot. |
| void javawrapper.Plot.SetNumberOfTimesteps | ( | int | i | ) | throws ModelException |
Sets the number of timesteps for a run.
| i | The number of timesteps. |
| ModelException | when the number of timesteps is less than or equal to zero. |
| int javawrapper.Plot.GetNumberOfTimesteps | ( | ) |
Gets the number of timesteps for a run.
| void javawrapper.Plot.SetRandomSeed | ( | int | i | ) |
Sets the random seed for the run.
A value of 0 means a new random seed each time a parameter file is run.
| i | The random seed value. |
| void javawrapper.Plot.SetPlotXLength | ( | float | f | ) | throws ModelException |
Sets the plot length in the X (East-West) direction.
| f | Length of the plot in the X direction. |
| ModelException | if the passed length is less than or equal to 0. |
| float javawrapper.Plot.GetPlotXLength | ( | ) |
Gets the current plot X (East-West) length.
| void javawrapper.Plot.SetPlotYLength | ( | float | f | ) | throws ModelException |
Sets the plot length in the Y (North-South) direction.
| f | Length of the plot in the Y direction. |
| ModelException | if the passed length is less than or equal to 0. |
| float javawrapper.Plot.GetPlotYLength | ( | ) |
Gets the current plot Y (North-South) length.
| void javawrapper.Plot.SetLatitude | ( | float | f | ) | throws ModelException |
Sets the latitude of the plot.
| f | Latitude in decimal degrees. |
| ModelException | if latitude is not between -90 and 90. |
| void javawrapper.Plot.ValidateData | ( | TreePopulation | oPop | ) | throws ModelException [virtual] |
Validates the data prior to running the model.
| ModelException | if any of the following are not greater than zero:
|
| oPop | Not used. |
Implements javawrapper.WorkerBase.
| void javawrapper.Plot.ReadDataFromDisplay | ( | Vector< TableData > | p_oData, | |
| TreePopulation | oPop | |||
| ) | throws ModelException |
Checks for changes to plot size, and tells the GUIManager if there are any.
| p_oData | Vector Vector of data | |
| oPop | TreePopulation Tree population object |
| ModelException | won't. |
Reimplemented from javawrapper.WorkerBase.
final float javawrapper.Plot.CELL_LENGTH = (float)8.0 [static] |
Length of cells, in meters.
ModelString javawrapper.Plot.m_sPlotTitle = new ModelString("", "Plot title", "plot_title") [protected] |
Plot title or comment.
ModelFloat javawrapper.Plot.m_fPlotLenX [protected] |
Initial value:
new ModelFloat(0, "Plot Length in the X (E-W) Direction, in meters", "plot_lenX")
X is EW.
ModelFloat javawrapper.Plot.m_fPlotLenY [protected] |
Initial value:
new ModelFloat(0, "Plot Length in the Y (N-S) Direction, in meters", "plot_lenY")
Y is NS.
ModelFloat javawrapper.Plot.m_fLatitude [protected] |
Initial value:
new ModelFloat(0, "Plot Latitude, in decimal degrees", "plot_latitude")
Initial value:
new ModelFloat(5, "Number of years per timestep", "yearsPerTimestep")
ModelInt javawrapper.Plot.m_iNumTimesteps [protected] |
Initial value:
new ModelInt(0, "Number of Timesteps", "timesteps")
ModelInt javawrapper.Plot.m_iRandomSeed [protected] |
Initial value:
new ModelInt(0, "Random Seed", "randomSeed")
ModelInt javawrapper.Plot.m_iCurrentTimestep [protected] |
Initial value:
new ModelInt(0, "Current Timestep", "rt_timestep")
Not required.
1.5.6