datavisualizer::DetailedOutputLegend Class Reference

This extends the legend class and adds some features specific to the viewing of detailed output files - specifically the ability to step through timesteps. More...

Inheritance diagram for datavisualizer::DetailedOutputLegend:

datavisualizer::Legend List of all members.

Public Member Functions

 DetailedOutputLegend (DetailedOutputFileManager oManager, String sTitle, String[] p_sSpeciesNames, int iMaxTimesteps) throws ModelException
 Constructor.
void actionPerformed (ActionEvent e)
 Responds to button presses.
void GoToTimestep (int iTimestep) throws javawrapper. ModelException
 Changes the display to the desired timestep.
int GetNumberOfTimesteps ()
 Gets the number of timesteps contained in this detailed output file.
void SetNumberOfTimesteps (int iNumTimesteps)
 Updates the legend with a new maximum number of timesteps.
int GetCurrentTimestep ()
 Gets the timestep currently being displayed.

Package Functions

DetailedOutputFileManager GetDetailedOutputFileManager ()
 Gets the file manager for this detailed output file.

Detailed Description

This extends the legend class and adds some features specific to the viewing of detailed output files - specifically the ability to step through timesteps.

Copyright: Copyright (c) Charles D. Canham 2003

Company: Institute of Ecosystem Studies

Author:
Lora E. Murphy
Version:
1.0

Edit history:
------------------
April 28, 2004: Submitted in beta version (LEM)
December 8, 2004: Added more run controls (LEM)


Constructor & Destructor Documentation

datavisualizer::DetailedOutputLegend::DetailedOutputLegend ( DetailedOutputFileManager  oManager,
String  sTitle,
String[]  p_sSpeciesNames,
int  iMaxTimesteps 
) throws ModelException [inline]

Constructor.

Parameters:
oManager Parent detailed output file manager.
sTitle Title to display in window.
p_sSpeciesNames List of species names.
iMaxTimesteps Maximum number of timesteps in this detailed output file.
Exceptions:
ModelException If there is a problem drawing the window.

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


Member Function Documentation

void datavisualizer::DetailedOutputLegend::actionPerformed ( ActionEvent  e  )  [inline]

Responds to button presses.

Parameters:
e ActionEvent

void datavisualizer::DetailedOutputLegend::GoToTimestep ( int  iTimestep  )  throws javawrapper. ModelException [inline]

Changes the display to the desired timestep.

If the requested timestep is beyond the boundaries of possible timesteps, nothing happens.

Parameters:
iTimestep int Timestep to display.
Exceptions:
ModelException if there is a problem updating charts.

int datavisualizer::DetailedOutputLegend::GetNumberOfTimesteps (  )  [inline]

Gets the number of timesteps contained in this detailed output file.

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

void datavisualizer::DetailedOutputLegend::SetNumberOfTimesteps ( int  iNumTimesteps  )  [inline]

Updates the legend with a new maximum number of timesteps.

Parameters:
iNumTimesteps int The new maximum number of timesteps.

int datavisualizer::DetailedOutputLegend::GetCurrentTimestep (  )  [inline]

Gets the timestep currently being displayed.

Returns:
int the timestep currently being displayed.

DetailedOutputFileManager datavisualizer::DetailedOutputLegend::GetDetailedOutputFileManager (  )  [inline, package]

Gets the file manager for this detailed output file.

Returns:
DetailedOutputFileManager The file manager for this detailed output file.


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