datavisualizer.DetailedOutputFileManager Class Reference

Controls the data visualization for a single detailed output file. More...

Inheritance diagram for datavisualizer.DetailedOutputFileManager:

datavisualizer.DataFileManager

List of all members.

Public Member Functions

void SetParFileTimesteps (int i)
 Sets the number of timesteps for the detailed output file parameter file.
int GetNumberOfActualTimesteps ()
 Gets the number of actual data timesteps contained in this detailed output file (as opposed to how many the par file says there are).
void SetSubplotXCellLength (float f)
 Sets the subplot X cell length.
void SetSubplotYCellLength (float f)
 Sets the subplot Y cell length.
boolean IsThisSubplot (String sSubplotName)
 Checks to see if a subplot name indicates that the detailed output file being managed is in fact for that subplot.
float GetPlotArea ()
 Gets the area of this plot or subplot, in ha.
JInternalFrame DrawChart (String sGraphName) throws ModelException
 Handles the request to draw a chart for this file.
void UpdateCurrentRunCharts () throws ModelException
 Updates charts for a current run.
String[] GetTableOptions ()
 Gets the tables that can be drawn for this file.
String[] GetHistogramOptions ()
 Gets the histograms that can be drawn for this file.
String[] GetMapOptions ()
 Gets the maps that can be drawn for this file.
String[] GetLineGraphOptions ()
 Gets the line graphs that can be drawn for this file.
void SetXPlotLength (float f)
 Sets the plot X length.
void SetYPlotLength (float f)
 Sets the plot Y length.
void SetNumberOfYearsPerTimestep (float f)
 Sets the number of years per timestep.
float GetNumberOfYearsPerTimestep ()
 Gets the number of years per timestep.
float GetXPlotLength ()
 Gets the plot X length.
float GetYPlotLength ()
 Gets the plot Y length.
 DetailedOutputFileManager (DataVisualizerManager oManager, String sTarball) throws ModelException
 Constructor.
void UpdateCharts () throws ModelException
 Redraws all the charts currently open for this detailed output file.
void AddSpeciesName (String sName)
 Adds a species name to the end of the species name list.
DetailedTreeSettings CreateNewTreeSettings (String sSpeciesName, int iType, int iDeadCode) throws ModelException
 Creates a new DetailedTreeSettings object and adds it to the tree settings vector.
DetailedGridSettings CreateNewGridSettings (String sGridName)
 Creates a new DetailedGridSettings object and adds it to the grid settings vector.
void AddGridXCellLength (String sGridName, float fLength)
 Adds the X cell length to grid settings.
void AddGridYCellLength (String sGridName, float fLength)
 Adds the Y cell length to grid settings.
int GetNumberOfSpecies ()
 Gets the number of species that exist in the detailed output header file.
int GetNumberOfTypes ()
 Gets the number of tree types.
int GetSpeciesCodeFromName (String sName) throws ModelException
 When passed the name of a species, will give back the corresponding species number code.
String GetSpeciesNameFromCode (int iIndex) throws ModelException
 When passed the index of a species, will give back the corresponding species name.
void ReadFile (int iTimestep) throws ModelException
 Read the detailed output file for a particular timestep.
boolean WantAnyTreeFloats ()
 Whether or not any open data requests want any tree float data members.
boolean WantAnyDeadTreeFloats ()
 Whether or not any open data requests want any dead tree float data members.
boolean WantAnyGridFloats ()
 Whether or not any open data requests want any grid float data members.
boolean WantAnyGridPackageFloats ()
 Whether or not any open data requests want any grid package float data members.
boolean WantAnyTreeInts ()
 Whether or not any open data requests want any tree int data members.
boolean WantAnyDeadTreeInts ()
 Whether or not any open data requests want any dead tree int data members.
boolean WantAnyGridInts ()
 Whether or not any open data requests want any grid int data members.
boolean WantAnyGridPackageInts ()
 Whether or not any open data requests want any grid package int data members.
boolean WantAnyTreeChars ()
 Whether or not any open data requests want any tree char data members.
boolean WantAnyDeadTreeChars ()
 Whether or not any open data requests want any dead tree char data members.
boolean WantAnyGridChars ()
 Whether or not any open data requests want any grid char data members.
boolean WantAnyGridPackageChars ()
 Whether or not any open data requests want any grid package char data members.
