javawrapper.Plot Class Reference

Plot object. More...

Inheritance diagram for javawrapper.Plot:

javawrapper.WorkerBase

List of all members.

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_fMeanAnnualPrecipMm
 Mean annual precipitation, mm.
ModelFloat m_fMeanAnnualTempC
 Mean annual temperature, degrees Celsius.
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.


Detailed Description

Plot object.

Copyright: Copyright (c) Charles D. Canham 2003 Company: Institute of Ecosystem Studies

Author:
Lora E. Murphy
Version:
1.0

Edit history:
------------------
April 28, 2004: Submitted in beta version (LEM)
March 1, 2007: Checked for plot size changes so we can update grids (LEM)
February 4, 2008: Updated to conform to Java 6 compliance (LEM)

Constructor & Destructor Documentation

javawrapper.Plot.Plot ( GUIManager  oManager  ) 

Default constructor initializes all values to the equivalent of 0.

Parameters:
oManager GUIManager object.


Member Function Documentation

void javawrapper.Plot.DoSetup ( TreePopulation  oPop  )  [virtual]

Does nothing.

Parameters:
oPop Ignored

Implements javawrapper.WorkerBase.

void javawrapper.Plot.SetYearsPerTimestep ( float  fYears  )  throws ModelException

Sets the number of years per timestep.

Parameters:
fYears Number of years per timestep.
Exceptions:
ModelException if the number of years per timestep is not greater than 0.

float javawrapper.Plot.GetNumberOfYearsPerTimestep (  ) 

Gets the number of years per timestep.

Returns:
Number of years per timestep.

void javawrapper.Plot.SetPlotTitle ( String  sTitle  ) 

Sets the plot title.

Parameters:
sTitle Title of the plot.

void javawrapper.Plot.SetNumberOfTimesteps ( int  i  )  throws ModelException

Sets the number of timesteps for a run.

Parameters:
i The number of timesteps.
Exceptions:
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.

Returns:
The number of timesteps.

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.

Parameters:
i The random seed value.

void javawrapper.Plot.SetPlotXLength ( float  f  )  throws ModelException

Sets the plot length in the X (East-West) direction.

Parameters:
f Length of the plot in the X direction.
Exceptions:
ModelException if the passed length is less than or equal to 0.

float javawrapper.Plot.GetPlotXLength (  ) 

Gets the current plot X (East-West) length.

Returns:
Current plot X length.

void javawrapper.Plot.SetPlotYLength ( float  f  )  throws ModelException

Sets the plot length in the Y (North-South) direction.

Parameters:
f Length of the plot in the Y direction.
Exceptions:
ModelException if the passed length is less than or equal to 0.

float javawrapper.Plot.GetPlotYLength (  ) 

Gets the current plot Y (North-South) length.

Returns:
Current plot Y length.

void javawrapper.Plot.SetLatitude ( float  f  )  throws ModelException

Sets the latitude of the plot.

Parameters:
f Latitude in decimal degrees.
Exceptions:
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.

Exceptions:
ModelException if any of the following are not greater than zero:
  • m_fPlotLenX
  • m_fPlotLenY
  • m_iNumTimesteps
  • m_fNumberOfYearsPerTimestep
or if m_fLatitude is not between -90 and +90.
Parameters:
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.

Parameters:
p_oData Vector Vector of data
oPop TreePopulation Tree population object
Exceptions:
ModelException won't.

Reimplemented from javawrapper.WorkerBase.


Member Data Documentation

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.

Initial value:

 new ModelFloat(0,
      "Plot Length in the X (E-W) Direction, in meters", "plot_lenX")
Length of plot in X direction.

X is EW.

Initial value:

 new ModelFloat(0,
      "Plot Length in the Y (N-S) Direction, in meters", "plot_lenY")
Length of plot in Y direction.

Y is NS.

Initial value:

 new ModelFloat(0,
      "Plot Latitude, in decimal degrees", "plot_latitude")
Latitude of plot in decimal degrees.

Initial value:

 new ModelFloat(0,
      "Mean Annual Precipitation, mm", "plot_precip_mm_yr")
Mean annual precipitation, mm.

Initial value:

 new ModelFloat(0,
      "Mean Annual Temperature, degrees C", "plot_temp_C")
Mean annual temperature, degrees Celsius.

Initial value:

 new ModelFloat(5,
      "Number of years per timestep", "yearsPerTimestep")
Number of years per timestep - default to 5, the old value.

Initial value:

 new ModelInt(0, "Number of Timesteps",
      "timesteps")
Number of timesteps for the run.

Initial value:

 new ModelInt(0, "Random Seed",
                                                  "randomSeed")
Run's random seed.

Initial value:

 new ModelInt(0, "Current Timestep",
      "rt_timestep")
Current timestep, if a detailed output timestep file has been fed in.

Not required.


The documentation for this class was generated from the following file:

Generated on Tue Apr 19 13:59:44 2011 for SORTIE Java Interface by  doxygen 1.5.6