datavisualizer::PartitionedBiomassDataRequest Class Reference

Produces a table of partitioned biomass results. More...

Inheritance diagram for datavisualizer::PartitionedBiomassDataRequest:

datavisualizer::DataRequest List of all members.

Public Member Functions

 PartitionedBiomassDataRequest (String sChartName, DetailedOutputFileManager oManager) throws ModelException
 Constructor.
void AddGridFloatData (String sGridName, int iX, int iY, int iCode, float fVal)
 This accepts float data.
boolean WantAnyGridFloats ()
 This wants floats.
void AddGridFloatDataMemberCode (String sGridName, String sLabel, int iCode)
 Accepts a grid float data member code for future reference when passed float data members.

Protected Member Functions

void WriteChartDataToFile (java.io.FileWriter jOut) throws java.io. IOException
 Writes the table's data to tab-delimited text.

Package Functions

ModelInternalFrame DrawChart (Legend oLegend, String sChartTitle) throws ModelException
 Creates a table of the results that have been collected.
void UpdateChart (Legend oLegend) throws ModelException
 Redraws the chart using the existing dataset.
void ClearData () throws ModelException
 Clears out existing data.

Private Member Functions

int GetSpeciesFromDataMemberLabel (String sLabel)
 Gets the species from a data member label which ends in "_x", where x is the species number.
JPanel CreateTable (Legend oLegend) throws ModelException
 Creates the results table.

Private Attributes

float[] mp_fLeafBiomass
 The leaf biomass for this timestep for each species.
float[] mp_fBranchBiomass
 The branch biomass for this timestep for each species.
float[] mp_fBoleBiomass
 The bole biomass for this timestep for each species.
float[] mp_fPalmLeafBiomass
 The palm leaf biomass for this timestep for each species.
float[] mp_fPalmBoleBiomass
 The palm bole biomass for this timestep for each species.
int[] mp_iLeafBiomassIndexes
 Translates a data member code to an index in the leaf biomass array.
int[] mp_iBranchBiomassIndexes
 Translates a data member code to an index in the branch biomass array.
int[] mp_iBoleBiomassIndexes
 Translates a data member code to an index in the bole biomass array.
int[] mp_iPalmLeafBiomassIndexes
 Translates a data member code to an index in the palm leaf biomass array.
int[] mp_iPalmBoleBiomassIndexes
 Translates a data member code to an index in the palm bole biomass array.
String[] mp_sColumnNames
 Table column headers.
String[] mp_sSpeciesNames
 Array of species names for display.
String m_sThisGrid
 Name of the grid from which the data will be collected.
float m_fPlotAreaInHa
 Plot area, in hectares.
int m_iNumSpecies
 The number of species.
int m_iNumCols = 6
 Number of columns in the table.

Detailed Description

Produces a table of partitioned biomass results.

This requires the detailed output file to have data saved from the "Partitioned Biomass" grid.

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

Author:
Lora E. Murphy
Version:
1.0

Edit history:
------------------
November 9, 2006: Created (LEM)


Constructor & Destructor Documentation

datavisualizer::PartitionedBiomassDataRequest::PartitionedBiomassDataRequest ( String  sChartName,
DetailedOutputFileManager  oManager 
) throws ModelException [inline]

Constructor.

Parameters:
sChartName Name of the chart
oManager Detailed output file manager
Exceptions:
ModelException not really, but I have to declare this.

Edit history:
------------------
November 9, 2006: Created (LEM)


Member Function Documentation

void datavisualizer::PartitionedBiomassDataRequest::AddGridFloatData ( String  sGridName,
int  iX,
int  iY,
int  iCode,
float  fVal 
) [inline]

This accepts float data.

The index vector is consulted and the values added to the appropriate array location.

Parameters:
sGridName Name of the grid for this data
iX X number of the cell from which this value came
iY Y number of the cell from which this value came
iCode Data member code of this value.
fVal Value.

Edit history:
------------------
November 9, 2006: Created (LEM)

Reimplemented from datavisualizer::DataRequest.

void datavisualizer::PartitionedBiomassDataRequest::AddGridFloatDataMemberCode ( String  sGridName,
String  sLabel,
int  iCode 
) [inline]

Accepts a grid float data member code for future reference when passed float data members.