boolean WantAnyTreeBools ()
 Whether or not any open data requests want any tree bool data members.
boolean WantAnyDeadTreeBools ()
 Whether or not any open data requests want any dead tree bool data members.
boolean WantAnyGridBools ()
 Whether or not any open data requests want any grid bool data members.
boolean WantAnyGridPackageBools ()
 Whether or not any open data requests want any grid package bool data members.
void AddTreeFloatData (int iSpecies, int iType, int iCode, float fVal) throws SAXException
 Accepts a piece of tree float data from the parser and passes it on to open data requests.
void AddDeadTreeFloatData (int iSpecies, int iType, int iCode, int iDeadCode, float fVal) throws SAXException
 Accepts a piece of dead tree float data from the parser and passes it on to open data requests.
void AddGridFloatData (String sGridName, int iX, int iY, int iCode, float fVal) throws SAXException
 Accepts a piece of grid float data from the parser and passes it on to open data requests.
void AddGridPackageFloatData (String sGridName, int iX, int iY, int iCode, float fVal) throws SAXException
 Accepts a piece of grid package float data from the parser and passes it on to open data requests.
void AddTreeIntData (int iSpecies, int iType, int iCode, int iVal) throws SAXException
 Accepts a piece of tree int data from the parser and passes it on to open data requests.
void AddDeadTreeIntData (int iSpecies, int iType, int iCode, int iDeadCode, int iVal) throws SAXException
 Accepts a piece of dead tree int data from the parser and passes it on to open data requests.
void AddGridIntData (String sGridName, int iX, int iY, int iCode, int iVal) throws SAXException
 Accepts a piece of grid int data from the parser and passes it on to open data requests.
void AddGridPackageIntData (String sGridName, int iX, int iY, int iCode, int iVal) throws SAXException
 Accepts a piece of grid package int data from the parser and passes it on to open data requests.
void AddTreeCharData (int iSpecies, int iType, int iCode, String sVal) throws SAXException
 Accepts a piece of tree char data from the parser and passes it on to open data requests.
void AddDeadTreeCharData (int iSpecies, int iType, int iCode, int iDeadCode, String sVal) throws SAXException
 Accepts a piece of dead tree char data from the parser and passes it on to open data requests.
void AddGridCharData (String sGridName, int iX, int iY, int iCode, String sVal) throws SAXException
 Accepts a piece of grid char data from the parser and passes it on to open data requests.
void AddGridPackageCharData (String sGridName, int iX, int iY, int iCode, String sVal) throws SAXException
 Accepts a piece of grid package char data from the parser and passes it on to open data requests.
void AddTreeBoolData (int iSpecies, int iType, int iCode, boolean bVal) throws SAXException
 Accepts a piece of tree bool data from the parser to pass on to open data requests.
void AddDeadTreeBoolData (int iSpecies, int iType, int iCode, int iDeadCode, boolean bVal) throws SAXException
 Accepts a piece of dead tree bool data from the parser to pass on to open data requests.
void AddGridBoolData (String sGridName, int iX, int iY, int iCode, boolean bVal) throws SAXException
 Accepts a piece of grid bool data from the parser to pass on to open data requests.
void AddGridPackageBoolData (String sGridName, int iX, int iY, int iCode, boolean bVal) throws SAXException
 Accepts a piece of grid package bool data from the parser to pass on to open data requests.
void AddTreeFloatDataMemberCode (int iSpecies, int iType, String sLabel, int iCode) throws SAXException
 Accepts a tree float data member code from the parser to pass on to open data requests.
void AddGridFloatDataMemberCode (String sGridName, String sLabel, int iCode) throws SAXException
 Accepts a grid float data member code from the parser to pass on to open data requests.
void AddGridPackageFloatDataMemberCode (String sGridName, String sLabel, int iCode) throws SAXException
 Accepts a grid package float data member code from the parser to pass on to open data requests.
void AddTreeIntDataMemberCode (int iSpecies, int iType, String sLabel, int iCode) throws SAXException
 Accepts an int data member code from the parser to pass on to open data requests.
void AddGridIntDataMemberCode (String sGridName, String sLabel, int iCode) throws SAXException
 Accepts an int data member code from the parser to pass on to open data requests.
void AddGridPackageIntDataMemberCode (String sGridName, String sLabel, int iCode) throws SAXException
 Accepts a grid package int data member code from the parser to pass on to open data requests.
