Public Member Functions | |
GridHistogramDataRequest (String sLabel, boolean bIsFloat, DetailedOutputFileManager oManager, String sGraphName, String sGridName) | |
Constructor. | |
void | actionPerformed (ActionEvent oEvent) |
Performs actions for the controls in the Histogram window. | |
float | GetBinSize () |
Gets the bin size for this data request's histogram. | |
boolean | GetUseLogarithmicAxis () |
Gets whether or not to use a logarithmic axis. | |
void | AddGridFloatDataMemberCode (String sGridName, String sLabel, int iCode) |
Captures the data member code if we're graphing a float. | |
void | AddGridIntDataMemberCode (String sGridName, String sLabel, int iCode) |
Captures the data member code if we're graphing an integer. | |
boolean | WantAnyGridInts () |
If our data piece that's being graphed is an integer, this returns true. | |
boolean | WantAnyGridFloats () |
If our data piece that's being graphed is a float, this returns true. | |
void | AddGridFloatData (String sGridName, int iX, int iY, int iCode, float fVal) |
Accepts the value of our data member from the parser, if float. | |
void | AddGridIntData (String sGridName, int iX, int iY, int iCode, int iVal) |
This will add the integer data, if the data for this chart is an int that matches the data member code. | |
void | SaveChartDataToFile (boolean bJustCurrTS) |
Writes a chart's data to a file. | |
Protected Member Functions | |
void | WriteChartDataToFile (java.io.FileWriter jOut) throws java.io. IOException |
Writes the histogram's data to tab-delimited text. | |
float | GetDatasetMean () |
Calculates the mean value of all values currently in mp_oData. | |
void | AddSeriesToDataset () |
This will add all series to the dataset. | |
Protected Attributes | |
ModelHistogramDataset | m_oDataset |
The dataset that will be graphed. | |
Package Functions | |
ModelInternalFrame | DrawChart (Legend oLegend, String sChartTitle) throws ModelException |
Creates the histogram using data accumulated thus far. | |
void | UpdateChart (Legend oLegend) throws ModelException |
Updates the histogram. | |
void | ClearData () |
This nulls our dataset and recreates it, and clears all of our data vectors. | |
Package Attributes | |
java.text.DecimalFormat | m_jSmallNumsFormat |
Formatter for very small numbers. | |
Private Attributes | |
String | m_sLabel |
Data member's label, as it appears in the detailed output file. | |
String | m_sGridName |
Name of grid. | |
boolean | m_bIsFloat |
Whether our data member being graphed is a float. | |
boolean | m_bIsInt |
Whether the data being graphed is an integer. | |
JTextField | m_jNumBins = new JTextField("") |
Field displaying the number of bins in the histogram. | |
JTextField | m_jBinSize = new JTextField("") |
Field displaying the bin size in the histogram. | |
JLabel | m_jMean = new JLabel("") |
Label holding mean value of dataset. | |
int | m_iDataMemberCode = -1 |
The data member code for this data member. | |
Vector< Number > | mp_oData = new Vector<Number>(0) |
The data. | |
float | m_fBinSize |
Size of the histogram bins. | |
int | m_iNumBins |
Number of bins in the histogram. | |
boolean | m_bUseLogarithmicAxis |
Whether or not to use a logarithmic axis on the Y. | |
boolean | m_bRecalcBinsOnUpdate |
Whether or not we have to recalculate the bins on chart update (i.e. | |
java.text.NumberFormat | m_jFormat = java.text.NumberFormat.getInstance() |
Formatter for big numbers. |
The label of the data is passed in the constructor. The histogram is defaulted to 10 divisions equally divided between their minimum and maximum values.
Copyright: Copyright (c) Charles D. Canham 2003
Company: Institute of Ecosystem Studies
datavisualizer.GridHistogramDataRequest.GridHistogramDataRequest | ( | String | sLabel, | |
boolean | bIsFloat, | |||
DetailedOutputFileManager | oManager, | |||
String | sGraphName, | |||
String | sGridName | |||
) |
Constructor.
sLabel | Label of the piece of data, as it would be passed as a data member code. | |
bIsFloat | Whether this is float data. If this is set to false, integer data is assumed. | |
oManager | The parent detailed output file manager. | |
sGraphName | Name of graph string. | |
sGridName | Name of grid. |
void datavisualizer.GridHistogramDataRequest.WriteChartDataToFile | ( | java.io.FileWriter | jOut | ) | throws java.io. IOException [protected, virtual] |
Writes the histogram'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.
void datavisualizer.GridHistogramDataRequest.actionPerformed | ( | ActionEvent | oEvent | ) |
Performs actions for the controls in the Histogram window.
oEvent | Event triggered. |
float datavisualizer.GridHistogramDataRequest.GetBinSize | ( | ) |
Gets the bin size for this data request's histogram.
boolean datavisualizer.GridHistogramDataRequest.GetUseLogarithmicAxis | ( | ) |
Gets whether or not to use a logarithmic axis.
void datavisualizer.GridHistogramDataRequest.AddGridFloatDataMemberCode | ( | String | sGridName, | |
String | sLabel, | |||
int | iCode | |||
) |
Captures the data member code if we're graphing a float.
sGridName | Name of the grid | |
sLabel | The label of the data member. | |
iCode | The data member code. |
Reimplemented from datavisualizer.DataRequest.
void datavisualizer.GridHistogramDataRequest.AddGridIntDataMemberCode | ( | String | sGridName, | |
String | sLabel, | |||
int | iCode | |||
) |
Captures the data member code if we're graphing an integer.
sGridName | Name of the grid | |
sLabel | The label of the data member. | |
iCode | The data member code. |
Reimplemented from datavisualizer.DataRequest.
ModelInternalFrame datavisualizer.GridHistogramDataRequest.DrawChart | ( | Legend | oLegend, | |
String | sChartTitle | |||
) | throws ModelException [package, virtual] |
Creates the histogram using data accumulated thus far.
oLegend | Legend for this chart. | |
sChartTitle | Title for this chart. |
datavisualizer.ModelException | Passing through underlying exceptions. |
Implements datavisualizer.DataRequest.
float datavisualizer.GridHistogramDataRequest.GetDatasetMean | ( | ) | [protected] |
Calculates the mean value of all values currently in mp_oData.
void datavisualizer.GridHistogramDataRequest.AddSeriesToDataset | ( | ) | [protected] |
This will add all series to the dataset.
Edit history:
------------------ March 29, 2005: Created (LEM)
void datavisualizer.GridHistogramDataRequest.UpdateChart | ( | Legend | oLegend | ) | throws ModelException [package, virtual] |
Updates the histogram.
oLegend | Legend for this chart. |
datavisualizer.ModelException | Passing through an underlying exception. |
Implements datavisualizer.DataRequest.
boolean datavisualizer.GridHistogramDataRequest.WantAnyGridInts | ( | ) |
If our data piece that's being graphed is an integer, this returns true.
Otherwise, false.
Reimplemented from datavisualizer.DataRequest.
boolean datavisualizer.GridHistogramDataRequest.WantAnyGridFloats | ( | ) |
If our data piece that's being graphed is a float, this returns true.
Otherwise, false.
Reimplemented from datavisualizer.DataRequest.
void datavisualizer.GridHistogramDataRequest.ClearData | ( | ) | [package, virtual] |
This nulls our dataset and recreates it, and clears all of our data vectors.
Implements datavisualizer.DataRequest.
void datavisualizer.GridHistogramDataRequest.AddGridFloatData | ( | String | sGridName, | |
int | iX, | |||
int | iY, | |||
int | iCode, | |||
float | fVal | |||
) |
Accepts the value of our data member from the parser, if float.
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.GridHistogramDataRequest.AddGridIntData | ( | String | sGridName, | |
int | iX, | |||
int | iY, | |||
int | iCode, | |||
int | iVal | |||
) |
This will add the integer data, if the data for this chart is an int that matches the data member code.
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. | |
iVal | Value. |
Reimplemented from datavisualizer.DataRequest.
void datavisualizer.GridHistogramDataRequest.SaveChartDataToFile | ( | boolean | bJustCurrTS | ) |
Writes a chart's data to a file.
This is overwritten to improve formatting for whole-run file writing. This will write it as one big table rather than as a whole bunch of little tables.
bJustCurrTS | If true, writes for only the current timestep. If false, writes for the whole run. |
Reimplemented from datavisualizer.DataRequest.
String datavisualizer.GridHistogramDataRequest.m_sLabel [private] |
Data member's label, as it appears in the detailed output file.
String datavisualizer.GridHistogramDataRequest.m_sGridName [private] |
Name of grid.
boolean datavisualizer.GridHistogramDataRequest.m_bIsFloat [private] |
Whether our data member being graphed is a float.
boolean datavisualizer.GridHistogramDataRequest.m_bIsInt [private] |
Whether the data being graphed is an integer.
The dataset that will be graphed.
JTextField datavisualizer.GridHistogramDataRequest.m_jNumBins = new JTextField("") [private] |
Field displaying the number of bins in the histogram.
JTextField datavisualizer.GridHistogramDataRequest.m_jBinSize = new JTextField("") [private] |
Field displaying the bin size in the histogram.
JLabel datavisualizer.GridHistogramDataRequest.m_jMean = new JLabel("") [private] |
Label holding mean value of dataset.
int datavisualizer.GridHistogramDataRequest.m_iDataMemberCode = -1 [private] |
The data member code for this data member.
Vector<Number> datavisualizer.GridHistogramDataRequest.mp_oData = new Vector<Number>(0) [private] |
The data.
float datavisualizer.GridHistogramDataRequest.m_fBinSize [private] |
Size of the histogram bins.
int datavisualizer.GridHistogramDataRequest.m_iNumBins [private] |
Number of bins in the histogram.
boolean datavisualizer.GridHistogramDataRequest.m_bUseLogarithmicAxis [private] |
Whether or not to use a logarithmic axis on the Y.
boolean datavisualizer.GridHistogramDataRequest.m_bRecalcBinsOnUpdate [private] |
Whether or not we have to recalculate the bins on chart update (i.e.
we are charting an unknown data type without defaults)
java.text.NumberFormat datavisualizer.GridHistogramDataRequest.m_jFormat = java.text.NumberFormat.getInstance() [private] |
Formatter for big numbers.
java.text.DecimalFormat datavisualizer.GridHistogramDataRequest.m_jSmallNumsFormat [package] |
Initial value:
new java.text.DecimalFormat( "0.#E0")