datavisualizer::DataRequest Class Reference

This class is used by the DetailedOutputFileManager class to manage open requests for data. More...

Inheritance diagram for datavisualizer::DataRequest:

datavisualizer::CarbonValueDataRequest datavisualizer::GridDataRequest datavisualizer::GridHistogramDataRequest datavisualizer::HarvestDataRequest datavisualizer::HistogramDataRequest datavisualizer::LineGraphDataRequest datavisualizer::MerchValueDataRequest datavisualizer::OverviewTableDataRequest datavisualizer::StandTableDataRequest datavisualizer::StockTableDataRequest datavisualizer::TreeMapDataRequest datavisualizer::WindstormDataRequest List of all members.

Public Member Functions

 DataRequest (String sChartName, DetailedOutputFileManager oManager)
 Constructor.
void actionPerformed (java.awt.event.ActionEvent oEvent)
 If passed the order to write chart data, does it.
void SaveChartDataToFile (boolean bJustCurrTS)
 Writes a chart's data to a file.
String GetChartName ()
 Get the name of the chart.
JInternalFrame GetChart ()
 Get the chart frame.
boolean WantAnyTreeFloats ()
 Whether or not this object wants any tree float data members.
boolean WantAnyTreeInts ()
 Whether or not this object wants any tree int data members.
boolean WantAnyTreeChars ()
 Whether or not this object wants any tree char data members.
boolean WantAnyTreeBools ()
 Whether or not this object wants any tree bool data members.
boolean WantAnyGridFloats ()
 Whether or not this object wants any grid float data members.
boolean WantAnyGridInts ()
 Whether or not this object wants any grid int data members.
boolean WantAnyGridChars ()
 Whether or not this object wants any grid char data members.
boolean WantAnyGridBools ()
 Whether or not this object wants any grid bool data members.
boolean WantAnyGridPackageFloats ()
 Whether or not this object wants any grid package float data members.
boolean WantAnyGridPackageInts ()
 Whether or not this object wants any grid package int data members.
boolean WantAnyGridPackageChars ()
 Whether or not this object wants any grid package char data members.
boolean WantAnyGridPackageBools ()
 Whether or not this object wants any grid package bool data members.
void AddTreeFloatData (int iSpecies, int iType, int iCode, float fVal)
 Accepts a piece of tree float data from the parser.
void AddTreeIntData (int iSpecies, int iType, int iCode, int iVal)
 Accepts a piece of tree int data from the parser.
void AddTreeCharData (int iSpecies, int iType, int iCode, String sVal)
 Accepts a piece of tree char data from the parser.
void AddTreeBoolData (int iSpecies, int iType, int iCode, boolean bVal)
 Accepts a piece of tree bool data from the parser.
void AddGridFloatData (String sGridName, int iX, int iY, int iCode, float fVal)
 Accepts a piece of grid float data from the parser.
void AddGridIntData (String sGridName, int iX, int iY, int iCode, int iVal)
 Accepts a piece of grid int data from the parser.
void AddGridCharData (String sGridName, int iX, int iY, int iCode, String sVal)
 Accepts a piece of grid char data from the parser.
void AddGridBoolData (String sGridName, int iX, int iY, int iCode, boolean bVal)
 Accepts a piece of grid bool data from the parser.
void AddGridPackageFloatData (String sGridName, int iX, int iY, int iCode, float fVal)
 Accepts a piece of grid package float data from the parser.
void AddGridPackageIntData (String sGridName, int iX, int iY, int iCode, int iVal)
 Accepts a piece of grid package int data from the parser.
void AddGridPackageCharData (String sGridName, int iX, int iY, int iCode, String sVal)
 Accepts a piece of grid package char data from the parser.
void AddGridPackageBoolData (String sGridName, int iX, int iY, int iCode, boolean bVal)
 Accepts a piece of grid package bool data from the parser.
void EndPackage ()
 Announces a package has ended.
void AddTreeFloatDataMemberCode (int iSpecies, int iType, String sLabel, int iCode)
 Accepts a tree float data member code for future reference when passed float data members.