void AddTreeCharDataMemberCode (int iSpecies, int iType, String sLabel, int iCode) throws SAXException
 Accepts a tree char data member code from the parser to pass on to open data requests.
void AddGridCharDataMemberCode (String sGridName, String sLabel, int iCode) throws SAXException
 Accepts a grid char data member code from the parser to pass on to open data requests.
void AddGridPackageCharDataMemberCode (String sGridName, String sLabel, int iCode) throws SAXException
 Accepts a grid package char data member code from the parser to pass on to open data requests.
void AddTreeBoolDataMemberCode (int iSpecies, int iType, String sLabel, int iCode) throws SAXException
 Accepts a tree bool data member code from the parser to pass on to open data requests.
void AddGridBoolDataMemberCode (String sGridName, String sLabel, int iCode) throws SAXException
 Accepts a grid bool data member code from the parser to pass on to open data requests.
void AddGridPackageBoolDataMemberCode (String sGridName, String sLabel, int iCode) throws SAXException
 Accepts a grid package bool data member code from the parser to pass on to open data requests.
void EndPackage () throws SAXException
 Notifies all open data requests that a new package has ended.
void EndTree () throws SAXException
 Notifies all open data requests that a tree record has ended.
int GetNumberTreeSettings ()
 Get the total number of detailed tree settings.
DetailedTreeSettings GetTreeSetting (int i)
 Access a detailed tree output settings record.
float GetGridXCellLength (String sGridName)
 Gets the length of X cells for a grid.
float GetGridYCellLength (String sGridName)
 Gets the length of Y cells for a grid.
void CleanUp ()
 Deletes all files from the tarball in the temp folder.
void AddSubplotCell (int iX, int iY)
 Adds one of the cells of this subplot.

Private Member Functions

void CountTimesteps () throws ModelException
 Counts the number of timesteps in the tarball and places it in m_iNumTimesteps.
void ParseParamFile () throws ModelException
 Parses the parameter file portion of the tarball.

Private Attributes

Vector< DataRequestmp_oDataRequests = new Vector<DataRequest>(0)
 The collection of all data requests currently open.
Vector< String > mp_sSpeciesNames = new Vector<String>(0)
 Species names - the order determines the species codes.
Vector< DetailedTreeSettingsmp_oTreeSettings = new Vector<DetailedTreeSettings>(0)
 Collection of DetailedTreeSettings objects.
Vector< DetailedGridSettingsmp_oGridSettings = new Vector<DetailedGridSettings>(0)
 Collection of DetailedGridSettings objects.
boolean[] mp_bHistogramIsFloat
 Whether each histogram option is float (true) or int (false).
String[] mp_sHistogramNames
 Histogram names - so we can figure out which value in mp_bHistogramIsFloat value to use.
int[] mp_iDeadCodes
 Dead reason codes for each tree data member.
String m_sFileDisplayName
 Display string of filename - should have the last 20 chars.
XMLReader m_oParser
 File parser.
String m_sTempRoot
 Root directory to put temp files.
String m_sTempDir
 Where we actually extract to.
String m_sFileRoot
 Root file name of all detailed output files.
float m_fPlotArea = 0
 Area of plot (or subplot) in hectares.
float m_fXPlotLength = 0
 Plot X length.
float m_fYPlotLength = 0
 Plot Y length.
float m_fSubplotXCellLength = 8
 X length of subplot cells, in m, if this is a subplot.
float m_fSubplotYCellLength = 8
 Y length of subplot cells, in m, if this is a subplot.
float m_fNumYearsPerTimestep
 Number of years per timestep.
int m_iNumTimesteps
 Number of actual timesteps of data.
int m_iNumParFileTimesteps
 Number of timestes from the par file.
int m_iNumTypes = 7
 Number of tree types.
int m_iLastTimestepRead
 When updating charts, this is the file parsed.


Detailed Description

Controls the data visualization for a single detailed output file.

Copyright: Copyright (c) Charles D. Canham 2003

Company: Institute of Ecosystem Studies

Author:
Lora E. Murphy
Version:
1.3

Edit history:
------------------
April 28, 2004: Submitted in beta version (LEM)
June 28, 2004: Added support for snags (LEM)
March 9, 2005: Added line graph for volume and made version 1.1 (LEM)
March 29, 2005: Added histograms for grids and made version 1.2 (LEM)
March 20, 2006: Added package support and made version 1.3 (LEM)
January 3, 2007: Added better subplot support including specific area calculation (LEM)
February 4, 2008: Updated to conform to Java 6 compliance (LEM)
October 20, 2010: Added the ability to see a histogram for all species at once for a grid (LEM)
March 3, 2011: Added support for dead trees (LEM)

