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).
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 historgrams 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 (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.
javawrapper.DetailedTreeSettings CreateNewTreeSettings (String sSpeciesName, int iType) throws ModelException
 Creates a new javawrapper.DetailedTreeSettings object and adds it to the tree settings vector.
javawrapper.DetailedGridSettings CreateNewGridSettings (String sGridName)
 Creates a new javawrapper.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 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 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 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 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)
 Accepts a piece of 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)
 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)
 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)
 Accepts a piece of 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)
 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)
 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)
 Accepts a piece of 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)
 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)
 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)
 Accepts a piece of 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)
 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)
 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)
 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)
 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)
 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)
 Accepts an int data member code from the parser to pass on to open data requests.
void AddGridIntDataMemberCode (String sGridName, String sLabel, int iCode)
 Accepts an int data member code from the parser to pass on to open data requests.
void AddGridPackageIntDataMemberCode (String sGridName, String sLabel, int iCode)
 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)
 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)
 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)
 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)
 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)
 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)
 Accepts a grid package bool data member code from the parser to pass on to open data requests.
void EndPackage ()
 Notifies all open data requests that a new package has ended.
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.

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 mp_oDataRequests
 The collection of all data requests currently open.
Vector mp_sSpeciesNames
 Species names - the order determines the species codes.
Vector mp_oTreeSettings
 Collection of javawrapper.DetailedTreeSettings objects.
Vector mp_oGridSettings
 Collection of javawrapper.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.
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_fXPlotLength
 Plot X length.
float m_fYPlotLength
 Plot Y length.
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)


Constructor & Destructor Documentation

datavisualizer::DetailedOutputFileManager::DetailedOutputFileManager ( String  sTarball  )  throws ModelException [inline]

Constructor.

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

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


Member Function Documentation

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

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::AddGridBoolDataMemberCode ( String  sGridName,
String  sLabel,
int  iCode 
) [inline]

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::AddGridCharData ( String  sGridName,
int  iX,
int  iY,
int  iCode,
String  sVal 
) [inline]

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::AddGridCharDataMemberCode ( String  sGridName,
String  sLabel,
int  iCode 
) [inline]

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::AddGridFloatData ( String  sGridName,
int  iX,
int  iY,
int  iCode,
float  fVal 
) [inline]

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.

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

void datavisualizer::DetailedOutputFileManager::AddGridFloatDataMemberCode ( String  sGridName,
String  sLabel,
int  iCode 
) [inline]

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::AddGridIntData ( String  sGridName,
int  iX,
int  iY,
int  iCode,
int  iVal 
) [inline]

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::AddGridIntDataMemberCode ( String  sGridName,
String  sLabel,
int  iCode 
) [inline]

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::AddGridPackageBoolData ( String  sGridName,
int  iX,
int  iY,
int  iCode,
boolean  bVal 
) [inline]

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::AddGridPackageBoolDataMemberCode ( String  sGridName,
String  sLabel,
int  iCode 
) [inline]

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::AddGridPackageCharData ( String  sGridName,
int  iX,
int  iY,
int  iCode,
String  sVal 
) [inline]

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::AddGridPackageCharDataMemberCode ( String  sGridName,
String  sLabel,
int  iCode 
) [inline]

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::AddGridPackageFloatData ( String  sGridName,
int  iX,
int  iY,
int  iCode,
float  fVal 
) [inline]

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::AddGridPackageFloatDataMemberCode ( String  sGridName,
String  sLabel,
int  iCode 
) [inline]

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::AddGridPackageIntData ( String  sGridName,
int  iX,
int  iY,
int  iCode,
int  iVal 
) [inline]

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::AddGridPackageIntDataMemberCode ( String  sGridName,
String  sLabel,
int  iCode 
) [inline]

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::AddGridXCellLength ( String  sGridName,
float  fLength 
) [inline]

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.

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

void datavisualizer::DetailedOutputFileManager::AddGridYCellLength ( String  sGridName,
float  fLength 
) [inline]

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.

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

void datavisualizer::DetailedOutputFileManager::AddSpeciesName ( String  sName  )  [inline]

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.

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

void datavisualizer::DetailedOutputFileManager::AddTreeBoolData ( int  iSpecies,
int  iType,
int  iCode,
boolean  bVal 
) [inline]

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.

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

