datavisualizer.GridDataRequest Class Reference

Draws a map for a single grid's data member. More...

Inheritance diagram for datavisualizer.GridDataRequest:

datavisualizer.DataRequest

List of all members.

Public Member Functions

 GridDataRequest (String sChartName, String sGridName, String sDataMemberLabel, DetailedOutputFileManager oManager)
 Constructor.
boolean WantAnyGridBools ()
 Whether or not the data member we want is boolean.
boolean WantAnyGridInts ()
 Whether or not the data member we want is integer.
boolean WantAnyGridFloats ()
 Whether or not the data member we want is float.
void AddGridFloatDataMemberCode (String sGridName, String sLabel, int iCode)
 Checks to see if our data member's a float.
void AddGridIntDataMemberCode (String sGridName, String sLabel, int iCode)
 Checks to see if our data member's an integer.
void AddGridBoolDataMemberCode (String sGridName, String sLabel, int iCode)
 Checks to see if our data member's a boolean.
void AddGridBoolData (String sGridName, int iX, int iY, int iCode, boolean bVal)
 Accepts the value of our data member from the parser, if bool.
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)
 Accepts the value of our data member from the parser, if float.
void SetMinimumDisplayValue (float fValue)
 Sets the minimum display value for the grid.
void SetKneeDisplayValue (float fValue)
 Sets the knee display value for the grid.
void SetMaximumDisplayValue (float fValue)
 Sets the maximum display value for the grid.
void SetMinimumDisplayColor (int iValue)
 Sets the minimum display color for the grid.
void SetKneeDisplayColor (int iValue)
 Sets the knee display color for the grid.
void SetMaximumDisplayColor (int iValue)
 Sets the maximum display color for the grid.
void SetUserSetDisplay (boolean bValue)
 Sets whether or not the user set display values.

Protected Member Functions

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

Package Functions

void UpdateChart (Legend oLegend) throws javawrapper.ModelException
 Updates the chart with whatever's in our dataset.
ModelInternalFrame DrawChart (Legend oLegend, String sChartTitle) throws javawrapper.ModelException
 Draws the grayscale grid map.
void ClearData () throws javawrapper.ModelException
 Clears out data for garbage collection in preparation for new data being read in.

Package Attributes

String m_sDataMemberLabel
 The label of the data member to graph.
String m_sGridName
 The grid of the data member being graphed.

Private Member Functions

XYCellRenderer GetRenderer () throws javawrapper.ModelException
 Creates the XYCellRenderer for this graph.

Private Attributes

Vector< XYZDataItemm_oSeries = new Vector<XYZDataItem>(0)
 This holds the actual grid XYZ data.
float m_fMinDisplayValue
 Minimum value, in case the user sets it.
float m_fKneeDisplayValue
 Knee value, in case the user sets it.
float m_fMaxDisplayValue
 Maximum value, in case the user sets it.
int m_iDataCode
 Data member code of the value we're graphing.
int m_iMinDisplayColor
 Minimum color value, in case the user sets it.
int m_iKneeDisplayColor
 Knee color value, in case the user sets it.
int m_iMaxDisplayColor
 Maximum color value, in case the user sets it.
boolean m_bDataIsInt
 Whether or not the data member is an integer.
boolean m_bDataIsFloat
 Whether or not the data member is a float.
boolean m_bDataIsBoolean
 Whether or not the data member is a boolean.
boolean m_bUserSetDisplay = false
 Whether or not the user has manually set grayscale display - if true, there will be no more automatic updating of the grayscale values.


Detailed Description

Draws a map for a single grid's data member.

It can graph an integer, a float, or a bool (which converts to an int of 0 or 1). The values are mapped on a grayscale. The minimum (black) value will be 0, or the smallest value if it is less than 0. The maximum (white) value will be found at each timestep, and the knee will be set between the minimum and maximum value.

Author:
Lora E. Murphy
Version:
1.0

Edit history:
------------------
April 28, 2004: Submitted in beta version (LEM)
February 4, 2008: Updated to conform to Java 6 compliance (LEM)

Constructor & Destructor Documentation

datavisualizer.GridDataRequest.GridDataRequest ( String  sChartName,
String  sGridName,
String  sDataMemberLabel,
DetailedOutputFileManager  oManager 
)

Constructor.

Parameters:
sChartName Name of chart.
sDataMemberLabel Label of data member to graph.
sGridName Name of the grid that has the data member.
oManager DetailedOutputFileManager for this file.

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


Member Function Documentation

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

Writes the grid map'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.

boolean datavisualizer.GridDataRequest.WantAnyGridBools (  ) 

Whether or not the data member we want is boolean.

Returns:
True if our data member is boolean, false if not.

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

Reimplemented from datavisualizer.DataRequest.

boolean datavisualizer.GridDataRequest.WantAnyGridInts (  ) 

Whether or not the data member we want is integer.

Returns:
True if our data member is integer, false if not.

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

Reimplemented from datavisualizer.DataRequest.

boolean datavisualizer.GridDataRequest.WantAnyGridFloats (  ) 

Whether or not the data member we want is float.

Returns:
True if our data member is float, false if not.

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

Reimplemented from datavisualizer.DataRequest.

void datavisualizer.GridDataRequest.AddGridFloatDataMemberCode ( String  sGridName,
String  sLabel,
int  iCode 
)

Checks to see if our data member's a float.

If the label matches, this grabs the code and sets the flags.

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 from datavisualizer.DataRequest.