Constructor & Destructor Documentation

datavisualizer.DetailedOutputFileManager.DetailedOutputFileManager ( DataVisualizerManager  oManager,
String  sTarball 
) throws ModelException

Constructor.

Parameters:
sTarball Detailed output file to manage.
Exceptions:
ModelException If there was a problem reading the file.


Member Function Documentation

void datavisualizer.DetailedOutputFileManager.SetParFileTimesteps ( int  i  ) 

Sets the number of timesteps for the detailed output file parameter file.

Parameters:
i Number of timesteps.

int datavisualizer.DetailedOutputFileManager.GetNumberOfActualTimesteps (  ) 

Gets the number of actual data timesteps contained in this detailed output file (as opposed to how many the par file says there are).

Returns:
int Number of timesteps for this detailed output file.

void datavisualizer.DetailedOutputFileManager.SetSubplotXCellLength ( float  f  ) 

Sets the subplot X cell length.

Parameters:
f X cell length, in m.

void datavisualizer.DetailedOutputFileManager.SetSubplotYCellLength ( float  f  ) 

Sets the subplot Y cell length.

Parameters:
f Y cell length, in m.

boolean datavisualizer.DetailedOutputFileManager.IsThisSubplot ( String  sSubplotName  ) 

Checks to see if a subplot name indicates that the detailed output file being managed is in fact for that subplot.

If it were, the subplot name would be the last part of the tarball name preceded by an underscore.

Parameters:
sSubplotName Name of possible subplot for this file.
Returns:
True if this is a subplot with that name, false otherwise.

float datavisualizer.DetailedOutputFileManager.GetPlotArea (  ) 

Gets the area of this plot or subplot, in ha.

Returns:
Plot area in ha.

JInternalFrame datavisualizer.DetailedOutputFileManager.DrawChart ( String  sGraphName  )  throws ModelException [virtual]

Handles the request to draw a chart for this file.

The request will be passed on to an appropriate DataRequest object. If the chart is already open, the open chart will be returned.

Parameters:
sGraphName Name of chart to draw.
Returns:
The drawn chart, or NULL if it could not be drawn.
Exceptions:
ModelException If anything goes wrong.

Implements datavisualizer.DataFileManager.

void datavisualizer.DetailedOutputFileManager.UpdateCurrentRunCharts (  )  throws ModelException [virtual]

Updates charts for a current run.

This re-inflates the tarball and gets the last timestep file for parsing and processing.

Exceptions:
ModelException if there is a problem reading the file or drawing the charts.

Implements datavisualizer.DataFileManager.

String [] datavisualizer.DetailedOutputFileManager.GetTableOptions (  )  [virtual]

Gets the tables that can be drawn for this file.

Returns:
String of tables, or NULL if no tables can be drawn.

Implements datavisualizer.DataFileManager.

String [] datavisualizer.DetailedOutputFileManager.GetHistogramOptions (  )  [virtual]

Gets the histograms that can be drawn for this file.

Returns:
String of tables, or NULL if no histograms can be drawn.

Implements datavisualizer.DataFileManager.

String [] datavisualizer.DetailedOutputFileManager.GetMapOptions (  )  [virtual]

Gets the maps that can be drawn for this file.

Returns:
String of maps, or NULL if no maps can be drawn.

Implements datavisualizer.DataFileManager.

String [] datavisualizer.DetailedOutputFileManager.GetLineGraphOptions (  )  [virtual]

Gets the line graphs that can be drawn for this file.

Returns:
String of tables, or NULL if no line graphs can be drawn.

Implements datavisualizer.DataFileManager.

void datavisualizer.DetailedOutputFileManager.SetXPlotLength ( float  f  ) 

Sets the plot X length.

Parameters:
f Plot X length, in meters.

void datavisualizer.DetailedOutputFileManager.SetYPlotLength ( float  f  ) 

Sets the plot Y length.

Parameters:
f Plot Y length, in meters.

void datavisualizer.DetailedOutputFileManager.SetNumberOfYearsPerTimestep ( float  f  ) 

Sets the number of years per timestep.

