sortie.gui.MainWindowStateSetter Class Reference

The purpose of this class is to control the states of the main window - all the enabling and disabling, etc. More...

Static Public Member Functions
static void	goToState (int iState, MainWindow oWindow)
	Transfer the GUI from one state to another. More...

Static Public Attributes
static final int	NO_PAR_FILE = 0
	State: no parameter file has been loaded. More...
static final int	PAR_FILE_LOADED = 1
	State: parameter file has been successfully loaded. More...
static final int	RUNNING = 2
	State: Model is running. More...
static final int	PAUSED = 3
	State: Model has been paused. More...

Static Private Member Functions
static void	goToNoParFileState (MainWindow oWindow)
	Transition to the NO_PAR_FILE state. More...
static void	goToPausedState (MainWindow oWindow)
	Transition to the PAUSED state. More...
static void	goToParFileLoadedState (MainWindow oWindow)
	Transition to the PAR_FILE_LOADED state. More...
static void	goToRunningState (MainWindow oWindow)
	Transition to the RUNNING state. More...

Detailed Description

The purpose of this class is to control the states of the main window - all the enabling and disabling, etc.

The states are as follows:

• NO_PAR_FILE - there is no parameter file loaded. The next step for the user is to create or load one.
• PAR_FILE_LOADED - there is a parameter file successfully defined. The user can go on to run the model at this point.
• RUNNING - the model is in the process of running.

Copyright: Copyright (c) Charles D. Canham 2003

Company: Cary Institute of Ecosystem Studies

Author

Lora E. Murphy

Version

1.0

Edit history:
---------------—
April 28, 2004: Submitted in beta version (LEM)
November 17, 2004: Added the run controls buttons (LEM)
September 29, 2006: Added the harvest interface menu controls (LEM)
February 29, 2008: Added new tree setup window controls (LEM)

Member Function Documentation

goToNoParFileState()

static void sortie.gui.MainWindowStateSetter.goToNoParFileState ( MainWindow  oWindow )

staticprivate

Transition to the NO_PAR_FILE state.

Parameters

oWindow

Main application window.

goToParFileLoadedState()

static void sortie.gui.MainWindowStateSetter.goToParFileLoadedState ( MainWindow  oWindow )

staticprivate

Transition to the PAR_FILE_LOADED state.

Parameters

oWindow

Main application window.

goToPausedState()

static void sortie.gui.MainWindowStateSetter.goToPausedState ( MainWindow  oWindow )

staticprivate

Transition to the PAUSED state.

Parameters

oWindow

Main application window.

goToRunningState()

static void sortie.gui.MainWindowStateSetter.goToRunningState ( MainWindow  oWindow )

staticprivate

Transition to the RUNNING state.

Parameters

oWindow

Main application window.

goToState()

static void sortie.gui.MainWindowStateSetter.goToState ( int  iState, MainWindow  oWindow  )

static

Transfer the GUI from one state to another.

Parameters

iState	The state to which to transfer.
oWindow	Main application window.

Member Data Documentation

NO_PAR_FILE

final int sortie.gui.MainWindowStateSetter.NO_PAR_FILE = 0

static

State: no parameter file has been loaded.

PAR_FILE_LOADED

final int sortie.gui.MainWindowStateSetter.PAR_FILE_LOADED = 1

static

State: parameter file has been successfully loaded.

PAUSED

final int sortie.gui.MainWindowStateSetter.PAUSED = 3

static

State: Model has been paused.

RUNNING

final int sortie.gui.MainWindowStateSetter.RUNNING = 2

static

State: Model is running.

---

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

• MainWindowStateSetter.java