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.

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.

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)


Constructor & Destructor Documentation

javawrapper::Plot::Plot ( GUIManager  oManager  )  [inline]

Default constructor initializes all values to the equivalent of 0.

Parameters:
oManager GUIManager object.

Edit history:
------------------
April 28, 2004: Submitted in beta version (LEM)


Member Function Documentation

void javawrapper::Plot::DoSetup ( TreePopulation  oPop  )  [inline, virtual]

Does nothing.

Parameters:
oPop Ignored

Implements javawrapper::WorkerBase.

int javawrapper::Plot::GetNumberOfTimesteps (  )  [inline]

Gets the number of timesteps for a run.

Returns:
The number of timesteps.

Edit history:
------------------
June 1, 2004: Created (LEM)

float javawrapper::Plot::GetNumberOfYearsPerTimestep (  )  [inline]

Gets the number of years per timestep.

Returns:
Number of years per timestep.

Edit history:
------------------
April 28, 2004: Submitted in beta version (LEM)

float javawrapper::Plot::GetPlotXLength (  )  [inline]

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

Returns:
Current plot X length.

Edit history:
------------------
April 28, 2004: Submitted in beta version (LEM)

float javawrapper::Plot::GetPlotYLength (  )  [inline]

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

Returns:
Current plot Y length.

Edit history:
------------------
April 28, 2004: Submitted in beta version (LEM)

void javawrapper::Plot::SetLatitude ( float  f  )  throws ModelException [inline]

Sets the latitude of the plot.

Parameters:
f Latitude in decimal degrees.
Exceptions:
ModelException if latitude is not between -90 and 90.

Edit history:
------------------
April 28, 2004: Submitted in beta version (LEM)

void javawrapper::Plot::SetNumberOfTimesteps ( int  i  )  throws ModelException [inline]

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.

Edit history:
------------------
April 28, 2004: Submitted in beta version (LEM)

void javawrapper::Plot::SetPlotTitle ( String  sTitle  )  [inline]

Sets the plot title.

Parameters:
sTitle Title of the plot.

Edit history:
------------------
April 28, 2004: Submitted in beta version (LEM)

void javawrapper::Plot::SetPlotXLength ( float  f  )  throws ModelException [inline]

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.

Edit history:
------------------
April 28, 2004: Submitted in beta version (LEM)

void javawrapper::Plot::SetPlotYLength ( float  f  )  throws ModelException [inline]

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.

Edit history:
------------------
April 28, 2004: Submitted in beta version (LEM)

void javawrapper::Plot::SetRandomSeed ( int  i  )  [inline]

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.

Edit history:
------------------
April 28, 2004: Submitted in beta version (LEM)

void javawrapper::Plot::SetYearsPerTimestep ( float  fYears  )  throws ModelException [inline]

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.

Edit history:
------------------
April 28, 2004: Submitted in beta version (LEM)

void javawrapper::Plot::ValidateData ( TreePopulation  oPop  )  throws ModelException [inline, 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.

Edit history:
------------------
April 28, 2004: Submitted in beta version (LEM)

Implements javawrapper::WorkerBase.


Member Data Documentation

ModelFloat javawrapper::Plot::m_fLatitude [protected]

Initial value:

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

ModelFloat javawrapper::Plot::m_fNumberOfYearsPerTimestep [protected]

Initial value:

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

ModelFloat javawrapper::Plot::m_fPlotLenX [protected]

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.

ModelFloat javawrapper::Plot::m_fPlotLenY [protected]

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.

ModelInt javawrapper::Plot::m_iCurrentTimestep [protected]

Initial value:

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

Not required.

ModelInt javawrapper::Plot::m_iNumTimesteps [protected]

Initial value:

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

ModelInt javawrapper::Plot::m_iRandomSeed [protected]

Initial value:

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


The documentation for this class was generated from the following file:
Generated on Wed Nov 29 08:45:06 2006 for SORTIE Java Interface by  doxygen 1.4.7