void AddTreeIntDataMemberCode (int iSpecies, int iType, String sLabel, int iCode)
 Accepts a tree int data member code for future reference when passed int data members.
void AddTreeCharDataMemberCode (int iSpecies, int iType, String sLabel, int iCode)
 Accepts a tree char data member code for future reference when passed char data members.
void AddTreeBoolDataMemberCode (int iSpecies, int iType, String sLabel, int iCode)
 Accepts a tree bool data member code for future reference when passed bool data members.
void AddGridFloatDataMemberCode (String sGridName, String sLabel, int iCode)
 Accepts a grid float data member code for future reference when passed float data members.
void AddGridIntDataMemberCode (String sGridName, String sLabel, int iCode)
 Accepts a grid int data member code for future reference when passed int data members.
void AddGridCharDataMemberCode (String sGridName, String sLabel, int iCode)
 Accepts a grid char data member code for future reference when passed char data members.
void AddGridBoolDataMemberCode (String sGridName, String sLabel, int iCode)
 Accepts a grid bool data member code for future reference when passed bool data members.
void AddGridPackageFloatDataMemberCode (String sGridName, String sLabel, int iCode)
 Accepts a grid package float data member code for future reference when passed float data members.
void AddGridPackageIntDataMemberCode (String sGridName, String sLabel, int iCode)
 Accepts a grid package int data member code for future reference when passed int data members.
void AddGridPackageCharDataMemberCode (String sGridName, String sLabel, int iCode)
 Accepts a grid package char data member code for future reference when passed char data members.
void AddGridPackageBoolDataMemberCode (String sGridName, String sLabel, int iCode)
 Accepts a grid package bool data member code for future reference when passed bool data members.

Protected Member Functions

abstract void WriteChartDataToFile (java.io.FileWriter jOut) throws java.io.IOException, javawrapper.ModelException
 Child classes override this to write the data behind their chart to tab-delimited text.

Protected Attributes

boolean m_bShowOneTimestep = true
 Whether this chart shows one timestep at a time (true) or all timesteps (false).
JInternalFrame m_oChartFrame
 Chart for this request.
String m_sChartName
 Name string of chart.

Package Functions

abstract void ClearData () throws ModelException
 Clears out data for garbage collection in preparation for new data being read in.
abstract JInternalFrame DrawChart (Legend oLegend, String sChartTitle) throws ModelException
 Draws the chart for this data request according to its individual settings and data.
abstract void UpdateChart (Legend oLegend) throws ModelException
 Redraws the chart using the existing dataset.

Package Attributes

DetailedOutputFileManager m_oManager
 Managing object.

Detailed Description

This class is used by the DetailedOutputFileManager class to manage open requests for data.

Each DataRequest object represents the data needed to make one chart. This base class rejects all data in its non-abstract data members. Override the ones necessary to get and process required information.

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)
December 10, 2004: Added the writing of data behind charts (LEM)
March 20, 2006: Added package support (LEM)


Constructor & Destructor Documentation

datavisualizer::DataRequest::DataRequest String  sChartName,
DetailedOutputFileManager  oManager
[inline]
 

Constructor.

Parameters:
sChartName Name of chart to display.
oManager Managing file manager.

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


Member Function Documentation

void datavisualizer::DataRequest::actionPerformed java.awt.event.ActionEvent  oEvent  )  [inline]
 

If passed the order to write chart data, does it.

Parameters:
oEvent ActionEvent Event to process.

Reimplemented in datavisualizer::StandTableDataRequest, datavisualizer::StockTableDataRequest, and datavisualizer::TreeMapDataRequest.

void datavisualizer::DataRequest::AddGridBoolData String  sGridName,
int  iX,
int  iY,
int  iCode,
boolean  bVal
[inline]
 

Accepts a piece of grid bool data from the parser.

If this particular piece is not wanted, do nothing.

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.
bVal Value.

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

Reimplemented in datavisualizer::GridDataRequest.