void datavisualizer::DetailedOutputFileManager::AddTreeBoolDataMemberCode ( int  iSpecies,
int  iType,
String  sLabel,
int  iCode 
) [inline]

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.

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

void datavisualizer::DetailedOutputFileManager::AddTreeCharData ( int  iSpecies,
int  iType,
int  iCode,
String  sVal 
) [inline]

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.

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

void datavisualizer::DetailedOutputFileManager::AddTreeCharDataMemberCode ( int  iSpecies,
int  iType,
String  sLabel,
int  iCode 
) [inline]

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.

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

void datavisualizer::DetailedOutputFileManager::AddTreeFloatData ( int  iSpecies,
int  iType,
int  iCode,
float  fVal 
) [inline]

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.

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

void datavisualizer::DetailedOutputFileManager::AddTreeFloatDataMemberCode ( int  iSpecies,
int  iType,
String  sLabel,
int  iCode 
) [inline]

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.

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

void datavisualizer::DetailedOutputFileManager::AddTreeIntData ( int  iSpecies,
int  iType,
int  iCode,
int  iVal 
) [inline]

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.

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

void datavisualizer::DetailedOutputFileManager::AddTreeIntDataMemberCode ( int  iSpecies,
int  iType,
String  sLabel,
int  iCode 
) [inline]

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.

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

void datavisualizer::DetailedOutputFileManager::CleanUp (  )  [inline]

Deletes all files from the tarball in the temp folder.


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

Reimplemented from datavisualizer::DataFileManager.