Parameters:
f Number of years per timestep.

float datavisualizer.DetailedOutputFileManager.GetNumberOfYearsPerTimestep (  ) 

Gets the number of years per timestep.

Returns:
Number of years per timestep.

float datavisualizer.DetailedOutputFileManager.GetXPlotLength (  ) 

Gets the plot X length.

Returns:
Plot X length, in meters.

float datavisualizer.DetailedOutputFileManager.GetYPlotLength (  ) 

Gets the plot Y length.

Returns:
Plot Y length, in meters.

void datavisualizer.DetailedOutputFileManager.UpdateCharts (  )  throws ModelException [virtual]

Redraws all the charts currently open for this detailed output file.

This is accomplished by sending an UpdateChart() call to each data request object.

Exceptions:
ModelException wrapping another exception.

Implements datavisualizer.DataFileManager.

void datavisualizer.DetailedOutputFileManager.AddSpeciesName ( String  sName  ) 

Adds a species name to the end of the species name list.

The position within the vector becomes that name's species index code.

Parameters:
sName The species name to add.

DetailedTreeSettings datavisualizer.DetailedOutputFileManager.CreateNewTreeSettings ( String  sSpeciesName,
int  iType,
int  iDeadCode 
) throws ModelException

Creates a new DetailedTreeSettings object and adds it to the tree settings vector.

Parameters:
sSpeciesName The species name string
iType The type number
Returns:
The new object created
Exceptions:
ModelException if either the type or the species name is invalid.

DetailedGridSettings datavisualizer.DetailedOutputFileManager.CreateNewGridSettings ( String  sGridName  ) 

Creates a new DetailedGridSettings object and adds it to the grid settings vector.

Parameters:
sGridName The grid name string
Returns:
The new object created

void datavisualizer.DetailedOutputFileManager.AddGridXCellLength ( String  sGridName,
float  fLength 
)

Adds the X cell length to grid settings.

Parameters:
sGridName The grid name for which to add the cell length.
fLength The new X cell length in m.

void datavisualizer.DetailedOutputFileManager.AddGridYCellLength ( String  sGridName,
float  fLength 
)

Adds the Y cell length to grid settings.

Parameters:
sGridName The grid name for which to add the cell length.
fLength The new Y cell length in m.

void datavisualizer.DetailedOutputFileManager.CountTimesteps (  )  throws ModelException [private]

Counts the number of timesteps in the tarball and places it in m_iNumTimesteps.

The value is found by counting the number of files. The number of timesteps is the number of files - 2 (for the parameter file and initial conditions). This is compared to the number of timesteps found in the header file and the lesser one is chosen.

Exceptions:
ModelException - wrapping other exceptions

void datavisualizer.DetailedOutputFileManager.ParseParamFile (  )  throws ModelException [private]

Parses the parameter file portion of the tarball.

This function parses the detailed output header file to find species information and tree setup information.

Exceptions:
ModelException if the file cannot be parsed.

int datavisualizer.DetailedOutputFileManager.GetNumberOfSpecies (  ) 

Gets the number of species that exist in the detailed output header file.

Returns:
The number of species.

int datavisualizer.DetailedOutputFileManager.GetNumberOfTypes (  ) 

Gets the number of tree types.

Returns:
The number of types.

int datavisualizer.DetailedOutputFileManager.GetSpeciesCodeFromName ( String  sName  )  throws ModelException

When passed the name of a species, will give back the corresponding species number code.

Parameters:
sName The name of the species.
Returns:
The code.
Exceptions:
ModelException if the name is not recognized.

String datavisualizer.DetailedOutputFileManager.GetSpeciesNameFromCode ( int  iIndex  )  throws ModelException

When passed the index of a species, will give back the corresponding species name.

Parameters:
iIndex Species index.
Returns:
Species name.
Exceptions:
ModelException if the index is unrecognized.

void datavisualizer.DetailedOutputFileManager.ReadFile ( int  iTimestep  )  throws ModelException

Read the detailed output file for a particular timestep.

Parameters:
iTimestep Timestep for which to read the file.
Exceptions:
ModelException If the file cannot be read.

boolean datavisualizer.DetailedOutputFileManager.WantAnyTreeFloats (  ) 

Whether or not any open data requests want any tree float data members.

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

boolean datavisualizer.DetailedOutputFileManager.WantAnyDeadTreeFloats (  ) 