void datavisualizer::DataRequest::AddGridBoolDataMemberCode String  sGridName,
String  sLabel,
int  iCode
[inline]
 

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

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

Reimplemented in datavisualizer::GridDataRequest.

void datavisualizer::DataRequest::AddGridCharData String  sGridName,
int  iX,
int  iY,
int  iCode,
String  sVal
[inline]
 

Accepts a piece of grid char data from the parser.

If this particular piece is not wanted, do nothing.

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.
sVal Value.

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

void datavisualizer::DataRequest::AddGridCharDataMemberCode String  sGridName,
String  sLabel,
int  iCode
[inline]
 

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

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

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

Accepts a piece of grid float data from the parser.

If this particular piece is not wanted, do nothing.

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:
------------------
April 28, 2004: Submitted in beta version (LEM)

Reimplemented in datavisualizer::CarbonValueDataRequest, datavisualizer::GridDataRequest, datavisualizer::GridHistogramDataRequest, datavisualizer::HarvestDataRequest, and datavisualizer::MerchValueDataRequest.

void datavisualizer::DataRequest::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:
------------------
April 28, 2004: Submitted in beta version (LEM)

Reimplemented in datavisualizer::CarbonValueDataRequest, datavisualizer::GridDataRequest, datavisualizer::GridHistogramDataRequest, datavisualizer::HarvestDataRequest, and datavisualizer::MerchValueDataRequest.

void datavisualizer::DataRequest::AddGridIntData String  sGridName,
int  iX,
int  iY,
int  iCode,
int  iVal
[inline]
 

Accepts a piece of grid int data from the parser.

If this particular piece is not wanted, do nothing.

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.
iVal Value.

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

Reimplemented in datavisualizer::GridDataRequest, datavisualizer::GridHistogramDataRequest, and datavisualizer::HarvestDataRequest.

void datavisualizer::DataRequest::AddGridIntDataMemberCode String  sGridName,
String  sLabel,
int  iCode
[inline]
 

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

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

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

Reimplemented in datavisualizer::GridDataRequest, datavisualizer::GridHistogramDataRequest, and datavisualizer::HarvestDataRequest.

void datavisualizer::DataRequest::AddGridPackageBoolData String  sGridName,
int  iX,
int  iY,
int  iCode,
boolean  bVal
[inline]
 

Accepts a piece of grid package bool data from the parser.

If this particular piece is not wanted, do nothing.

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.
bVal Value.

Edit history:
------------------
March 20, 2006: Created (LEM)

void datavisualizer::DataRequest::AddGridPackageBoolDataMemberCode String  sGridName,
String  sLabel,
int  iCode
[inline]
 

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

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

void datavisualizer::DataRequest::AddGridPackageCharData String  sGridName,
int  iX,
int  iY,
int  iCode,
String  sVal
[inline]
 

Accepts a piece of grid package char data from the parser.

If this particular piece is not wanted, do nothing.

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.
sVal Value.

Edit history:
------------------
March 20, 2006: Created (LEM)

void datavisualizer::DataRequest::AddGridPackageCharDataMemberCode String  sGridName,
String  sLabel,
int  iCode
[inline]
 

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

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

void datavisualizer::DataRequest::AddGridPackageFloatData String  sGridName,
int  iX,
int  iY,
int  iCode,
float  fVal
[inline]
 

Accepts a piece of grid package float data from the parser.

If this particular piece is not wanted, do nothing.

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:
------------------
March 20, 2006: Created (LEM)

Reimplemented in datavisualizer::WindstormDataRequest.

void datavisualizer::DataRequest::AddGridPackageFloatDataMemberCode String  sGridName,
String  sLabel,
int  iCode
[inline]
 

Accepts a grid package 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.

Reimplemented in datavisualizer::WindstormDataRequest.

void datavisualizer::DataRequest::AddGridPackageIntData String  sGridName,
int  iX,
int  iY,
int  iCode,
int  iVal
[inline]
 

Accepts a piece of grid package int data from the parser.

