datavisualizer::ShortOutputFileManager Class Reference

Manages all the data visualization for a single short output file. More...

Inheritance diagram for datavisualizer::ShortOutputFileManager:

datavisualizer::DataFileManager List of all members.

Public Member Functions

void UpdateCurrentRunCharts () throws ModelException
 Updates charts for a current run.
void UpdateCharts () throws ModelException
 Redraws all open chart objects, except tables.
String[] GetTableOptions ()
 Gets table options.
String[] GetHistogramOptions ()
 No histogram options for this type of chart.
String[] GetMapOptions ()
 No map options for this type of chart.
String[] GetLineGraphOptions ()
 Gets the line graph options.
 ShortOutputFileManager (String sFileName) throws ModelException
 Constructor.

Protected Member Functions

JInternalFrame DrawChart (String sGraphName) throws ModelException
 Draws a requested chart.
void UpdateTable (JPanel jTableWindowPanel, int iTimestep, int iSubplot)
 Updates a table window with new data.
DefaultXYDataset AdjustVisibleSpecies (DefaultXYDataset oDataset, Legend oLegend) throws ModelException
 This will take a dataset and make a copy with only series for species which are supposed to be visible.

Classes

class  LineGraphFileWriter
 Takes care of writing out a line graph's data. More...
class  TableFileWriter
 Writes out table data to file. More...
class  TotalUpdater
 Handles it when a "Show Total" checkbox is checked. More...

Detailed Description

Manages all the data visualization for a single short output file.

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)
July 15, 2004: Added subplot support (LEM)
July 27, 2004: Added table (LEM)


Constructor & Destructor Documentation

datavisualizer::ShortOutputFileManager::ShortOutputFileManager ( String  sFileName  )  throws ModelException [inline]

Constructor.

Analyzes the output file for the data it contains.

Parameters:
sFileName Filename to manage.
Exceptions:
ModelException If file cannot be read.

Edit history:
------------------
April 28, 2004: Submitted in beta version (LEM)
June 25, 2004: Added snag support (LEM)
July 15, 2004: Added subplot support (LEM)


Member Function Documentation

JInternalFrame datavisualizer::ShortOutputFileManager::DrawChart ( String  sGraphName  )  throws ModelException [inline, protected, virtual]

Draws a requested chart.

Parameters:
sGraphName Name of the chart to draw.
Returns:
Chart, or NULL if it could not be drawn.
Exceptions:
ModelException if there's a problem drawing the chart.

Edit history:
------------------
April 28, 2004: Submitted in beta version (LEM)
June 25, 2004: Added snag support (LEM)
July 15, 2004: Added subplot support (LEM)
July 27, 2004: Added the table (LEM)

Implements datavisualizer::DataFileManager.

void datavisualizer::ShortOutputFileManager::UpdateTable ( JPanel  jTableWindowPanel,
int  iTimestep,
int  iSubplot 
) [inline, protected]

Updates a table window with new data.

Parameters:
jTableWindowPanel The content pane of the window containing the table to update.
iTimestep The timestep of the data to display.
iSubplot The subplot of the data to display.

void datavisualizer::ShortOutputFileManager::UpdateCurrentRunCharts (  )  throws ModelException [inline, virtual]

Updates charts for a current run.

This reparses and redraws the charts from scratch, since they show the cumulative history of a run.

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

Edit history:
------------------
November 18, 2004: Created (LEM)
December 20, 2006: Added checkbox control for totals (LEM)

Implements datavisualizer::DataFileManager.

void datavisualizer::ShortOutputFileManager::UpdateCharts (  )  throws ModelException [inline, virtual]

Redraws all open chart objects, except tables.

Tables are not affected by any incidence that affects the other charts, such as clicking species on the legend.

Exceptions:
ModelException passing through from other methods.

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

Implements datavisualizer::DataFileManager.

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

Gets table options.

A summary table can be created from this file type.

Returns:
List of table options

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

Implements datavisualizer::DataFileManager.

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

No histogram options for this type of chart.

Returns:
null

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

Implements datavisualizer::DataFileManager.

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

No map options for this type of chart.

Returns:
null.

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

Implements datavisualizer::DataFileManager.

String [] datavisualizer::ShortOutputFileManager::GetLineGraphOptions (  )  [inline, virtual]

Gets the line graph options.

Returns:
List of line graphs.

Edit history:
------------------
April 28, 2004: Submitted in beta version (LEM)]
June 25, 2004: Added snags (LEM)
July 15, 2004: Added subplots (LEM)

Implements datavisualizer::DataFileManager.

DefaultXYDataset datavisualizer::ShortOutputFileManager::AdjustVisibleSpecies ( DefaultXYDataset  oDataset,
Legend  oLegend 
) throws ModelException [inline, protected]

This will take a dataset and make a copy with only series for species which are supposed to be visible.

Parameters:
oDataset The dataset.
oLegend The legend which controls which species are visible.
Returns:
The dataset copy.
Exceptions:
ModelException wrapping another exception.

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


The documentation for this class was generated from the following file:
Generated on Thu May 24 09:34:52 2007 for SORTIE Java Interface by  doxygen 1.5.2