Whether or not any open data requests want any dead tree float data members.

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

boolean datavisualizer.DetailedOutputFileManager.WantAnyGridFloats (  ) 

Whether or not any open data requests want any grid float data members.

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

boolean datavisualizer.DetailedOutputFileManager.WantAnyGridPackageFloats (  ) 

Whether or not any open data requests want any grid package float data members.

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

boolean datavisualizer.DetailedOutputFileManager.WantAnyTreeInts (  ) 

Whether or not any open data requests want any tree int data members.

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

boolean datavisualizer.DetailedOutputFileManager.WantAnyDeadTreeInts (  ) 

Whether or not any open data requests want any dead tree int data members.

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

boolean datavisualizer.DetailedOutputFileManager.WantAnyGridInts (  ) 

Whether or not any open data requests want any grid int data members.

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

boolean datavisualizer.DetailedOutputFileManager.WantAnyGridPackageInts (  ) 

Whether or not any open data requests want any grid package int data members.

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

boolean datavisualizer.DetailedOutputFileManager.WantAnyTreeChars (  ) 

Whether or not any open data requests want any tree char data members.

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

boolean datavisualizer.DetailedOutputFileManager.WantAnyDeadTreeChars (  ) 

Whether or not any open data requests want any dead tree char data members.

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

boolean datavisualizer.DetailedOutputFileManager.WantAnyGridChars (  ) 

Whether or not any open data requests want any grid char data members.

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

boolean datavisualizer.DetailedOutputFileManager.WantAnyGridPackageChars (  ) 

Whether or not any open data requests want any grid package char data members.

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

boolean datavisualizer.DetailedOutputFileManager.WantAnyTreeBools (  ) 

Whether or not any open data requests want any tree bool data members.

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

boolean datavisualizer.DetailedOutputFileManager.WantAnyDeadTreeBools (  ) 

Whether or not any open data requests want any dead tree bool data members.

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

boolean datavisualizer.DetailedOutputFileManager.WantAnyGridBools (  ) 

Whether or not any open data requests want any grid bool data members.

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

boolean datavisualizer.DetailedOutputFileManager.WantAnyGridPackageBools (  ) 

Whether or not any open data requests want any grid package bool data members.

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

void datavisualizer.DetailedOutputFileManager.AddTreeFloatData ( int  iSpecies,
int  iType,
int  iCode,
float  fVal 
) throws SAXException

Accepts a piece of tree float data from the parser and passes it on to open data requests.

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.

void datavisualizer.DetailedOutputFileManager.AddDeadTreeFloatData ( int  iSpecies,
int  iType,
int  iCode,
int  iDeadCode,
float  fVal 
) throws SAXException

Accepts a piece of dead tree float data from the parser and passes it on to open data requests.

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.
iDeadCode Dead code for this tree.
fVal Value.

void datavisualizer.DetailedOutputFileManager.AddGridFloatData ( String  sGridName,
int  iX,
int  iY,
int  iCode,
float  fVal 
) throws SAXException

Accepts a piece of grid float data from the parser and passes it on to open data requests.

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.

void datavisualizer.DetailedOutputFileManager.AddGridPackageFloatData ( String  sGridName,
int  iX,
int  iY,
int  iCode,
float  fVal 
) throws SAXException

Accepts a piece of grid package float data from the parser and passes it on to open data requests.

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.

void datavisualizer.DetailedOutputFileManager.AddTreeIntData ( int  iSpecies,
int  iType,
int  iCode,
int  iVal 
) throws SAXException

Accepts a piece of tree int data from the parser and passes it on to open data requests.

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.

void datavisualizer.DetailedOutputFileManager.AddDeadTreeIntData ( int  iSpecies,
int  iType,
int  iCode,
int  iDeadCode,
int  iVal 
) throws SAXException

Accepts a piece of dead tree int data from the parser and passes it on to open data requests.

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.
iDeadCode Dead code for this tree.
iVal Value.

void datavisualizer.DetailedOutputFileManager.AddGridIntData ( String  sGridName,
int  iX,
int  iY,
int  iCode,
int  iVal 
) throws SAXException

Accepts a piece of grid int data from the parser and passes it on to open data requests.

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.

void datavisualizer.DetailedOutputFileManager.AddGridPackageIntData ( String  sGridName,
int  iX,
int  iY,
int  iCode,
int  iVal 
) throws SAXException