Parameters:
sGridName Name of the grid
sLabel The label of the data member.
iCode The data member code.

Edit history:
------------------
November 9, 2006: Created (LEM)

Reimplemented from datavisualizer::DataRequest.

void datavisualizer::PartitionedBiomassDataRequest::ClearData (  )  throws ModelException [inline, package, virtual]

Clears out existing data.

Exceptions:
ModelException Doesn't throw an exception.

Edit history:
------------------
November 9, 2006: Created (LEM)

Implements datavisualizer::DataRequest.

JPanel datavisualizer::PartitionedBiomassDataRequest::CreateTable ( Legend  oLegend  )  throws ModelException [inline, private]

Creates the results table.

Parameters:
oLegend Legend for this chart.
Returns:
Panel containing the table.
Exceptions:
ModelException If anything goes wrong with the drawing.

Edit history:
------------------
November 9, 2006: Created (LEM)

ModelInternalFrame datavisualizer::PartitionedBiomassDataRequest::DrawChart ( Legend  oLegend,
String  sChartTitle 
) throws ModelException [inline, package, virtual]

Creates a table of the results that have been collected.

Parameters:
oLegend The species legend.
sChartTitle The chart title.
Returns:
A JInternalFrame with the table present in it.
Exceptions:
datavisualizer.ModelException 
Edit history:
------------------
November 9, 2006: Created (LEM)

Implements datavisualizer::DataRequest.

int datavisualizer::PartitionedBiomassDataRequest::GetSpeciesFromDataMemberLabel ( String  sLabel  )  [inline, private]

Gets the species from a data member label which ends in "_x", where x is the species number.

Parameters:
sLabel The data member label.
Returns:
The species number, or -1 if none exists.

Edit history:
------------------
November 9, 2006: Created (LEM)

void datavisualizer::PartitionedBiomassDataRequest::UpdateChart ( Legend  oLegend  )  throws ModelException [inline, package, virtual]

Redraws the chart using the existing dataset.

Parameters:
oLegend The legend for this chart.
Exceptions:
ModelException if anything goes wrong with the chart drawing.

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

Implements datavisualizer::DataRequest.

boolean datavisualizer::PartitionedBiomassDataRequest::WantAnyGridFloats (  )  [inline]

This wants floats.

Returns:
True.

Reimplemented from datavisualizer::DataRequest.

void datavisualizer::PartitionedBiomassDataRequest::WriteChartDataToFile ( java.io.FileWriter  jOut  )  throws java.io. IOException [inline, protected, virtual]

Writes the table's data to tab-delimited text.

Parameters:
jOut java.io.FileWriter The file to write to.
Exceptions:
java.io.IOException if there's a problem writing the file.

Implements datavisualizer::DataRequest.


Member Data Documentation

int [] datavisualizer::PartitionedBiomassDataRequest::mp_iBoleBiomassIndexes [private]

Translates a data member code to an index in the bole biomass array.

For each species, this gives the code for the bole biomass index.

int [] datavisualizer::PartitionedBiomassDataRequest::mp_iBranchBiomassIndexes [private]

Translates a data member code to an index in the branch biomass array.

For each species, this gives the code for the branch biomass index.

int [] datavisualizer::PartitionedBiomassDataRequest::mp_iLeafBiomassIndexes [private]

Translates a data member code to an index in the leaf biomass array.

For each species, this gives the code for the leaf biomass index.

int [] datavisualizer::PartitionedBiomassDataRequest::mp_iPalmBoleBiomassIndexes [private]

Translates a data member code to an index in the palm bole biomass array.

For each species, this gives the code for the palm bole biomass index.

int [] datavisualizer::PartitionedBiomassDataRequest::mp_iPalmLeafBiomassIndexes [private]

Translates a data member code to an index in the palm leaf biomass array.

For each species, this gives the code for the palm leaf biomass index.

String [] datavisualizer::PartitionedBiomassDataRequest::mp_sColumnNames [private]

Initial value:

 {"Species", "Leaf (Mg/ha)",
      "Branch (Mg/ha)", "Bole (Mg/ha)", "Palm Leaf (Mg/ha)",
      "Palm Bole (Mg/ha)"}
Table column headers.

Putting them here makes them consistent in all possible display methods.


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