If this particular piece is not wanted, do nothing.

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.
iVal Value.

Edit history:
------------------
March 20, 2006: Created (LEM)

void datavisualizer::DataRequest::AddGridPackageIntDataMemberCode String  sGridName,
String  sLabel,
int  iCode
[inline]
 

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

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

void datavisualizer::DataRequest::AddTreeBoolData int  iSpecies,
int  iType,
int  iCode,
boolean  bVal
[inline]
 

Accepts a piece of tree bool data from the parser.

If this particular piece is not wanted, do nothing.

Parameters:
iSpecies Species of the tree from which this value came.
iType Type of the tree from which this value came.
iCode Data member code of this value.
bVal Value.

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

void datavisualizer::DataRequest::AddTreeBoolDataMemberCode int  iSpecies,
int  iType,
String  sLabel,
int  iCode
[inline]
 

Accepts a tree bool data member code for future reference when passed bool data members.

Parameters:
iSpecies The species for which this is a data member.
iType The tree type for which this is a data member.
sLabel The label of the data member.
iCode The data member code.

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

void datavisualizer::DataRequest::AddTreeCharData int  iSpecies,
int  iType,
int  iCode,
String  sVal
[inline]
 

Accepts a piece of tree char data from the parser.

If this particular piece is not wanted, do nothing.

Parameters:
iSpecies Species of the tree from which this value came.
iType Type of the tree from which this value came.
iCode Data member code of this value.
sVal Value.

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

void datavisualizer::DataRequest::AddTreeCharDataMemberCode int  iSpecies,
int  iType,
String  sLabel,
int  iCode
[inline]
 

Accepts a tree char data member code for future reference when passed char data members.

Parameters:
iSpecies The species for which this is a data member.
iType The tree type for which this is a data member.
sLabel The label of the data member.
iCode The data member code.

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

void datavisualizer::DataRequest::AddTreeFloatData int  iSpecies,
int  iType,
int  iCode,
float  fVal
[inline]
 

Accepts a piece of tree float data from the parser.

If this particular piece is not wanted, do nothing.

Parameters:
iSpecies Species of the tree from which this value came.
iType Type of the tree from which this value came.
iCode Data member code of this value.
fVal Value.

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

Reimplemented in datavisualizer::HistogramDataRequest, datavisualizer::LineGraphDataRequest, datavisualizer::OverviewTableDataRequest, datavisualizer::StandTableDataRequest, datavisualizer::StockTableDataRequest, and datavisualizer::TreeMapDataRequest.

void datavisualizer::DataRequest::AddTreeFloatDataMemberCode int  iSpecies,
int  iType,
String  sLabel,
int  iCode
[inline]
 

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

Parameters:
iSpecies The species for which this is a data member.
iType The tree type for which this is a data member.
sLabel The label of the data member.
iCode The data member code.

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

Reimplemented in datavisualizer::HistogramDataRequest, datavisualizer::LineGraphDataRequest, datavisualizer::OverviewTableDataRequest, datavisualizer::StandTableDataRequest, datavisualizer::StockTableDataRequest, and datavisualizer::TreeMapDataRequest.

void datavisualizer::DataRequest::AddTreeIntData int  iSpecies,
int  iType,
int  iCode,
int  iVal
[inline]
 

Accepts a piece of tree int data from the parser.

If this particular piece is not wanted, do nothing.

Parameters:
iSpecies Species of the tree from which this value came.
iType Type of the tree from which this value came.
iCode Data member code of this value.
iVal Value.

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

Reimplemented in datavisualizer::HistogramDataRequest.

void datavisualizer::DataRequest::AddTreeIntDataMemberCode int  iSpecies,
int  iType,
String  sLabel,
int  iCode
[inline]
 

Accepts a tree int data member code for future reference when passed int data members.

Parameters:
iSpecies The species for which this is a data member.
iType The tree type for which this is a data member.
sLabel The label of the data member.
iCode The data member code.

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

Reimplemented in datavisualizer::HistogramDataRequest.