Accepts a piece of grid package int data from the parser and passes it on to open data requests.

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.

void datavisualizer.DetailedOutputFileManager.AddTreeCharData ( int  iSpecies,
int  iType,
int  iCode,
String  sVal 
) throws SAXException

Accepts a piece of tree char data from the parser and passes it on to open data requests.

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.

void datavisualizer.DetailedOutputFileManager.AddDeadTreeCharData ( int  iSpecies,
int  iType,
int  iCode,
int  iDeadCode,
String  sVal 
) throws SAXException

Accepts a piece of dead tree char data from the parser and passes it on to open data requests.

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.
iDeadCode Dead code for this tree.
sVal Value.

void datavisualizer.DetailedOutputFileManager.AddGridCharData ( String  sGridName,
int  iX,
int  iY,
int  iCode,
String  sVal 
) throws SAXException

Accepts a piece of grid char data from the parser and passes it on to open data requests.

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.

void datavisualizer.DetailedOutputFileManager.AddGridPackageCharData ( String  sGridName,
int  iX,
int  iY,
int  iCode,
String  sVal 
) throws SAXException

Accepts a piece of grid package char data from the parser and passes it on to open data requests.

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.

void datavisualizer.DetailedOutputFileManager.AddTreeBoolData ( int  iSpecies,
int  iType,
int  iCode,
boolean  bVal 
) throws SAXException

Accepts a piece of tree bool data from the parser to pass on to open data requests.

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 and passes it on to open data requests.
bVal Value.

void datavisualizer.DetailedOutputFileManager.AddDeadTreeBoolData ( int  iSpecies,
int  iType,
int  iCode,
int  iDeadCode,
boolean  bVal 
) throws SAXException

Accepts a piece of dead tree bool data from the parser to pass on to open data requests.

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 and passes it on to open data requests.
iDeadCode Dead code for this tree.
bVal Value.

void datavisualizer.DetailedOutputFileManager.AddGridBoolData ( String  sGridName,
int  iX,
int  iY,
int  iCode,
boolean  bVal 
) throws SAXException

Accepts a piece of grid bool data from the parser to pass on to open data requests.

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 and passes it on to open data requests.
bVal Value.

void datavisualizer.DetailedOutputFileManager.AddGridPackageBoolData ( String  sGridName,
int  iX,
int  iY,
int  iCode,
boolean  bVal 
) throws SAXException

Accepts a piece of grid package bool data from the parser to pass on to open data requests.

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 and passes it on to open data requests.
bVal Value.

void datavisualizer.DetailedOutputFileManager.AddTreeFloatDataMemberCode ( int  iSpecies,
int  iType,
String  sLabel,
int  iCode 
) throws SAXException

Accepts a tree float data member code from the parser to pass on to open data requests.

Parameters:
iSpecies Species of the tree from which this value came.
iType Type of the tree from which this value came.
sLabel The label of the data member.
iCode The data member code.

void datavisualizer.DetailedOutputFileManager.AddGridFloatDataMemberCode ( String  sGridName,
String  sLabel,
int  iCode 
) throws SAXException

Accepts a grid float data member code from the parser to pass on to open data requests.

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

void datavisualizer.DetailedOutputFileManager.AddGridPackageFloatDataMemberCode ( String  sGridName,
String  sLabel,
int  iCode 
) throws SAXException

Accepts a grid package float data member code from the parser to pass on to open data requests.

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

void datavisualizer.DetailedOutputFileManager.AddTreeIntDataMemberCode ( int  iSpecies,
int  iType,
String  sLabel,
int  iCode 
) throws SAXException

Accepts an int data member code from the parser to pass on to open data requests.

Parameters:
iSpecies Species of the tree from which this value came.
iType Type of the tree from which this value came.
sLabel The label of the data member.
iCode The data member code.

void datavisualizer.DetailedOutputFileManager.AddGridIntDataMemberCode ( String  sGridName,
String  sLabel,
int  iCode 
) throws SAXException

Accepts an int data member code from the parser to pass on to open data requests.

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

void datavisualizer.DetailedOutputFileManager.AddGridPackageIntDataMemberCode ( String  sGridName,
String  sLabel,
int  iCode 
) throws SAXException

Accepts a grid package int data member code from the parser to pass on to open data requests.

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