void datavisualizer::DetailedOutputFileManager::CountTimesteps (  )  throws ModelException [inline, 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

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

javawrapper.DetailedGridSettings datavisualizer::DetailedOutputFileManager::CreateNewGridSettings ( String  sGridName  )  [inline]

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

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

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

javawrapper.DetailedTreeSettings datavisualizer::DetailedOutputFileManager::CreateNewTreeSettings ( String  sSpeciesName,
int  iType 
) throws ModelException [inline]

Creates a new javawrapper.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.

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

JInternalFrame datavisualizer::DetailedOutputFileManager::DrawChart ( String  sGraphName  )  throws ModelException [inline, 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.

Edit history:
------------------
April 28, 2004: Submitted in beta version (LEM)
June 29, 2004: Added disturbance results grid (LEM)
March 29, 2005: Added grid histograms (LEM)
November 9, 2006: Added partitioned biomass table (LEM)

Implements datavisualizer::DataFileManager.

float datavisualizer::DetailedOutputFileManager::GetGridXCellLength ( String  sGridName  )  [inline]

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.

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

float datavisualizer::DetailedOutputFileManager::GetGridYCellLength ( String  sGridName  )  [inline]

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.

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

String [] datavisualizer::DetailedOutputFileManager::GetHistogramOptions (  )  [inline, virtual]

Gets the historgrams that can be drawn for this file.

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

Edit history:
------------------
April 28, 2004: Submitted in beta version (LEM)
March 29, 2005: Added grid histograms (LEM)

Implements datavisualizer::DataFileManager.

String [] datavisualizer::DetailedOutputFileManager::GetLineGraphOptions (  )  [inline, 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.

Edit history:
------------------
April 28, 2004: Submitted in beta version (LEM)
November 15, 2004: Added line graph choices (LEM)
March 9, 2005: Added volume line graphs (LEM)

Implements datavisualizer::DataFileManager.

String [] datavisualizer::DetailedOutputFileManager::GetMapOptions (  )  [inline, virtual]

Gets the maps that can be drawn for this file.

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

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

Implements datavisualizer::DataFileManager.

int datavisualizer::DetailedOutputFileManager::GetNumberOfActualTimesteps (  )  [inline]

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.

int datavisualizer::DetailedOutputFileManager::GetNumberOfSpecies (  )  [inline]

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

Returns:
The number of species.

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

int datavisualizer::DetailedOutputFileManager::GetNumberOfTypes (  )  [inline]

Gets the number of tree types.

Returns:
The number of types.

float datavisualizer::DetailedOutputFileManager::GetNumberOfYearsPerTimestep (  )  [inline]

Gets the number of years per timestep.

Returns:
Number of years per timestep.

Edit history:
------------------
November 2, 2004: Created (LEM)

int datavisualizer::DetailedOutputFileManager::GetSpeciesCodeFromName ( String  sName  )  throws ModelException [inline]

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.

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

String datavisualizer::DetailedOutputFileManager::GetSpeciesNameFromCode ( int  iIndex  )  throws ModelException [inline]

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.

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

String [] datavisualizer::DetailedOutputFileManager::GetTableOptions (  )  [inline, virtual]

Gets the tables that can be drawn for this file.

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

Edit history:
------------------
April 28, 2004: Submitted in beta version (LEM)
June 29, 2004: Added disturbance table support (LEM)
October 29, 2004: Added stand and stock tables (LEM)
November 9, 2006: Added partitioned biomass table (LEM)

Implements datavisualizer::DataFileManager.

float datavisualizer::DetailedOutputFileManager::GetXPlotLength (  )  [inline]

Gets the plot X length.

Returns:
Plot X length, in meters.

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

float datavisualizer::DetailedOutputFileManager::GetYPlotLength (  )  [inline]

Gets the plot Y length.

Returns:
Plot Y length, in meters.

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

void datavisualizer::DetailedOutputFileManager::ParseParamFile (  )  throws ModelException [inline, 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.

void datavisualizer::DetailedOutputFileManager::ReadFile ( int  iTimestep  )  throws ModelException [inline]

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.

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

void datavisualizer::DetailedOutputFileManager::SetNumberOfYearsPerTimestep ( float  f  )  [inline]

Sets the number of years per timestep.

Parameters:
f Number of years per timestep.

Edit history:
------------------
November 2, 2004: Created (LEM)

void datavisualizer::DetailedOutputFileManager::SetParFileTimesteps ( int  i  )  [inline]

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

Parameters:
i Number of timesteps.

void datavisualizer::DetailedOutputFileManager::SetXPlotLength ( float  f  )  [inline]

Sets the plot X length.

Parameters:
f Plot X length, in meters.

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

void datavisualizer::DetailedOutputFileManager::SetYPlotLength ( float  f  )  [inline]

Sets the plot Y length.

Parameters:
f Plot Y length, in meters.

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

void datavisualizer::DetailedOutputFileManager::UpdateCharts (  )  throws ModelException [inline, 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.

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

Implements datavisualizer::DataFileManager.

void datavisualizer::DetailedOutputFileManager::UpdateCurrentRunCharts (  )  throws ModelException [inline, 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.

Edit history:
------------------
November 18, 2004: Created (LEM)

Implements datavisualizer::DataFileManager.

boolean datavisualizer::DetailedOutputFileManager::WantAnyGridBools (  )  [inline]

Whether or not any open data requests want 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)

boolean datavisualizer::DetailedOutputFileManager::WantAnyGridChars (  )  [inline]

Whether or not any open data requests want 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::DetailedOutputFileManager::WantAnyGridFloats (  )  [inline]

Whether or not any open data requests want 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)

boolean datavisualizer::DetailedOutputFileManager::WantAnyGridInts (  )  [inline]

Whether or not any open data requests want 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)

boolean datavisualizer::DetailedOutputFileManager::WantAnyGridPackageBools (  )  [inline]

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.

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

boolean datavisualizer::DetailedOutputFileManager::WantAnyGridPackageChars (  )  [inline]

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.

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

boolean datavisualizer::DetailedOutputFileManager::WantAnyGridPackageFloats (  )  [inline]

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.

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

boolean datavisualizer::DetailedOutputFileManager::WantAnyGridPackageInts (  )  [inline]

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.

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

boolean datavisualizer::DetailedOutputFileManager::WantAnyTreeBools (  )  [inline]

Whether or not any open data requests want 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::DetailedOutputFileManager::WantAnyTreeChars (  )  [inline]

Whether or not any open data requests want 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::DetailedOutputFileManager::WantAnyTreeFloats (  )  [inline]

Whether or not any open data requests want 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)

boolean datavisualizer::DetailedOutputFileManager::WantAnyTreeInts (  )  [inline]

Whether or not any open data requests want 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)


The documentation for this class was generated from the following file:
Generated on Wed Nov 29 08:45:01 2006 for SORTIE Java Interface by  doxygen 1.4.7