Inheritance diagram for datavisualizer::MerchValueDataRequest:
Public Member Functions | |
MerchValueDataRequest (String sChartName, DetailedOutputFileManager oManager) throws ModelException | |
Constructor. | |
void | AddGridFloatData (String sGridName, int iX, int iY, int iCode, float fVal) |
This accepts the float data that holds merchantable value. | |
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_fValue |
The merchantable timber value for this timestep for each species. | |
int[] | mp_iValueIndexes |
Translates a data member code to an index in the value array. | |
String[] | mp_sColumnNames = {"Species", "Value/ha"} |
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_fPlotAreaInHectares |
Plot area, in hectares. | |
int | m_iNumSpecies |
The number of species. | |
int | m_iNumCols = 2 |
Number of columns in the table. |
This requires the detailed output file to have data saved from the "Merchantable Timber Value" grid.
Copyright: Copyright (c) Charles D. Canham 2006 Company: Institute of Ecosystem Studies
datavisualizer::MerchValueDataRequest::MerchValueDataRequest | ( | String | sChartName, | |
DetailedOutputFileManager | oManager | |||
) | throws ModelException [inline] |
Constructor.
sChartName | Name of the chart | |
oManager | Detailed output file manager |
ModelException | not really, but I have to declare this. |
void datavisualizer::MerchValueDataRequest::AddGridFloatData | ( | String | sGridName, | |
int | iX, | |||
int | iY, | |||
int | iCode, | |||
float | fVal | |||
) | [inline] |
This accepts the float data that holds merchantable value.
The index vector is consulted and the values added to the appropriate array location.
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. |
Reimplemented from datavisualizer::DataRequest.
void datavisualizer::MerchValueDataRequest::AddGridFloatDataMemberCode | ( | String | sGridName, | |
String | sLabel, | |||
int | iCode | |||
) | [inline] |
Accepts a grid float data member code for future reference when passed float data members.
sGridName | Name of the grid | |
sLabel | The label of the data member. | |
iCode | The data member code. |
Reimplemented from datavisualizer::DataRequest.
void datavisualizer::MerchValueDataRequest::ClearData | ( | ) | throws ModelException [inline, package, virtual] |
Clears out existing data.
ModelException | Doesn't throw an exception. |
Implements datavisualizer::DataRequest.
JPanel datavisualizer::MerchValueDataRequest::CreateTable | ( | Legend | oLegend | ) | throws ModelException [inline, private] |
Creates the results table.
oLegend | Legend for this chart. |
ModelException | If anything goes wrong with the drawing. |
ModelInternalFrame datavisualizer::MerchValueDataRequest::DrawChart | ( | Legend | oLegend, | |
String | sChartTitle | |||
) | throws ModelException [inline, package, virtual] |
Creates a table of the results that have been collected.
oLegend | The species legend. | |
sChartTitle | The chart title. |
datavisualizer.ModelException | Edit history: ------------------ March 21, 2006: Created (LEM) |
Implements datavisualizer::DataRequest.
int datavisualizer::MerchValueDataRequest::GetSpeciesFromDataMemberLabel | ( | String | sLabel | ) | [inline, private] |
Gets the species from a data member label which ends in "_x", where x is the species number.
sLabel | The data member label. |
void datavisualizer::MerchValueDataRequest::UpdateChart | ( | Legend | oLegend | ) | throws ModelException [inline, package, virtual] |
Redraws the chart using the existing dataset.
oLegend | The legend for this chart. |
ModelException | if anything goes wrong with the chart drawing. |
Implements datavisualizer::DataRequest.
boolean datavisualizer::MerchValueDataRequest::WantAnyGridFloats | ( | ) | [inline] |
void datavisualizer::MerchValueDataRequest::WriteChartDataToFile | ( | java.io.FileWriter | jOut | ) | throws java.io. IOException [inline, protected, virtual] |
Writes the table's data to tab-delimited text.
jOut | java.io.FileWriter The file to write to. |
java.io.IOException | if there's a problem writing the file. |
Implements datavisualizer::DataRequest.
int [] datavisualizer::MerchValueDataRequest::mp_iValueIndexes [private] |
Translates a data member code to an index in the value array.
The code matches the location in these arrays; that location's value is the index to one of the above arrays.
String [] datavisualizer::MerchValueDataRequest::mp_sColumnNames = {"Species", "Value/ha"} [private] |
Table column headers.
Putting them here makes them consistent in all possible display methods.