void datavisualizer.DetailedOutputFileManager.AddTreeCharDataMemberCode ( int  iSpecies,
int  iType,
String  sLabel,
int  iCode 
) throws SAXException

Accepts a tree char data member code from the parser to pass on to open data requests.

Parameters:
iSpecies Species of the tree from which this value came.
iType Type of the tree from which this value came.
sLabel The label of the data member.
iCode The data member code.

void datavisualizer.DetailedOutputFileManager.AddGridCharDataMemberCode ( String  sGridName,
String  sLabel,
int  iCode 
) throws SAXException

Accepts a grid char data member code from the parser to pass on to open data requests.

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

void datavisualizer.DetailedOutputFileManager.AddGridPackageCharDataMemberCode ( String  sGridName,
String  sLabel,
int  iCode 
) throws SAXException

Accepts a grid package char data member code from the parser to pass on to open data requests.

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

void datavisualizer.DetailedOutputFileManager.AddTreeBoolDataMemberCode ( int  iSpecies,
int  iType,
String  sLabel,
int  iCode 
) throws SAXException

Accepts a tree bool data member code from the parser to pass on to open data requests.

Parameters:
iSpecies Species of the tree from which this value came.
iType Type of the tree from which this value came.
sLabel The label of the data member.
iCode The data member code.

void datavisualizer.DetailedOutputFileManager.AddGridBoolDataMemberCode ( String  sGridName,
String  sLabel,
int  iCode 
) throws SAXException

Accepts a grid bool data member code from the parser to pass on to open data requests.

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

void datavisualizer.DetailedOutputFileManager.AddGridPackageBoolDataMemberCode ( String  sGridName,
String  sLabel,
int  iCode 
) throws SAXException

Accepts a grid package bool data member code from the parser to pass on to open data requests.

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

void datavisualizer.DetailedOutputFileManager.EndPackage (  )  throws SAXException

Notifies all open data requests that a new package has ended.

void datavisualizer.DetailedOutputFileManager.EndTree (  )  throws SAXException

Notifies all open data requests that a tree record has ended.

int datavisualizer.DetailedOutputFileManager.GetNumberTreeSettings (  ) 

Get the total number of detailed tree settings.

Returns:
the total number of detailed tree settings.

DetailedTreeSettings datavisualizer.DetailedOutputFileManager.GetTreeSetting ( int  i  ) 

Access a detailed tree output settings record.

Parameters:
i Index of the desired record.
Returns:
The record at position i.

float datavisualizer.DetailedOutputFileManager.GetGridXCellLength ( String  sGridName  ) 

Gets the length of X cells for a grid.

Parameters:
sGridName Grid for which to get the X cell length.
Returns:
The X cell length, in m, or 0 if the grid is not recognized.

float datavisualizer.DetailedOutputFileManager.GetGridYCellLength ( String  sGridName  ) 

Gets the length of Y cells for a grid.

Parameters:
sGridName Grid for which to get the Y cell length.
Returns:
The Y cell length, in m, or 0 if the grid is not recognized.

void datavisualizer.DetailedOutputFileManager.CleanUp (  ) 

Deletes all files from the tarball in the temp folder.

Reimplemented from datavisualizer.DataFileManager.

void datavisualizer.DetailedOutputFileManager.AddSubplotCell ( int  iX,
int  iY 
)

Adds one of the cells of this subplot.

This adds the area of the cell to the total, taking into account odd-sized end cells.

Parameters:
iX X cell
iY Y cell


Member Data Documentation

The collection of all data requests currently open.

Vector<String> datavisualizer.DetailedOutputFileManager.mp_sSpeciesNames = new Vector<String>(0) [private]

Species names - the order determines the species codes.

Collection of DetailedTreeSettings objects.

Collection of DetailedGridSettings objects.

Whether each histogram option is float (true) or int (false).

Histogram names - so we can figure out which value in mp_bHistogramIsFloat value to use.

Dead reason codes for each tree data member.

Display string of filename - should have the last 20 chars.

File parser.

Root directory to put temp files.

Where we actually extract to.

Root file name of all detailed output files.

Area of plot (or subplot) in hectares.

Plot X length.

Plot Y length.

X length of subplot cells, in m, if this is a subplot.

Y length of subplot cells, in m, if this is a subplot.

Number of years per timestep.

Number of actual timesteps of data.

Number of timestes from the par file.

Number of tree types.

When updating charts, this is the file parsed.


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

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