abstract void datavisualizer::DataRequest::ClearData  )  throws ModelException [package, pure virtual]
 

Clears out data for garbage collection in preparation for new data being read in.

Exceptions:
ModelException if there are problems.

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

Implemented in datavisualizer::CarbonValueDataRequest, datavisualizer::GridDataRequest, datavisualizer::GridHistogramDataRequest, datavisualizer::HarvestDataRequest, datavisualizer::HistogramDataRequest, datavisualizer::LineGraphDataRequest, datavisualizer::MerchValueDataRequest, datavisualizer::OverviewTableDataRequest, datavisualizer::StandTableDataRequest, datavisualizer::StockTableDataRequest, datavisualizer::TreeMapDataRequest, and datavisualizer::WindstormDataRequest.

abstract JInternalFrame datavisualizer::DataRequest::DrawChart Legend  oLegend,
String  sChartTitle
throws ModelException [package, pure virtual]
 

Draws the chart for this data request according to its individual settings and data.

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

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

Implemented in datavisualizer::CarbonValueDataRequest, datavisualizer::GridDataRequest, datavisualizer::GridHistogramDataRequest, datavisualizer::HarvestDataRequest, datavisualizer::HistogramDataRequest, datavisualizer::LineGraphDataRequest, datavisualizer::MerchValueDataRequest, datavisualizer::OverviewTableDataRequest, datavisualizer::StandTableDataRequest, datavisualizer::StockTableDataRequest, datavisualizer::TreeMapDataRequest, and datavisualizer::WindstormDataRequest.

void datavisualizer::DataRequest::EndPackage  )  [inline]
 

Announces a package has ended.

Data requests can do whatever they want with this information, including nothing.

Reimplemented in datavisualizer::WindstormDataRequest.

JInternalFrame datavisualizer::DataRequest::GetChart  )  [inline]
 

Get the chart frame.

Returns:
Chart frame.

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

String datavisualizer::DataRequest::GetChartName  )  [inline]
 

Get the name of the chart.

Returns:
Chart name.

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

void datavisualizer::DataRequest::SaveChartDataToFile boolean  bJustCurrTS  )  [inline]
 

Writes a chart's data to a file.

This can write data for only the current timestep or the whole run.

Parameters:
bJustCurrTS If true, writes for only the current timestep. If false, writes for the whole run.

abstract void datavisualizer::DataRequest::UpdateChart Legend  oLegend  )  throws ModelException [package, pure 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)

Implemented in datavisualizer::CarbonValueDataRequest, datavisualizer::GridDataRequest, datavisualizer::GridHistogramDataRequest, datavisualizer::HarvestDataRequest, datavisualizer::HistogramDataRequest, datavisualizer::LineGraphDataRequest, datavisualizer::MerchValueDataRequest, datavisualizer::OverviewTableDataRequest, datavisualizer::StandTableDataRequest, datavisualizer::StockTableDataRequest, datavisualizer::TreeMapDataRequest, and datavisualizer::WindstormDataRequest.

boolean datavisualizer::DataRequest::WantAnyGridBools  )  [inline]
 

Whether or not this object wants any grid bool data members.

Returns:
True if bool data members are desired, false if not.

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

Reimplemented in datavisualizer::GridDataRequest.

boolean datavisualizer::DataRequest::WantAnyGridChars  )  [inline]
 

Whether or not this object wants any grid char data members.

Returns:
True if char data members are desired, false if not.

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

boolean datavisualizer::DataRequest::WantAnyGridFloats  )  [inline]
 

Whether or not this object wants any grid float data members.

Returns:
True if float data members are desired, false if not.

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

Reimplemented in datavisualizer::CarbonValueDataRequest, datavisualizer::GridDataRequest, datavisualizer::GridHistogramDataRequest, datavisualizer::HarvestDataRequest, and datavisualizer::MerchValueDataRequest.

boolean datavisualizer::DataRequest::WantAnyGridInts  )  [inline]
 

Whether or not this object wants any grid int data members.