void datavisualizer.GridDataRequest.AddGridIntDataMemberCode ( String  sGridName,
String  sLabel,
int  iCode 
)

Checks to see if our data member's an integer.

If the label matches, this grabs the code and sets the flags.

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 from datavisualizer.DataRequest.

void datavisualizer.GridDataRequest.AddGridBoolDataMemberCode ( String  sGridName,
String  sLabel,
int  iCode 
)

Checks to see if our data member's a boolean.

If the label matches, this grabs the code and sets the flags.

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 from datavisualizer.DataRequest.

void datavisualizer.GridDataRequest.AddGridBoolData ( String  sGridName,
int  iX,
int  iY,
int  iCode,
boolean  bVal 
)

Accepts the value of our data member from the parser, if bool.

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 from datavisualizer.DataRequest.

void datavisualizer.GridDataRequest.AddGridFloatData ( String  sGridName,
int  iX,
int  iY,
int  iCode,
float  fVal 
)

Accepts the value of our data member from the parser, if float.

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 from datavisualizer.DataRequest.

void datavisualizer.GridDataRequest.AddGridIntData ( String  sGridName,
int  iX,
int  iY,
int  iCode,
int  iVal 
)

Accepts the value of our data member from the parser, if float.

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 from datavisualizer.DataRequest.

void datavisualizer.GridDataRequest.UpdateChart ( Legend  oLegend  )  throws javawrapper.ModelException [package, virtual]

Updates the chart with whatever's in our dataset.

Parameters:
oLegend Legend. Ignored.
Exceptions:
javawrapper.ModelException If there's a problem.

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

Implements datavisualizer.DataRequest.

ModelInternalFrame datavisualizer.GridDataRequest.DrawChart ( Legend  oLegend,
String  sChartTitle 
) throws javawrapper.ModelException [package, virtual]

Draws the grayscale grid map.

Parameters:
oLegend Tree legend - ignored.
sChartTitle Title of chart.
Returns:
The chart in a JInternalFrame.
Exceptions:
javawrapper.ModelException 
Edit history:
------------------
April 28, 2004: Submitted in beta version (LEM)

Implements datavisualizer.DataRequest.

void datavisualizer.GridDataRequest.ClearData (  )  throws javawrapper.ModelException [package, virtual]

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

Exceptions:
ModelException if there are problems.

Implements datavisualizer.DataRequest.

XYCellRenderer datavisualizer.GridDataRequest.GetRenderer (  )  throws javawrapper.ModelException [private]

Creates the XYCellRenderer for this graph.

If the user has set grayscale controls, they are passed to the renderer. If not, this sets the defaults according to the dataset. The minimum data value is set to 0 unless there is a smaller value, in which case that becomes the minimum. The maximum data value is set to the highest Z value in the dataset. The knee value is set halfway from the minimum to the maximum. The color values are left alone.

Returns:
The set up XYCellRenderer.
Exceptions:
javawrapper.ModelException if the color values are rejected.

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

void datavisualizer.GridDataRequest.SetMinimumDisplayValue ( float  fValue  ) 

Sets the minimum display value for the grid.

Same as XYCellRenderer's minimum value.

Parameters:
fValue Minimum display value for the grid.

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

void datavisualizer.GridDataRequest.SetKneeDisplayValue ( float  fValue  ) 

Sets the knee display value for the grid.

Same as XYCellRenderer's knee value.

Parameters:
fValue Knee display value for the grid.

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

void datavisualizer.GridDataRequest.SetMaximumDisplayValue ( float  fValue  ) 

Sets the maximum display value for the grid.

Same as XYCellRenderer's maximum value.

Parameters:
fValue Maximum display value for the grid.

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

void datavisualizer.GridDataRequest.SetMinimumDisplayColor ( int  iValue  ) 

Sets the minimum display color for the grid.

Same as XYCellRenderer's minimum color.

Parameters:
iValue Minimum display color for the grid.

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

void datavisualizer.GridDataRequest.SetKneeDisplayColor ( int  iValue  ) 

Sets the knee display color for the grid.

Same as XYCellRenderer's knee color.

Parameters:
iValue Knee display color for the grid.

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

void datavisualizer.GridDataRequest.SetMaximumDisplayColor ( int  iValue  ) 

Sets the maximum display color for the grid.

Same as XYCellRenderer's maximum color.

Parameters:
iValue Maximum display color for the grid.

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

void datavisualizer.GridDataRequest.SetUserSetDisplay ( boolean  bValue  ) 

Sets whether or not the user set display values.

Parameters:
bValue Whether or not the user set display values.

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


Member Data Documentation

This holds the actual grid XYZ data.

X is the X cell number, Y is the Y cell number, Z is the value of the cell to graph.

The label of the data member to graph.

The grid of the data member being graphed.

Minimum value, in case the user sets it.

Knee value, in case the user sets it.

Maximum value, in case the user sets it.

Data member code of the value we're graphing.

Minimum color value, in case the user sets it.

Knee color value, in case the user sets it.

Maximum color value, in case the user sets it.

Whether or not the data member is an integer.

Whether or not the data member is a float.

Whether or not the data member is a boolean.

Whether or not the user has manually set grayscale display - if true, there will be no more automatic updating of the grayscale values.


The documentation for this class was generated from the following file:

Generated on Tue Apr 19 13:59:32 2011 for SORTIE Java Interface by  doxygen 1.5.6