Returns:
True if int data members are desired, false if not.

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

Reimplemented in datavisualizer::GridDataRequest, datavisualizer::GridHistogramDataRequest, and datavisualizer::HarvestDataRequest.

boolean datavisualizer::DataRequest::WantAnyGridPackageBools  )  [inline]
 

Whether or not this object wants any grid package bool data members.

Returns:
True if bool data members are desired, false if not.

Edit history:
------------------
March 20, 2006: Created (LEM)

boolean datavisualizer::DataRequest::WantAnyGridPackageChars  )  [inline]
 

Whether or not this object wants any grid package char data members.

Returns:
True if char data members are desired, false if not.

Edit history:
------------------
March 20, 2006: Created (LEM)

boolean datavisualizer::DataRequest::WantAnyGridPackageFloats  )  [inline]
 

Whether or not this object wants any grid package float data members.

Returns:
True if float data members are desired, false if not.

Edit history:
------------------
March 20, 2006: Created (LEM)

Reimplemented in datavisualizer::WindstormDataRequest.

boolean datavisualizer::DataRequest::WantAnyGridPackageInts  )  [inline]
 

Whether or not this object wants any grid package int data members.

Returns:
True if int data members are desired, false if not.

Edit history:
------------------
March 20, 2006: Created (LEM)

boolean datavisualizer::DataRequest::WantAnyTreeBools  )  [inline]
 

Whether or not this object wants any tree bool data members.

Returns:
True if bool data members are desired, false if not.

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

boolean datavisualizer::DataRequest::WantAnyTreeChars  )  [inline]
 

Whether or not this object wants any tree char data members.

Returns:
True if char data members are desired, false if not.

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

boolean datavisualizer::DataRequest::WantAnyTreeFloats  )  [inline]
 

Whether or not this object wants any tree float data members.

Returns:
True if float data members are desired, false if not.

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

Reimplemented in datavisualizer::HistogramDataRequest, datavisualizer::LineGraphDataRequest, datavisualizer::OverviewTableDataRequest, datavisualizer::StandTableDataRequest, datavisualizer::StockTableDataRequest, and datavisualizer::TreeMapDataRequest.

boolean datavisualizer::DataRequest::WantAnyTreeInts  )  [inline]
 

Whether or not this object wants any tree int data members.

Returns:
True if int data members are desired, false if not.

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

Reimplemented in datavisualizer::HistogramDataRequest.

abstract void datavisualizer::DataRequest::WriteChartDataToFile java.io.FileWriter  jOut  )  throws java.io.IOException, javawrapper.ModelException [protected, pure virtual]
 

Child classes override this to write the data behind their chart to tab-delimited text.

They can assume that the chart's header has already been written as a file title at the top, and that a line for the current timestep has been written as well.

Parameters:
jOut java.io.FileWriter The file to write to. Doesn't need to be opened or closed.
Exceptions:
java.io.IOException if there is a problem writing the file.
ModelException if there is a problem assembling the chart data.

Implemented in datavisualizer::CarbonValueDataRequest, datavisualizer::GridDataRequest, datavisualizer::GridHistogramDataRequest, datavisualizer::HarvestDataRequest, datavisualizer::HistogramDataRequest, datavisualizer::LineGraphDataRequest, datavisualizer::MerchValueDataRequest, datavisualizer::OverviewTableDataRequest, datavisualizer::StandTableDataRequest, datavisualizer::StockTableDataRequest, datavisualizer::TreeMapDataRequest, and datavisualizer::WindstormDataRequest.


Member Data Documentation

boolean datavisualizer::DataRequest::m_bShowOneTimestep = true [protected]
 

Whether this chart shows one timestep at a time (true) or all timesteps (false).

Defaults to true.

JInternalFrame datavisualizer::DataRequest::m_oChartFrame [protected]
 

Chart for this request.

This is not automatically set.


The documentation for this class was generated from the following file:
Generated on Mon Mar 27 15:15:24 2006 for SORTIE Java Interface by  doxygen 1.4.6-NO